linux-support 0.0.25

Comprehensive Linux support for namespaces, cgroups, processes, scheduling, parsing /proc, parsing /sys, signals, hyper threads, CPUS, NUMA nodes, unusual file descriptors, PCI devices and much, much more
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

// This file is part of linux-support. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/linux-support/master/COPYRIGHT. No part of linux-support, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2020 The developers of linux-support. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/linux-support/master/COPYRIGHT.


/// A register.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[derive(Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
#[repr(u8)]
pub enum Register
{
	/// `r0`.
	///
	/// Use for return codes and exit codes.
	///
	/// Also used for converted classic BPC (cBPF) programs for register `A`.
	///
	/// `BPF_REG_0`.
	r0 = 0,
	
	/// `r1`.
	///
	/// Upon program start contains the `ctx` argument pointer of type `struct __sk_buff`, ie a pointer to `struct __sk_buff` unless the program has
	/// To access the `protocol` field in this struct one might do:-
	///
	/// ```
	/// use self::SerializableExtendedInstruction::*;
	/// use self::Register::*;
	/// load16_from_memory(r0, r1, MemoryOffset::Known(16))
	/// ```
	///
	/// First argument passed to a function.
	///
	/// `BPF_REG_1` and `BPF_ARG_1`.
	r1 = 1,
	
	/// `r2`.
	///
	/// Second argument passed to a function.
	///
	/// `BPF_REG_2` and `BPF_ARG_2`.
	r2 = 2,
	
	/// `r3`.
	///
	/// Third argument passed to a function (or eBPF program if using the `bpf_tail_call()` function).
	///
	/// `BPF_REG_3` and `BPF_ARG_3`.
	r3 = 3,
	
	/// `r4`.
	///
	/// Fourth argument passed to a function (or eBPF program if using the `bpf_tail_call()` function).
	///
	/// `BPF_REG_4` and `BPF_ARG_4`.
	r4 = 4,
	
	/// `r5`.
	///
	/// Fifth argument passed to a function (or eBPF program if using the `bpf_tail_call()` function).
	///
	/// `BPF_REG_5` and `BPF_ARG_5`.
	r5 = 5,
	
	/// `r6`.
	///
	/// Preserved (callee-saved) across function calls.
	///
	/// Also used for a context (`BPF_REG_CTX`).
	///
	/// `BPF_REG_6`.
	r6 = 6,
	
	/// `r7`.
	///
	/// Preserved (callee-saved) across function calls.
	///
	/// Also used for converted classic BPC (cBPF) programs for register `X`.
	///
	/// `BPF_REG_7`.
	r7 = 7,
	
	/// `r8`.
	///
	/// Preserved (callee-saved) across function calls.
	///
	/// Also used for converted classic BPC (cBPF) programs for register `TMP`.
	///
	/// `BPF_REG_8`.
	r8 = 8,
	
	/// `r9`.
	///
	/// Preserved (callee-saved) across function calls.
	///
	/// `BPF_REG_9`.
	r9 = 9,
	
	/// Also known as `fp`.
	///
	/// Stores frame pointer to access the stack, which is 512 bytes in size.
	///
	/// Read-only.
	///
	/// `BPF_REG_10`.
	r10 = 10,
}

impl Register
{
	/// An alias to `r10`.
	pub const fp: Self = Register::r10;
	
	pub(crate) const BPF_PSEUDO_MAP_FD: Register = Register::r1;
	
	pub(crate) const BPF_PSEUDO_MAP_VALUE: Register = Register::r2;
	
	pub(crate) const BPF_PSEUDO_CALL: Register = Register::r1;
}