upipe/uprobe_ubuf_mem.h header reference

probe catching provide_request events asking for a ubuf manager More

Header inclusion  

Members  

Type  

Functions  

  • struct uprobe * uprobe_ubuf_mem_alloc(struct uprobe *next, struct umem_mgr *umem_mgr, uint16_t ubuf_pool_depth, uint16_t shared_pool_depth)
  • void uprobe_ubuf_mem_clean(struct uprobe_ubuf_mem *uprobe_ubuf_mem)
  • struct uprobe * uprobe_ubuf_mem_init(struct uprobe_ubuf_mem *uprobe_ubuf_mem, struct uprobe *next, struct umem_mgr *umem_mgr, uint16_t ubuf_pool_depth, uint16_t shared_pool_depth)
  • void uprobe_ubuf_mem_set(struct uprobe *uprobe, struct umem_mgr *umem_mgr)

Description  

probe catching provide_request events asking for a ubuf manager

Members detail  

#define _UPIPE_UPROBE_UBUF_MEM_H_  

This macro is declared in upipe/uprobe_ubuf_mem.h source file, line 31.

struct uprobe_ubuf_mem  

This struct is declared in upipe/uprobe_ubuf_mem.h source file, line 46.

This struct is a super-set of the uprobe structure with additional local members.

FieldDescription
struct umem_mgr * umem_mgr;pointer to umem_mgr to use to allocate ubuf manager
uint16_t ubuf_pool_depth;depth of the ubuf pool
uint16_t shared_pool_depth;depth of the shared object pool
struct uprobe uprobe;structure exported to modules

struct uprobe * uprobe_ubuf_mem_alloc(struct uprobe *next, struct umem_mgr *umem_mgr, uint16_t ubuf_pool_depth, uint16_t shared_pool_depth)  

This function is declared in upipe/uprobe_ubuf_mem.h source file, line 92.

This function allocates a new uprobe_ubuf_mgr structure.

Parameter list:

  • next: next probe to test if this one doesn't catch the event
  • umem_mgr: memory allocator to use for buffers
  • ubuf_pool_depth: maximum number of ubuf structures in the pool
  • shared_pool_depth: maximum number of shared structures in the pool

The return value is pointer to uprobe, or NULL in case of error

void uprobe_ubuf_mem_clean(struct uprobe_ubuf_mem *uprobe_ubuf_mem)  

This function is declared in upipe/uprobe_ubuf_mem.h source file, line 79.

This function cleans a uprobe_ubuf_mem structure.

Parameter list:

  • uprobe_ubuf_mem: structure to clean

struct uprobe * uprobe_ubuf_mem_init(struct uprobe_ubuf_mem *uprobe_ubuf_mem, struct uprobe *next, struct umem_mgr *umem_mgr, uint16_t ubuf_pool_depth, uint16_t shared_pool_depth)  

This function is declared in upipe/uprobe_ubuf_mem.h source file, line 73.

This function initializes an already allocated uprobe_ubuf_mem structure.

Parameter list:

  • uprobe_ubuf_mem: pointer to the already allocated structure
  • next: next probe to test if this one doesn't catch the event
  • umem_mgr: memory allocator to use for buffers
  • ubuf_pool_depth: maximum number of ubuf structures in the pool
  • shared_pool_depth: maximum number of shared structures in the pool

The return value is pointer to uprobe, or NULL in case of error

void uprobe_ubuf_mem_set(struct uprobe *uprobe, struct umem_mgr *umem_mgr)  

This function is declared in upipe/uprobe_ubuf_mem.h source file, line 99.

This function changes the umem_mgr used by this probe.

Parameter list:

  • uprobe: pointer to probe
  • umem_mgr: new umem manager to use

struct uprobe_ubuf_mem * uprobe_ubuf_mem_from_uprobe(struct uprobe *uprobe)  

This function is for internal use only.

This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 19 in upipe/uprobe_ubuf_mem.h source file, line 58.

This function returns the private uprobe_ubuf_mem structure.

Parameter list:

  • uprobe: public description structure of the probe

The return value is pointer to the private uprobe_ubuf_mem structure

struct uprobe * uprobe_ubuf_mem_to_uprobe(struct uprobe_ubuf_mem *s)  

This function is for internal use only.

This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 9 in upipe/uprobe_ubuf_mem.h source file, line 58.

This function returns the public uprobe structure.

Parameter list:

  • uprobe_ubuf_mem: pointer to the private uprobe_ubuf_mem structure

The return value is pointer to the public uprobe structure

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:19 2018 using MkDoc