Commit 678a1c03 authored by Xin Liu's avatar Xin Liu Committed by Andrii Nakryiko
Browse files

libbpf: Added the description of some API functions 



Currently, many API functions are not described in the document.
Add add API description of the following four API functions:
  - libbpf_set_print;
  - bpf_object__open;
  - bpf_object__load;
  - bpf_object__close.

Signed-off-by: default avatarXin Liu <liuxin350@huawei.com>
Signed-off-by: default avatarAndrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20221224112058.12038-1-liuxin350@huawei.com
parent ac807e68

tools/lib/bpf/libbpf.h

+27 −2
Original line number Diff line number Diff line
@@ -96,6 +96,12 @@ enum libbpf_print_level { 
typedef int (*libbpf_print_fn_t)(enum libbpf_print_level level,

				 const char *, va_list ap);



/**

 * @brief **libbpf_set_print()** sets user-provided log callback function to

 * be used for libbpf warnings and informational messages.

 * @param fn The log print function. If NULL, libbpf won't print anything.

 * @return Pointer to old print function.

 */

LIBBPF_API libbpf_print_fn_t libbpf_set_print(libbpf_print_fn_t fn);



/* Hide internal to user */
@@ -174,6 +180,14 @@ struct bpf_object_open_opts { 
};

#define bpf_object_open_opts__last_field kernel_log_level



/**

 * @brief **bpf_object__open()** creates a bpf_object by opening

 * the BPF ELF object file pointed to by the passed path and loading it

 * into memory.

 * @param path BPF object file path.

 * @return pointer to the new bpf_object; or NULL is returned on error,

 * error code is stored in errno

 */

LIBBPF_API struct bpf_object *bpf_object__open(const char *path);



/**
@@ -203,10 +217,21 @@ LIBBPF_API struct bpf_object * 
bpf_object__open_mem(const void *obj_buf, size_t obj_buf_sz,

		     const struct bpf_object_open_opts *opts);



/* Load/unload object into/from kernel */

/**

 * @brief **bpf_object__load()** loads BPF object into kernel.

 * @param obj Pointer to a valid BPF object instance returned by

 * **bpf_object__open*()** APIs

 * @return 0, on success; negative error code, otherwise, error code is

 * stored in errno

 */

LIBBPF_API int bpf_object__load(struct bpf_object *obj);



LIBBPF_API void bpf_object__close(struct bpf_object *object);

/**

 * @brief **bpf_object__close()** closes a BPF object and releases all

 * resources.

 * @param obj Pointer to a valid BPF object

 */

LIBBPF_API void bpf_object__close(struct bpf_object *obj);



/* pin_maps and unpin_maps can both be called with a NULL path, in which case

 * they will use the pin_path attribute of each map (and ignore all maps that