From 8e19131d2bf9ae123931133635a016361f050774 Mon Sep 17 00:00:00 2001 From: Github Action Date: Fri, 26 Jan 2024 17:33:35 +0000 Subject: [PATCH] Updated documentation Signed-off-by: Github Action --- bpf2c_8h.html | 1 - bpf2c_8h_source.html | 319 +++++++++++++++++++++---------------------- 2 files changed, 159 insertions(+), 161 deletions(-) diff --git a/bpf2c_8h.html b/bpf2c_8h.html index 38490c8639..0a0214890f 100644 --- a/bpf2c_8h.html +++ b/bpf2c_8h.html @@ -75,7 +75,6 @@
#include "ebpf_structs.h"
-#include <intrin.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
diff --git a/bpf2c_8h_source.html b/bpf2c_8h_source.html index 06fc95361f..04039cc921 100644 --- a/bpf2c_8h_source.html +++ b/bpf2c_8h_source.html @@ -90,130 +90,129 @@
19 #define UINT32_MAX ((uint32_t)0xFFFFFFFF)
20 
21 #else
-
22 #include <intrin.h>
-
23 #include <stdbool.h>
-
24 #include <stddef.h>
-
25 #include <stdint.h>
-
26 #endif
-
27 
-
28 #ifdef __cplusplus
-
29 extern "C"
-
30 {
-
31 #endif
-
32 
-
33 #define UBPF_STACK_SIZE 512
-
34 
-
35 #define IMMEDIATE(X) (int32_t) X
-
36 #define OFFSET(X) (int16_t) X
-
37 #define POINTER(X) (uint64_t)(X)
-
38 
-
39 #if !defined(htobe16)
-
40 #define htobe16(X) swap16(X)
-
41 #define htobe32(X) swap32(X)
-
42 #define htobe64(X) swap64(X)
-
43 
-
44 #define htole16(X) (X)
-
45 #define htole32(X) (X)
-
46 #define htole64(X) (X)
-
47 #endif
-
48 
-
55  typedef struct _helper_function_entry
-
56  {
-
57  uint64_t (*address)(uint64_t r1, uint64_t r2, uint64_t r3, uint64_t r4, uint64_t r5);
-
58  uint32_t helper_id;
-
59  const char* name;
-
60  bool tail_call;
-
61  } helper_function_entry_t;
-
62 
-
68  typedef struct _map_entry
-
69  {
-
70  void* address;
-
71  ebpf_map_definition_in_file_t definition;
-
72  const char* name;
-
73  } map_entry_t;
-
74 
-
81  typedef struct _map_initial_values
-
82  {
-
83  const char* name; // Name of the map.
-
84  size_t count; // Number of values in the map.
-
85  const char** values; // Array of strings containing the initial values.
-
86  } map_initial_values_t;
-
87 
-
92  typedef struct _program_entry
-
93  {
-
94  // DLLs put the strings into the same section, so add a marker
-
95  // at the start of a program entry to make it easy to find
-
96  // entries in the programs section.
-
97  uint64_t zero;
-
98 
-
99  uint64_t (*function)(void*);
-
100  const char* pe_section_name;
-
101  const char* section_name;
-
102  const char* program_name;
-
103  uint16_t* referenced_map_indices;
-
104  uint16_t referenced_map_count;
-
105  helper_function_entry_t* helpers;
-
106  uint16_t helper_count;
-
107  size_t bpf_instruction_count;
-
108  ebpf_program_type_t* program_type;
-
109  ebpf_attach_type_t* expected_attach_type;
-
110  const uint8_t* program_info_hash;
-
111  size_t program_info_hash_length;
-
112  const char* program_info_hash_type;
-
113  } program_entry_t;
-
114 
-
120  typedef struct _bpf2c_version
-
121  {
-
122  uint32_t major;
-
123  uint32_t minor;
-
124  uint32_t revision;
-
125  } bpf2c_version_t;
-
126 
-
132  typedef struct _metadata_table
-
133  {
-
134  size_t size;
-
135  void (*programs)(
-
136  _Outptr_result_buffer_maybenull_(*count) program_entry_t** programs,
-
137  _Out_ size_t* count);
-
138  void (*maps)(
-
139  _Outptr_result_buffer_maybenull_(*count) map_entry_t** maps,
-
140  _Out_ size_t* count);
-
141  void (*hash)(
-
142  _Outptr_result_buffer_maybenull_(*size) const uint8_t** hash,
-
143  _Out_ size_t* size);
-
144  void (*version)(_Out_ bpf2c_version_t* version);
-
145  void (*map_initial_values)(
-
146  _Outptr_result_buffer_maybenull_(*count) map_initial_values_t** map_initial_values,
-
147  _Out_ size_t* count);
-
148  } metadata_table_t;
-
149 
-
156  inline uint16_t
-
157  swap16(uint16_t value)
-
158  {
-
159  return value << 8 | value >> 8;
-
160  }
-
161 
-
168  inline uint32_t
-
169  swap32(uint32_t value)
-
170  {
-
171  return swap16(value >> 16) | ((uint32_t)swap16(value & ((1 << 16) - 1))) << 16;
-
172  }
-
173 
-
180  inline uint64_t
-
181  swap64(uint64_t value)
-
182  {
-
183  return swap32(value >> 32) | ((uint64_t)swap32(value & ((1ull << 32ull) - 1))) << 32;
-
184  }
-
185 
-
186 #ifdef __cplusplus
-
187 }
-
188 #endif
-
swap64
uint64_t swap64(uint64_t value)
Inline function used to implement the 64 bit EBPF_OP_LE/EBPF_OP_BE instruction.
Definition: bpf2c.h:181
+
22 #include <stdbool.h>
+
23 #include <stddef.h>
+
24 #include <stdint.h>
+
25 #endif
+
26 
+
27 #ifdef __cplusplus
+
28 extern "C"
+
29 {
+
30 #endif
+
31 
+
32 #define UBPF_STACK_SIZE 512
+
33 
+
34 #define IMMEDIATE(X) (int32_t) X
+
35 #define OFFSET(X) (int16_t) X
+
36 #define POINTER(X) (uint64_t)(X)
+
37 
+
38 #if !defined(htobe16)
+
39 #define htobe16(X) swap16(X)
+
40 #define htobe32(X) swap32(X)
+
41 #define htobe64(X) swap64(X)
+
42 
+
43 #define htole16(X) (X)
+
44 #define htole32(X) (X)
+
45 #define htole64(X) (X)
+
46 #endif
+
47 
+
54  typedef struct _helper_function_entry
+
55  {
+
56  uint64_t (*address)(uint64_t r1, uint64_t r2, uint64_t r3, uint64_t r4, uint64_t r5);
+
57  uint32_t helper_id;
+
58  const char* name;
+
59  bool tail_call;
+
60  } helper_function_entry_t;
+
61 
+
67  typedef struct _map_entry
+
68  {
+
69  void* address;
+
70  ebpf_map_definition_in_file_t definition;
+
71  const char* name;
+
72  } map_entry_t;
+
73 
+
80  typedef struct _map_initial_values
+
81  {
+
82  const char* name; // Name of the map.
+
83  size_t count; // Number of values in the map.
+
84  const char** values; // Array of strings containing the initial values.
+
85  } map_initial_values_t;
+
86 
+
91  typedef struct _program_entry
+
92  {
+
93  // DLLs put the strings into the same section, so add a marker
+
94  // at the start of a program entry to make it easy to find
+
95  // entries in the programs section.
+
96  uint64_t zero;
+
97 
+
98  uint64_t (*function)(void*);
+
99  const char* pe_section_name;
+
100  const char* section_name;
+
101  const char* program_name;
+
102  uint16_t* referenced_map_indices;
+
103  uint16_t referenced_map_count;
+
104  helper_function_entry_t* helpers;
+
105  uint16_t helper_count;
+
106  size_t bpf_instruction_count;
+
107  ebpf_program_type_t* program_type;
+
108  ebpf_attach_type_t* expected_attach_type;
+
109  const uint8_t* program_info_hash;
+
110  size_t program_info_hash_length;
+
111  const char* program_info_hash_type;
+
112  } program_entry_t;
+
113 
+
119  typedef struct _bpf2c_version
+
120  {
+
121  uint32_t major;
+
122  uint32_t minor;
+
123  uint32_t revision;
+
124  } bpf2c_version_t;
+
125 
+
131  typedef struct _metadata_table
+
132  {
+
133  size_t size;
+
134  void (*programs)(
+
135  _Outptr_result_buffer_maybenull_(*count) program_entry_t** programs,
+
136  _Out_ size_t* count);
+
137  void (*maps)(
+
138  _Outptr_result_buffer_maybenull_(*count) map_entry_t** maps,
+
139  _Out_ size_t* count);
+
140  void (*hash)(
+
141  _Outptr_result_buffer_maybenull_(*size) const uint8_t** hash,
+
142  _Out_ size_t* size);
+
143  void (*version)(_Out_ bpf2c_version_t* version);
+
144  void (*map_initial_values)(
+
145  _Outptr_result_buffer_maybenull_(*count) map_initial_values_t** map_initial_values,
+
146  _Out_ size_t* count);
+
147  } metadata_table_t;
+
148 
+
155  inline uint16_t
+
156  swap16(uint16_t value)
+
157  {
+
158  return value << 8 | value >> 8;
+
159  }
+
160 
+
167  inline uint32_t
+
168  swap32(uint32_t value)
+
169  {
+
170  return swap16(value >> 16) | ((uint32_t)swap16(value & ((1 << 16) - 1))) << 16;
+
171  }
+
172 
+
179  inline uint64_t
+
180  swap64(uint64_t value)
+
181  {
+
182  return swap32(value >> 32) | ((uint64_t)swap32(value & ((1ull << 32ull) - 1))) << 32;
+
183  }
+
184 
+
185 #ifdef __cplusplus
+
186 }
+
187 #endif
+
swap64
uint64_t swap64(uint64_t value)
Inline function used to implement the 64 bit EBPF_OP_LE/EBPF_OP_BE instruction.
Definition: bpf2c.h:180
map_initial_values_t
struct _map_initial_values map_initial_values_t
Map initial values. This structure contains the initial values for a map. The values are used to init...
map_entry_t
struct _map_entry map_entry_t
Map entry. This structure contains the address of the map and the map definition. The address is writ...
helper_function_entry_t
struct _helper_function_entry helper_function_entry_t
Helper function entry. This structure defines a helper function entry in the metadata table....
-
swap32
uint32_t swap32(uint32_t value)
Inline function used to implement the 32 bit EBPF_OP_LE/EBPF_OP_BE instruction.
Definition: bpf2c.h:169
-
swap16
uint16_t swap16(uint16_t value)
Inline function used to implement the 16 bit EBPF_OP_LE/EBPF_OP_BE instruction.
Definition: bpf2c.h:157
+
swap32
uint32_t swap32(uint32_t value)
Inline function used to implement the 32 bit EBPF_OP_LE/EBPF_OP_BE instruction.
Definition: bpf2c.h:168
+
swap16
uint16_t swap16(uint16_t value)
Inline function used to implement the 16 bit EBPF_OP_LE/EBPF_OP_BE instruction.
Definition: bpf2c.h:156
program_entry_t
struct _program_entry program_entry_t
Program entry. This structure contains the address of the program and additional information about th...
bpf2c_version_t
struct _bpf2c_version bpf2c_version_t
Version information for the bpf2c compiler. This structure contains the version information for the b...
metadata_table_t
struct _metadata_table metadata_table_t
Metadata table for a module. This structure is returned by the module's metadata function,...
@@ -221,46 +220,46 @@
ebpf_attach_type_t
GUID ebpf_attach_type_t
Definition: ebpf_windows.h:44
ebpf_program_type_t
GUID ebpf_program_type_t
Definition: ebpf_windows.h:43
-
_bpf2c_version
Version information for the bpf2c compiler. This structure contains the version information for the b...
Definition: bpf2c.h:121
-
_bpf2c_version::major
uint32_t major
Definition: bpf2c.h:122
-
_bpf2c_version::revision
uint32_t revision
Definition: bpf2c.h:124
-
_bpf2c_version::minor
uint32_t minor
Definition: bpf2c.h:123
+
_bpf2c_version
Version information for the bpf2c compiler. This structure contains the version information for the b...
Definition: bpf2c.h:120
+
_bpf2c_version::major
uint32_t major
Definition: bpf2c.h:121
+
_bpf2c_version::revision
uint32_t revision
Definition: bpf2c.h:123
+
_bpf2c_version::minor
uint32_t minor
Definition: bpf2c.h:122
_ebpf_map_definition_in_file
eBPF Map Definition as it appears in the maps section of an ELF file.
Definition: ebpf_structs.h:125
-
_helper_function_entry
Helper function entry. This structure defines a helper function entry in the metadata table....
Definition: bpf2c.h:56
-
_helper_function_entry::tail_call
bool tail_call
Definition: bpf2c.h:60
-
_helper_function_entry::name
const char * name
Definition: bpf2c.h:59
-
_helper_function_entry::address
uint64_t(* address)(uint64_t r1, uint64_t r2, uint64_t r3, uint64_t r4, uint64_t r5)
Definition: bpf2c.h:57
-
_helper_function_entry::helper_id
uint32_t helper_id
Definition: bpf2c.h:58
-
_map_entry
Map entry. This structure contains the address of the map and the map definition. The address is writ...
Definition: bpf2c.h:69
-
_map_entry::definition
ebpf_map_definition_in_file_t definition
Definition: bpf2c.h:71
-
_map_entry::address
void * address
Definition: bpf2c.h:70
-
_map_entry::name
const char * name
Definition: bpf2c.h:72
-
_map_initial_values
Map initial values. This structure contains the initial values for a map. The values are used to init...
Definition: bpf2c.h:82
-
_map_initial_values::values
const char ** values
Definition: bpf2c.h:85
-
_map_initial_values::count
size_t count
Definition: bpf2c.h:84
-
_map_initial_values::name
const char * name
Definition: bpf2c.h:83
-
_metadata_table
Metadata table for a module. This structure is returned by the module's metadata function,...
Definition: bpf2c.h:133
-
_metadata_table::version
void(* version)(bpf2c_version_t *version)
Definition: bpf2c.h:144
-
_metadata_table::size
size_t size
Size of this structure. Used for versioning.
Definition: bpf2c.h:134
-
_metadata_table::map_initial_values
void(* map_initial_values)((*count) map_initial_values_t **map_initial_values, size_t *count)
Returns the list of initial values for maps in this module.
Definition: bpf2c.h:145
-
_metadata_table::programs
void(* programs)((*count) program_entry_t **programs, size_t *count)
Returns the list of programs in this module.
Definition: bpf2c.h:135
-
_metadata_table::hash
void(* hash)((*size) const uint8_t **hash, size_t *size)
Returns the hash of the ELF file used to generate this module.
Definition: bpf2c.h:141
-
_metadata_table::maps
void(* maps)((*count) map_entry_t **maps, size_t *count)
Returns the list of maps in this module.
Definition: bpf2c.h:138
-
_program_entry
Program entry. This structure contains the address of the program and additional information about th...
Definition: bpf2c.h:93
-
_program_entry::helper_count
uint16_t helper_count
Number of helper functions used by the program.
Definition: bpf2c.h:106
-
_program_entry::zero
uint64_t zero
Definition: bpf2c.h:97
-
_program_entry::program_info_hash_type
const char * program_info_hash_type
Type of the program info hash.
Definition: bpf2c.h:112
-
_program_entry::referenced_map_count
uint16_t referenced_map_count
Number of maps referenced by the program.
Definition: bpf2c.h:104
-
_program_entry::program_name
const char * program_name
Name of the program.
Definition: bpf2c.h:102
-
_program_entry::bpf_instruction_count
size_t bpf_instruction_count
Number of BPF instructions in the program.
Definition: bpf2c.h:107
-
_program_entry::program_info_hash_length
size_t program_info_hash_length
Length of the program info hash.
Definition: bpf2c.h:111
-
_program_entry::referenced_map_indices
uint16_t * referenced_map_indices
List of map indices referenced by the program.
Definition: bpf2c.h:103
-
_program_entry::expected_attach_type
ebpf_attach_type_t * expected_attach_type
Expected attach type of the program.
Definition: bpf2c.h:109
-
_program_entry::pe_section_name
const char * pe_section_name
Name of the PE section containing the program.
Definition: bpf2c.h:100
-
_program_entry::program_info_hash
const uint8_t * program_info_hash
Hash of the program info.
Definition: bpf2c.h:110
-
_program_entry::section_name
const char * section_name
Name of the section containing the program.
Definition: bpf2c.h:101
-
_program_entry::program_type
ebpf_program_type_t * program_type
Type of the program.
Definition: bpf2c.h:108
-
_program_entry::helpers
helper_function_entry_t * helpers
List of helper functions used by the program.
Definition: bpf2c.h:105
+
_helper_function_entry
Helper function entry. This structure defines a helper function entry in the metadata table....
Definition: bpf2c.h:55
+
_helper_function_entry::tail_call
bool tail_call
Definition: bpf2c.h:59
+
_helper_function_entry::name
const char * name
Definition: bpf2c.h:58
+
_helper_function_entry::address
uint64_t(* address)(uint64_t r1, uint64_t r2, uint64_t r3, uint64_t r4, uint64_t r5)
Definition: bpf2c.h:56
+
_helper_function_entry::helper_id
uint32_t helper_id
Definition: bpf2c.h:57
+
_map_entry
Map entry. This structure contains the address of the map and the map definition. The address is writ...
Definition: bpf2c.h:68
+
_map_entry::definition
ebpf_map_definition_in_file_t definition
Definition: bpf2c.h:70
+
_map_entry::address
void * address
Definition: bpf2c.h:69
+
_map_entry::name
const char * name
Definition: bpf2c.h:71
+
_map_initial_values
Map initial values. This structure contains the initial values for a map. The values are used to init...
Definition: bpf2c.h:81
+
_map_initial_values::values
const char ** values
Definition: bpf2c.h:84
+
_map_initial_values::count
size_t count
Definition: bpf2c.h:83
+
_map_initial_values::name
const char * name
Definition: bpf2c.h:82
+
_metadata_table
Metadata table for a module. This structure is returned by the module's metadata function,...
Definition: bpf2c.h:132
+
_metadata_table::version
void(* version)(bpf2c_version_t *version)
Definition: bpf2c.h:143
+
_metadata_table::size
size_t size
Size of this structure. Used for versioning.
Definition: bpf2c.h:133
+
_metadata_table::map_initial_values
void(* map_initial_values)((*count) map_initial_values_t **map_initial_values, size_t *count)
Returns the list of initial values for maps in this module.
Definition: bpf2c.h:144
+
_metadata_table::programs
void(* programs)((*count) program_entry_t **programs, size_t *count)
Returns the list of programs in this module.
Definition: bpf2c.h:134
+
_metadata_table::hash
void(* hash)((*size) const uint8_t **hash, size_t *size)
Returns the hash of the ELF file used to generate this module.
Definition: bpf2c.h:140
+
_metadata_table::maps
void(* maps)((*count) map_entry_t **maps, size_t *count)
Returns the list of maps in this module.
Definition: bpf2c.h:137
+
_program_entry
Program entry. This structure contains the address of the program and additional information about th...
Definition: bpf2c.h:92
+
_program_entry::helper_count
uint16_t helper_count
Number of helper functions used by the program.
Definition: bpf2c.h:105
+
_program_entry::zero
uint64_t zero
Definition: bpf2c.h:96
+
_program_entry::program_info_hash_type
const char * program_info_hash_type
Type of the program info hash.
Definition: bpf2c.h:111
+
_program_entry::referenced_map_count
uint16_t referenced_map_count
Number of maps referenced by the program.
Definition: bpf2c.h:103
+
_program_entry::program_name
const char * program_name
Name of the program.
Definition: bpf2c.h:101
+
_program_entry::bpf_instruction_count
size_t bpf_instruction_count
Number of BPF instructions in the program.
Definition: bpf2c.h:106
+
_program_entry::program_info_hash_length
size_t program_info_hash_length
Length of the program info hash.
Definition: bpf2c.h:110
+
_program_entry::referenced_map_indices
uint16_t * referenced_map_indices
List of map indices referenced by the program.
Definition: bpf2c.h:102
+
_program_entry::expected_attach_type
ebpf_attach_type_t * expected_attach_type
Expected attach type of the program.
Definition: bpf2c.h:108
+
_program_entry::pe_section_name
const char * pe_section_name
Name of the PE section containing the program.
Definition: bpf2c.h:99
+
_program_entry::program_info_hash
const uint8_t * program_info_hash
Hash of the program info.
Definition: bpf2c.h:109
+
_program_entry::section_name
const char * section_name
Name of the section containing the program.
Definition: bpf2c.h:100
+
_program_entry::program_type
ebpf_program_type_t * program_type
Type of the program.
Definition: bpf2c.h:107
+
_program_entry::helpers
helper_function_entry_t * helpers
List of helper functions used by the program.
Definition: bpf2c.h:104