upipe/uprobe_prefix.h header reference

probe prefixing all print events with a given name More

Header inclusion  

Members  

Type  

Functions  

  • struct uprobe * uprobe_pfx_alloc(struct uprobe *next, enum uprobe_log_level min_level, const char *name)
  • struct uprobe * uprobe_pfx_alloc_va(struct uprobe *next, enum uprobe_log_level min_level, const char *format, ...)
  • void uprobe_pfx_clean(struct uprobe_pfx *uprobe_pfx)
  • const char * uprobe_pfx_get_name(struct uprobe *uprobe)
  • struct uprobe * uprobe_pfx_init(struct uprobe_pfx *uprobe_pfx, struct uprobe *next, enum uprobe_log_level min_level, const char *name)

Description  

probe prefixing all print events with a given name

Members detail  

#define _UPIPE_UPROBE_PREFIX_H_  

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

struct uprobe_pfx  

This struct is declared in upipe/uprobe_prefix.h source file, line 44.

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

FieldDescription
char * name;name of the pipe (informative)
enum uprobe_log_level min_level;minimum level of messages to pass-through
struct uprobe uprobe;structure exported to modules

struct uprobe * uprobe_pfx_alloc(struct uprobe *next, enum uprobe_log_level min_level, const char *name)  

This function is declared in upipe/uprobe_prefix.h source file, line 91.

This function allocates a new uprobe pfx structure.

Parameter list:

  • next: next probe to test if this one doesn't catch the event
  • min_level: minimum level of passed-through messages
  • name: name of the pipe (informative)

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

struct uprobe * uprobe_pfx_alloc_va(struct uprobe *next, enum uprobe_log_level min_level, const char *format, ...)  

This function is declared in upipe/uprobe_prefix.h source file, line 105.

This function allocates a new uprobe pfx structure, with printf-style name generation.

Parameter list:

  • next: next probe to test if this one doesn't catch the event
  • min_level: minimum level of passed-through messages
  • format: printf-style format for the name, followed by optional arguments

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

void uprobe_pfx_clean(struct uprobe_pfx *uprobe_pfx)  

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

This function cleans a uprobe pfx structure.

Parameter list:

  • uprobe_pfx: structure to clean

const char * uprobe_pfx_get_name(struct uprobe *uprobe)  

This function is declared in upipe/uprobe_prefix.h source file, line 80.

This function returns the name of the pipe.

Parameter list:

  • uprobe: pointer to probe

The return value is name of the pipe (informative)

struct uprobe * uprobe_pfx_init(struct uprobe_pfx *uprobe_pfx, struct uprobe *next, enum uprobe_log_level min_level, const char *name)  

This function is declared in upipe/uprobe_prefix.h source file, line 67.

This function initializes an already allocated uprobe pfx structure.

Parameter list:

  • uprobe_pfx: pointer to the already allocated structure
  • next: next probe to test if this one doesn't catch the event
  • min_level: minimum level of passed-through messages
  • name: name of the pipe (informative)

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

struct uprobe_pfx * uprobe_pfx_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_prefix.h source file, line 54.

This function returns the private uprobe_pfx structure.

Parameter list:

  • uprobe: public description structure of the probe

The return value is pointer to the private uprobe_pfx structure

struct uprobe * uprobe_pfx_to_uprobe(struct uprobe_pfx *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_prefix.h source file, line 54.

This function returns the public uprobe structure.

Parameter list:

  • uprobe_pfx: pointer to the private uprobe_pfx 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