[Bug 1027] mempool cache size parameter is misleading

[Bug 1027] mempool cache size parameter is misleading

[bugzilla]

https://bugs.dpdk.org/show_bug.cgi?id=1027

            Bug ID: 1027
           Summary: mempool cache size parameter is misleading
           Product: DPDK
           Version: unspecified
          Hardware: All
                OS: All
            Status: UNCONFIRMED
          Severity: normal
          Priority: Normal
         Component: doc
          Assignee: dev@dpdk.org
          Reporter: mb@smartsharesystems.com
  Target Milestone: ---

A flush threshold for the mempool cache was introduced in DPDK version
1.3. With this modification, the actual size of the mempool cache was
multiplied by 1.5, so e.g. a specified size of 512 allows the mempool cache to
hold up to 1.5 * 512 = 768 objects.

None of the documentation was updated to reflect this change.

E.g. the Programmer's Guide says:

"The maximum size of the cache is static and is defined at compilation time
(RTE_MEMPOOL_CACHE_MAX_SIZE)." But in reality, the maximum size of the cache is
RTE_MEMPOOL_CACHE_MAX_SIZE * 1.5.

Also, the "size" field of the rte_mempool_cache structure and the "cache_size"
parameter of the rte_mempool_create() function don't mention that the value is
1/1.5 of the actual size.

If we don't want to fix the code, then the documentation needs to be fixed.

-- 
You are receiving this mail because:
You are the assignee for the bug.