Add doxygen documentation for libbpf apis (#491)
* Add doxygen documentation for libbpf apis Eventually this should be upstreamed, but as a workaround the docs are put into our repo in the meantime. As discussed at https://stackoverflow.com/questions/23798053/how-to-document-errno-value-with-doxygen doxygen does not have a built-in way to document errno values set. It is possible by creating doxygen custom commands, but for now we use the "exception" section as recommended at the bottom of that page. Fixes #490 Signed-off-by: Dave Thaler <dthaler@microsoft.com>
This commit is contained in:
Dave Thaler
GitHub
Родитель
2349de2a46
Коммит
7a921c0ef2
214
include/bpf.h
214
include/bpf.h
|
|
@ -1,6 +1,220 @@
|
|||
// Copyright (c) Microsoft Corporation
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
#ifdef __doxygen
|
||||
|
||||
/**
|
||||
* @name Link-related functions
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Detach a link.
|
||||
*
|
||||
* @param[in] link_fd File descriptor of link to detach.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EBADF The file descriptor was not found.
|
||||
*
|
||||
* @sa bpf_link__destroy
|
||||
* @sa bpf_link__disconnect
|
||||
*/
|
||||
int
|
||||
bpf_link_detach(int link_fd);
|
||||
|
||||
/**
|
||||
* @brief Get a file descriptor referring to a link
|
||||
* with a given ID.
|
||||
*
|
||||
* @param[in] id ID of link to find.
|
||||
*
|
||||
* @returns A new file descriptor that refers to the link. A negative
|
||||
* value indicates an error occurred and errno was set.
|
||||
*
|
||||
* @exception ENOENT No link with the specified ID was found.
|
||||
*/
|
||||
int
|
||||
bpf_link_get_fd_by_id(__u32 id);
|
||||
|
||||
/**
|
||||
* @brief Look for the next link ID greater than a given ID.
|
||||
*
|
||||
* @param[in] start_id ID to look for an ID after. The start_id need not exist.
|
||||
* @param[out] next_id Pointer to where to write the next ID.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception ENOENT No more IDs found.
|
||||
*/
|
||||
int
|
||||
bpf_link_get_next_id(__u32 start_id, __u32* next_id);
|
||||
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @name Map-related functions
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Create a new map.
|
||||
*
|
||||
* @param[in] map_type Type of map to create.
|
||||
* @param[in] key_size Size in bytes of keys.
|
||||
* @param[in] value_size Size in bytes of values.
|
||||
* @param[in] max_entries Maximum number of entries in the map.
|
||||
* @param[in] map_flags Flags (currently 0).
|
||||
*
|
||||
* @returns A new file descriptor that refers to the map. A negative
|
||||
* value indicates an error occurred and errno was set.
|
||||
*
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*/
|
||||
int
|
||||
bpf_create_map(enum bpf_map_type map_type, int key_size, int value_size, int max_entries, __u32 map_flags);
|
||||
|
||||
/**
|
||||
* @brief Look up and delete an element by key in a specified map.
|
||||
*
|
||||
* @param[in] fd File descriptor of map to update.
|
||||
* @param[in] key Pointer to key to look up.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception EBADF The file descriptor was not found.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*/
|
||||
int
|
||||
bpf_map_delete_elem(int fd, const void* key);
|
||||
|
||||
/**
|
||||
* @brief Get a file descriptor referring to a map
|
||||
* with a given ID.
|
||||
*
|
||||
* @param[in] id ID of map to find.
|
||||
*
|
||||
* @returns A new file descriptor that refers to the map. A negative
|
||||
* value indicates an error occurred and errno was set.
|
||||
*
|
||||
* @exception ENOENT No map with the specified ID was found.
|
||||
*/
|
||||
int
|
||||
bpf_map_get_fd_by_id(__u32 id);
|
||||
|
||||
/**
|
||||
* @brief Look for the next map ID greater than a given ID.
|
||||
*
|
||||
* @param[in] start_id ID to look for an ID after. The start_id need not exist.
|
||||
* @param[out] next_id Pointer to where to write the next ID.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception ENOENT No more IDs found.
|
||||
*/
|
||||
int
|
||||
bpf_map_get_next_id(__u32 start_id, __u32* next_id);
|
||||
|
||||
/**
|
||||
* @brief Look up an element by key in a map and get the next key.
|
||||
* If the specific key is not found, the first key in the map is
|
||||
* passed back.
|
||||
*
|
||||
* @param[in] fd File descriptor of map.
|
||||
* @param[in] key Pointer to key to look up.
|
||||
* @param[out] next_key Pointer to memory in which to write the
|
||||
* next key.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception EBADF The file descriptor was not found.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*/
|
||||
int
|
||||
bpf_map_get_next_key(int fd, const void* key, void* next_key);
|
||||
|
||||
/**
|
||||
* @brief Look up an element by key in a specified map and
|
||||
* return its value.
|
||||
*
|
||||
* @param[in] fd File descriptor of map.
|
||||
* @param[in] key Pointer to key to look up.
|
||||
* @param[out] value Pointer to memory in which to write the
|
||||
* value.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception EBADF The file descriptor was not found.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*/
|
||||
int
|
||||
bpf_map_lookup_elem(int fd, const void* key, void* value);
|
||||
|
||||
/**
|
||||
* @brief Create or update an element (key/value pair) in a
|
||||
* specified map.
|
||||
*
|
||||
* @param[in] fd File descriptor of map.
|
||||
* @param[in] key Pointer to key.
|
||||
* @param[in] value Pointer to value.
|
||||
* @param[in] flags Flags (currently 0).
|
||||
*
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception EBADF The file descriptor was not found.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*/
|
||||
int
|
||||
bpf_map_update_elem(int fd, const void* key, const void* value, __u64 flags);
|
||||
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @name Program-related functions
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Get a file descriptor referring to a program
|
||||
* with a given ID.
|
||||
*
|
||||
* @param[in] id ID of program to find.
|
||||
*
|
||||
* @returns A new file descriptor that refers to the program. A negative
|
||||
* value indicates an error occurred and errno was set.
|
||||
*
|
||||
* @exception ENOENT No program with the specified ID was found.
|
||||
*/
|
||||
int
|
||||
bpf_prog_get_fd_by_id(__u32 id);
|
||||
|
||||
/**
|
||||
* @brief Look for the next program ID greater than a given ID.
|
||||
*
|
||||
* @param[in] start_id ID to look for an ID after. The start_id need not exist.
|
||||
* @param[out] next_id Pointer to where to write the next ID.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception ENOENT No more IDs found.
|
||||
*/
|
||||
int
|
||||
bpf_prog_get_next_id(__u32 start_id, __u32* next_id);
|
||||
|
||||
/** @} */
|
||||
|
||||
#else
|
||||
#pragma warning(push)
|
||||
#include "../external/libbpf/src/bpf.h"
|
||||
#pragma warning(pop)
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -132,7 +132,7 @@ extern "C"
|
|||
/**
|
||||
* @brief Create an eBPF map with input parameters.
|
||||
*
|
||||
* @param[in] type Map type.
|
||||
* @param[in] map_type Map type.
|
||||
* @param[in] key_size Key size.
|
||||
* @param[in] value_size Value size.
|
||||
* @param[in] max_entries Maximum number of entries in the map.
|
||||
|
|
@ -555,6 +555,9 @@ extern "C"
|
|||
*
|
||||
* @retval EBPF_SUCCESS The operation was successful.
|
||||
* @retval EBPF_INVALID_ARGUMENT Invalid argument was provided.
|
||||
*
|
||||
* @sa bpf_link__destroy
|
||||
* @sa bpf_link_detach
|
||||
*/
|
||||
ebpf_result_t
|
||||
ebpf_link_close(_In_ struct bpf_link* link);
|
||||
|
|
|
|||
561
include/libbpf.h
561
include/libbpf.h
|
|
@ -1,7 +1,568 @@
|
|||
// Copyright (c) Microsoft Corporation
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
#ifdef __doxygen
|
||||
|
||||
/**
|
||||
* @name Link-related functions
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** @brief Clean up a link.
|
||||
*
|
||||
* @details Unless bpf_link__disconnect was called first,
|
||||
* this API detaches the link. Either way, it then closes
|
||||
* the link fd and frees the memory for the link.
|
||||
*
|
||||
* @param[in] link Link to destroy.
|
||||
*
|
||||
* @sa bpf_link_detach
|
||||
* @sa ebpf_link_close
|
||||
*/
|
||||
int
|
||||
bpf_link__destroy(struct bpf_link* link);
|
||||
|
||||
/** @brief Release ownership of a link so that it is
|
||||
* not detached when destroyed.
|
||||
*
|
||||
* @param[in] link Link to disconnect.
|
||||
*
|
||||
* @sa bpf_link__destroy
|
||||
*/
|
||||
void
|
||||
bpf_link__disconnect(struct bpf_link* link);
|
||||
|
||||
/**
|
||||
* @brief Get a file descriptor that refers to a link.
|
||||
*
|
||||
* @param[in] link Link to get a file descriptor for.
|
||||
*
|
||||
* @returns File descriptor that refers to the link.
|
||||
*/
|
||||
int
|
||||
bpf_link__fd(const struct bpf_link* link);
|
||||
|
||||
/**
|
||||
* @brief Pin a link to a specified path.
|
||||
*
|
||||
* @param[in] link Link to pin.
|
||||
* @param[in] path Path to pin the link to.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EBUSY A pin path was previously specified.
|
||||
* @exception EEXIST Something is already pinned to the specified path.
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*
|
||||
* @sa bpf_link__unpin
|
||||
*/
|
||||
int
|
||||
bpf_link__pin(struct bpf_link* link, const char* path);
|
||||
|
||||
/**
|
||||
* @brief Unpin a link.
|
||||
*
|
||||
* @param[in] link Link to unpin.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception ENOENT The link was not pinned.
|
||||
*
|
||||
* @sa bpf_link__pin
|
||||
*/
|
||||
int
|
||||
bpf_link__unpin(struct bpf_link* link);
|
||||
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @name Map-related functions
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Get a file descriptor that refers to a map.
|
||||
*
|
||||
* @param[in] map Map to get a file descriptor for.
|
||||
*
|
||||
* @returns File descriptor that refers to the map.
|
||||
*/
|
||||
int
|
||||
bpf_map__fd(const struct bpf_map* map);
|
||||
|
||||
/**
|
||||
* @brief Determine whether a map is pinned.
|
||||
*
|
||||
* @param[in] map Map to check.
|
||||
*
|
||||
* @retval true The map is pinned.
|
||||
* @retval false The map is not pinned.
|
||||
*
|
||||
* @sa bpf_map__pin
|
||||
* @sa bpf_object__pin
|
||||
* @sa bpf_object__pin_maps
|
||||
*/
|
||||
bool
|
||||
bpf_map__is_pinned(const struct bpf_map* map);
|
||||
|
||||
/**
|
||||
* @brief Get the size of keys in a given map.
|
||||
*
|
||||
* @param[in] map Map to check.
|
||||
*
|
||||
* @returns The size in bytes of keys in the map.
|
||||
*/
|
||||
__u32
|
||||
bpf_map__key_size(const struct bpf_map* map);
|
||||
|
||||
/**
|
||||
* @brief Get the maximum number of entries allowed in a given map.
|
||||
*
|
||||
* @param[in] map Map to check.
|
||||
*
|
||||
* @returns The maximum number of entries allowed.
|
||||
*/
|
||||
__u32
|
||||
bpf_map__max_entries(const struct bpf_map* map);
|
||||
|
||||
/**
|
||||
* @brief Get the next map for a given eBPF object.
|
||||
*
|
||||
* @param[in] map Previous map.
|
||||
* @param[in] obj Object with maps.
|
||||
*
|
||||
* @returns Next map, or NULL if none.
|
||||
*
|
||||
* @sa bpf_map__prev
|
||||
*/
|
||||
struct bpf_map*
|
||||
bpf_map__next(const struct bpf_map* map, const struct bpf_object* obj);
|
||||
|
||||
/**
|
||||
* @brief Pin a map to a specified path.
|
||||
*
|
||||
* @param[in] map Map to pin.
|
||||
* @param[in] path Path to pin the map to.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EBUSY A pin path was previously specified.
|
||||
* @exception EEXIST Something is already pinned to the specified path.
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*
|
||||
* @sa bpf_map_unpin
|
||||
* @sa bpf_object__pin_maps
|
||||
*/
|
||||
int
|
||||
bpf_map__pin(struct bpf_map* map, const char* path);
|
||||
|
||||
/**
|
||||
* @brief Get the previous map for a given eBPF object.
|
||||
*
|
||||
* @param[in] map Next map.
|
||||
* @param[in] obj Object with maps.
|
||||
*
|
||||
* @returns Previous map, or NULL if none.
|
||||
*
|
||||
* @sa bpf_map__next
|
||||
*/
|
||||
struct bpf_map*
|
||||
bpf_map__prev(const struct bpf_map* map, const struct bpf_object* obj);
|
||||
|
||||
/**
|
||||
* @brief Get the type of a map.
|
||||
*
|
||||
* @param[in] map Map to check.
|
||||
*
|
||||
* @returns The map type.
|
||||
*/
|
||||
enum bpf_map_type
|
||||
bpf_map__type(const struct bpf_map* map);
|
||||
|
||||
/**
|
||||
* @brief Unpin a map.
|
||||
*
|
||||
* @param[in] map Map to unpin.
|
||||
* @param[in] path Path from which to unpin the map.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception ENOENT The map was not pinned.
|
||||
*
|
||||
* @sa bpf_map_pin
|
||||
* @sa bpf_object__unpin_maps
|
||||
*/
|
||||
int
|
||||
bpf_map__unpin(struct bpf_map* map, const char* path);
|
||||
|
||||
/**
|
||||
* @brief Get the size of values in a given map.
|
||||
*
|
||||
* @param[in] map Map to check.
|
||||
*
|
||||
* @returns The size in bytes of values in the map.
|
||||
*/
|
||||
__u32
|
||||
bpf_map__value_size(const struct bpf_map* map);
|
||||
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @name File object-related functions
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Close an eBPF object.
|
||||
*
|
||||
* @param[in] object The object to close.
|
||||
*
|
||||
* @sa bpf_prog_load
|
||||
*/
|
||||
void
|
||||
bpf_object__close(struct bpf_object* object);
|
||||
|
||||
/**
|
||||
* @brief Find a map with a given name among maps associated with an eBPF object.
|
||||
*
|
||||
* @param[in] obj The object to check.
|
||||
* @param[in] name The name to look for.
|
||||
*
|
||||
* @returns The map found, or NULL if none.
|
||||
*/
|
||||
struct bpf_map*
|
||||
bpf_object__find_map_by_name(const struct bpf_object* obj, const char* name);
|
||||
|
||||
/**
|
||||
* @brief Find a map with a given name among maps associated with an eBPF object.
|
||||
*
|
||||
* @param[in] obj The object to check.
|
||||
* @param[in] name The name to look for.
|
||||
*
|
||||
* @returns A file descriptor referring to the map found, or a negative value if none.
|
||||
*
|
||||
* @sa bpf_map__fd
|
||||
*/
|
||||
int
|
||||
bpf_object__find_map_fd_by_name(const struct bpf_object* obj, const char* name);
|
||||
|
||||
/**
|
||||
* @brief Find a program with a given name among programs associated with an eBPF object.
|
||||
*
|
||||
* @param[in] obj The object to check.
|
||||
* @param[in] name The name to look for.
|
||||
*
|
||||
* @returns A file descriptor referring to the program found, or a negative value if none.
|
||||
*
|
||||
* @sa bpf_program__name
|
||||
*/
|
||||
struct bpf_program*
|
||||
bpf_object__find_program_by_name(const struct bpf_object* obj, const char* name);
|
||||
|
||||
/**
|
||||
* @brief Get the name of an eBPF object.
|
||||
*
|
||||
* @param[in] obj The object to check.
|
||||
*
|
||||
* @returns The name of the object, or NULL if none.
|
||||
*/
|
||||
const char*
|
||||
bpf_object__name(const struct bpf_object* obj);
|
||||
|
||||
/**
|
||||
* @brief Pin an eBPF object to a specified path.
|
||||
*
|
||||
* @param[in] object Object to pin.
|
||||
* @param[in] path Path to pin the object to.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EBUSY Something is already pinned to the specified path.
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*
|
||||
* @sa bpf_object__pin_maps
|
||||
* @sa bpf_object__pin_programs
|
||||
* @sa bpf_object__unpin_maps
|
||||
* @sa bpf_object__unpin_programs
|
||||
*/
|
||||
int
|
||||
bpf_object__pin(struct bpf_object* object, const char* path);
|
||||
|
||||
/**
|
||||
* @brief Pin all maps associated with an eBPF object to a specified path.
|
||||
*
|
||||
* @param[in] obj Object to pin maps of.
|
||||
* @param[in] path Path to pin the maps to.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EBUSY Something is already pinned to the specified path.
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*
|
||||
* @sa bpf_map__pin
|
||||
* @sa bpf_object__pin
|
||||
* @sa bpf_object__unpin_maps
|
||||
*/
|
||||
int
|
||||
bpf_object__pin_maps(struct bpf_object* obj, const char* path);
|
||||
|
||||
/**
|
||||
* @brief Pin all programs associated with an eBPF object to a specified path.
|
||||
*
|
||||
* @param[in] obj Object to pin programs of.
|
||||
* @param[in] path Path to pin the programs to.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EBUSY Something is already pinned to the specified path.
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*
|
||||
* @sa bpf_program__pin
|
||||
* @sa bpf_object__pin
|
||||
* @sa bpf_object__unpin_programs
|
||||
*/
|
||||
int
|
||||
bpf_object__pin_programs(struct bpf_object* obj, const char* path);
|
||||
|
||||
/**
|
||||
* @brief Unpin all maps associated with an eBPF object from a specified path.
|
||||
*
|
||||
* @param[in] obj Object to unpin maps of.
|
||||
* @param[in] path Path from which to unpin the maps.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
*
|
||||
* @sa bpf_map__upnin
|
||||
* @sa bpf_object__pin_maps
|
||||
* @sa bpf_object__unpin
|
||||
*/
|
||||
int
|
||||
bpf_object__unpin_maps(struct bpf_object* obj, const char* path);
|
||||
|
||||
/**
|
||||
* @brief Unpin all programs associated with an eBPF object from a specified path.
|
||||
*
|
||||
* @param[in] obj Object to unpin programs of.
|
||||
* @param[in] path Path from which to unpin the programs.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
*
|
||||
* @sa bpf_program__unpin
|
||||
* @sa bpf_object__pin_mprograms
|
||||
* @sa bpf_object__unpin
|
||||
*/
|
||||
int
|
||||
bpf_object__unpin_programs(struct bpf_object* obj, const char* path);
|
||||
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @name Program-related functions
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Load (but do not attach) eBPF maps and programs from an ELF file.
|
||||
*
|
||||
* @param[in] file Path name to an ELF file.
|
||||
* @param[in] type Program type to use for loading eBPF programs. If BPF_PROG_TYPE_UNKNOWN,
|
||||
* the program type is derived from the section prefix in the ELF file.
|
||||
* @param[out] pobj Pointer to where to store the eBPF object loaded. The caller
|
||||
* is expected to call bpf_object__close() to free the object.
|
||||
* @param[out] prog_fd Returns a file descriptor for the first program.
|
||||
* The caller should not call _close() on the fd, but should instead use
|
||||
* bpf_object__close() on the object returned.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EINVAL One or more parameters are incorrect.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*
|
||||
* @sa bpf_program__attach
|
||||
* @sa bpf_object__close
|
||||
*/
|
||||
int
|
||||
bpf_prog_load(const char* file, enum bpf_prog_type type, struct bpf_object** pobj, int* prog_fd);
|
||||
|
||||
/**
|
||||
* @brief Attach an eBPF program to a hook associated with the program's expected attach type.
|
||||
*
|
||||
* @param[in] prog The program to attach.
|
||||
*
|
||||
* @returns The link created. On error, returns NULL and sets errno.
|
||||
*
|
||||
* @sa bpf_link__destroy
|
||||
* @sa bpf_program__get_expected_attach_type
|
||||
* @sa bpf_program__set_expected_attach_type
|
||||
* @sa ebpf_link_close
|
||||
*/
|
||||
struct bpf_link*
|
||||
bpf_program__attach(struct bpf_program* prog);
|
||||
|
||||
/**
|
||||
* @brief Attach an eBPF program to an XDP hook.
|
||||
*
|
||||
* @param[in] prog The program to attach.
|
||||
* @param[in] ifindex The interface index to attach to.
|
||||
*
|
||||
* @returns The link created. On error, returns NULL and sets errno.
|
||||
*
|
||||
* @sa bpf_link__destroy
|
||||
* @sa bpf_program__attach
|
||||
* @sa ebpf_link_close
|
||||
*/
|
||||
struct bpf_link*
|
||||
bpf_program__attach_xdp(struct bpf_program* prog, int ifindex);
|
||||
|
||||
/**
|
||||
* @brief Get a file descriptor that refers to a program.
|
||||
*
|
||||
* @param[in] prog Program to get a file descriptor for.
|
||||
*
|
||||
* @returns File descriptor that refers to the program.
|
||||
*/
|
||||
int
|
||||
bpf_program__fd(const struct bpf_program* prog);
|
||||
|
||||
/**
|
||||
* @brief Get the expected attach type for an eBPF program.
|
||||
*
|
||||
* @param[in] prog Program to check.
|
||||
*
|
||||
* @returns Expected attach type.
|
||||
*
|
||||
* @sa bpf_program__attach
|
||||
* @sa bpf_program__set_expected_attach_type
|
||||
*/
|
||||
enum bpf_attach_type
|
||||
bpf_program__get_expected_attach_type(const struct bpf_program* prog);
|
||||
|
||||
/**
|
||||
* @brief Get the function name of an eBPF program.
|
||||
*
|
||||
* @param[in] prog Program to check.
|
||||
*
|
||||
* @returns The name of the program, which is the name of the main
|
||||
* function called when invoked.
|
||||
*
|
||||
* @sa bpf_object__find_program_by_name
|
||||
*/
|
||||
const char*
|
||||
bpf_program__name(const struct bpf_program* prog);
|
||||
|
||||
/**
|
||||
* @brief Get the next program for a given eBPF object.
|
||||
*
|
||||
* @param[in] prog Previous program.
|
||||
* @param[in] obj Object with programs.
|
||||
*
|
||||
* @returns Next program, or NULL if none.
|
||||
*
|
||||
* @sa bpf_program__prev
|
||||
*/
|
||||
struct bpf_program*
|
||||
bpf_program__next(struct bpf_program* prog, const struct bpf_object* obj);
|
||||
|
||||
/**
|
||||
* @brief Pin a program to a specified path.
|
||||
*
|
||||
* @param[in] prog Program to pin.
|
||||
* @param[in] path Path to pin the program to.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EBUSY A pin path was previously specified.
|
||||
* @exception EEXIST Something is already pinned to the specified path.
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception ENOMEM Out of memory.
|
||||
*
|
||||
* @sa bpf_object__pin
|
||||
* @sa bpf_object__pin_programs
|
||||
* @sa bpf_program__unpin
|
||||
*/
|
||||
int
|
||||
bpf_program__pin(struct bpf_program* prog, const char* path);
|
||||
|
||||
/**
|
||||
* @brief Get the previous eBPF program for a given eBPF object.
|
||||
*
|
||||
* @param[in] prog Next program.
|
||||
* @param[in] obj Object with programs.
|
||||
*
|
||||
* @returns Previous eBPF program, or NULL if none.
|
||||
*
|
||||
* @sa bpf_program__next
|
||||
*/
|
||||
struct bpf_program*
|
||||
bpf_program__prev(struct bpf_program* prog, const struct bpf_object* obj);
|
||||
|
||||
/**
|
||||
* @brief Gets the ELF section name of an eBPF program, if any.
|
||||
*
|
||||
* @param[in] prog An eBPF program.
|
||||
*
|
||||
* @returns The ELF section name of an eBPF program, or NULL if none.
|
||||
*/
|
||||
const char*
|
||||
bpf_program__section_name(const struct bpf_program* prog);
|
||||
|
||||
/**
|
||||
* @brief Set the expected attach type for an eBPF program.
|
||||
*
|
||||
* @param[in] prog Program to update.
|
||||
* @param[in] type Attach type to set.
|
||||
*
|
||||
* @sa bpf_program__attach
|
||||
* @sa bpf_program__get_expected_attach_type
|
||||
*/
|
||||
void
|
||||
bpf_program__set_expected_attach_type(struct bpf_program* prog, enum bpf_attach_type type);
|
||||
|
||||
/**
|
||||
* @brief Unpin a program.
|
||||
*
|
||||
* @param[in] prog Program to unpin.
|
||||
* @param[in] path Path from which to unpin the program.
|
||||
*
|
||||
* @retval 0 The operation was successful.
|
||||
* @retval <0 An error occured, and errno was set.
|
||||
*
|
||||
* @exception EINVAL An invalid argument was provided.
|
||||
* @exception ENOENT The program was not pinned.
|
||||
*
|
||||
* @sa bpf_object__unpin_programs
|
||||
* @sa bpf_program__pin
|
||||
*/
|
||||
int
|
||||
bpf_program__unpin(struct bpf_program* prog, const char* path);
|
||||
|
||||
/** @} */
|
||||
|
||||
#else
|
||||
#pragma warning(push)
|
||||
#pragma warning(disable : 4200) // Zero-sized array in struct/union
|
||||
#include "../external/libbpf/src/libbpf.h"
|
||||
#pragma warning(pop)
|
||||
#endif
|
||||
|
|
|
|||
11
mainpage.dox
11
mainpage.dox
|
|
@ -23,7 +23,7 @@
|
|||
*
|
||||
* eBPF programs can also call helper APIs to do additional processing. There are two types of helpers:
|
||||
* <ul>
|
||||
* <li>Helpers defined in ebpf_helpers.h which are accessible to all program types.
|
||||
* <li>Helpers defined in bpf_helpers.h which are accessible to all program types.
|
||||
* <li>Helpers specific to a given program type and declared in other headers.
|
||||
* </ul>
|
||||
* The documentation for each program type will list which helper header files can be used for that program type.
|
||||
|
|
@ -33,6 +33,11 @@
|
|||
*
|
||||
* @section api eBPF User-Mode API Reference
|
||||
*
|
||||
* Eventually the libbpf API will be supported but this is still a work in progress.
|
||||
* In the meantime, ebpf_api.h defines the temporary user-mode API.
|
||||
* User-mode applications have access to three types of APIs:
|
||||
* <ul>
|
||||
* <li> Libbpf APIs defined in libbpf.h.
|
||||
* <li> Libbpf APIs defined in [**bpf.h**](bpf_8h.html).
|
||||
* <li> Additional APIs defined in ebpf_api.h. Many of these are temporary and will be replaced as more
|
||||
* Libbpf APIs are supported directly.
|
||||
* </ul>
|
||||
*/
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче