--- name: "rte_member_parameters" section: "3" platform: "linux" package: "dpdk-doc" version: "24.11.4-0+deb13u1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/rte_member_parameters" --- # rte\_member\_parameters(3) ## NAME rte\_member\_parameters ## SYNOPSIS `#include ` ### Data Fields const char \* **name**\ enum **rte\_member\_setsum\_type** **type**\ uint8\_t **is\_cache**\ uint32\_t **num\_keys**\ uint32\_t **key\_len**\ uint32\_t **num\_set**\ float **false\_positive\_rate**\ uint32\_t **prim\_hash\_seed**\ uint32\_t **sec\_hash\_seed**\ float **error\_rate**\ float **sample\_rate**\ uint32\_t **top\_k**\ uint32\_t **extra\_flag**\ int **socket\_id**\ ## Detailed Description Parameters used when create the set summary table. Currently user can specify two types of setsummary: HT based and vBF. For HT based, user can specify cache or non-cache mode. Here is a table to describe some differences Definition at line **195** of file **rte\_member.h**. ## Field Documentation ### const char\* name Name of the hash. Definition at line **196** of file **rte\_member.h**. ### enum rte\_member\_setsum\_type type User to specify the type of the setsummary from one of rte\_member\_setsum\_type. HT based setsummary is implemented like a hash table. User should use this type when there are many sets. vBF setsummary is a vector of bloom filters. It is used when number of sets is not big (less than 32 for current implementation). Definition at line **208** of file **rte\_member.h**. ### uint8\_t is\_cache is\_cache is only used for HT based setsummary. If it is HT based setsummary, user to specify the subtype or mode of the setsummary. It could be cache, or non-cache mode. Set is\_cache to be 1 if to use as cache mode. For cache mode, keys can be evicted out of the HT setsummary. Keys with the same signature and map to the same bucket will overwrite each other in the setsummary table. This mode is useful for the case that the set-summary only needs to keep record of the recently inserted keys. Both false-negative and false-positive could happen. For non-cache mode, keys cannot be evicted out of the cache. So for this mode the setsummary will become full eventually. Keys with the same signature but map to the same bucket will still occupy multiple entries. This mode does not give false-negative result. Definition at line **229** of file **rte\_member.h**. ### uint32\_t num\_keys For HT setsummary, num\_keys equals to the number of entries of the table. When the number of keys inserted in the HT setsummary approaches this number, eviction could happen. For cache mode, keys could be evicted out of the table. For non-cache mode, keys will be evicted to other buckets like cuckoo hash. The table will also likely to become full before the number of inserted keys equal to the total number of entries. For vBF, num\_keys equal to the expected number of keys that will be inserted into the vBF. The implementation assumes the keys are evenly distributed to each BF in vBF. This is used to calculate the number of bits we need for each BF. User does not specify the size of each BF directly because the optimal size depends on the num\_keys and false positive rate. Definition at line **247** of file **rte\_member.h**. ### uint32\_t key\_len The length of key is used for hash calculation. Since key is not stored in set-summary, large key does not require more memory space. Definition at line **253** of file **rte\_member.h**. ### uint32\_t num\_set num\_set is only used for vBF, but not used for HT setsummary. num\_set is equal to the number of BFs in vBF. For current implementation, it only supports 1,2,4,8,16,32 BFs in one vBF set summary. If other number of sets are needed, for example 5, the user should allocate the minimum available value that larger than 5, which is 8. Definition at line **264** of file **rte\_member.h**. ### float false\_positive\_rate false\_positive\_rate is only used for vBF, but not used for HT setsummary. For vBF, false\_positive\_rate is the user-defined false positive rate given expected number of inserted keys (num\_keys). It is used to calculate the total number of bits for each BF, and the number of hash values used during lookup and insertion. For details please refer to vBF implementation and membership library documentation. For HT, This parameter is not directly set by users. HT setsummary's false positive rate is in the order of: false\_pos = (1/bucket\_count)\*(1/2^16), since we use 16-bit signature. This is because two keys needs to map to same bucket and same signature to have a collision (false positive). bucket\_count is equal to number of entries (num\_keys) divided by entry count per bucket (RTE\_MEMBER\_BUCKET\_ENTRIES). Thus, the false\_positive\_rate is not directly set by users for HT mode. Definition at line **285** of file **rte\_member.h**. ### uint32\_t prim\_hash\_seed We use two seeds to calculate two independent hashes for each key. For HT type, one hash is used as signature, and the other is used for bucket location. For vBF type, these two hashes and their combinations are used as hash locations to index the bit array. For Sketch type, these seeds are not used. Definition at line **296** of file **rte\_member.h**. ### uint32\_t sec\_hash\_seed The secondary seed should be a different value from the primary seed. Definition at line **301** of file **rte\_member.h**. ### float error\_rate For count(min) sketch data structure, error rate defines the accuracy required by the user. Higher accuracy leads to more memory usage, but the flow size is estimated more accurately. Definition at line **308** of file **rte\_member.h**. ### float sample\_rate Sampling rate means the internal sample rate of the rows of the count min sketches. Lower sampling rate can reduce CPU overhead, but the data structure will require more time to converge statistically. Definition at line **315** of file **rte\_member.h**. ### uint32\_t top\_k How many top heavy hitter to be reported. The library will internally keep the keys of heavy hitters for final report. Definition at line **321** of file **rte\_member.h**. ### uint32\_t extra\_flag Extra flags that may passed in by user Definition at line **326** of file **rte\_member.h**. ### int socket\_id NUMA Socket ID for memory. Definition at line **328** of file **rte\_member.h**. ## Author Generated automatically by Doxygen for DPDK from the source code.