Skip to content

Commit

Permalink
Document the register and stack masks better
Browse files Browse the repository at this point in the history
Signed-off-by: Alan Jowett <[email protected]>
  • Loading branch information
Alan Jowett committed Oct 16, 2024
1 parent fb607f1 commit 8ba0c88
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion vm/inc/ubpf.h
Original file line number Diff line number Diff line change
Expand Up @@ -580,8 +580,11 @@ extern "C"
* @param[in] stack_start Pointer to the beginning of the stack.
* @param[in] stack_length Size of the stack in bytes.
* @param[in] register_mask Bitmask of registers that have been modified since the start of the program.
* Each set bit represents 1 modified register. LSB corresponds to register 0 and so on.
* @param[in] stack_mask_start Bitmask of the stack that has been modified since the start of the program.
* Each set bit represents 1 byte of the stack that has been modified.
* Each set bit represents 1 byte of the stack that has been modified. LSB corresponds to the first byte relative to stack_start
* and the MSB corresponds to the last byte. Note that the stack grows downwards, so the byte corresponding to the MSB is the first byte
* of the stack from the POV of the program and LSB is the last byte.
*/
typedef void (*ubpf_debug_fn)(
void* context,
Expand Down

0 comments on commit 8ba0c88

Please sign in to comment.