Line data Source code
1 : #ifndef HEADER_fd_src_flamenco_vm_syscall_fd_vm_syscall_macros_h
2 : #define HEADER_fd_src_flamenco_vm_syscall_fd_vm_syscall_macros_h
3 : #include "../fd_vm_private.h"
4 :
5 : /* fd_vm_cu API *******************************************************/
6 :
7 : /* FD_VM_CU_UPDATE charges the vm cost compute units.
8 :
9 : If the vm does not have more than cost cu available, this will cause
10 : the caller to zero out the vm->cu and return with FD_VM_SYSCALL_ERR_COMPUTE_BUDGET_EXCEEDED.
11 : This macro is robust.
12 : This is meant to be used by syscall implementations and strictly
13 : conforms with the vm-syscall ABI interface.
14 :
15 : Note: in Agave a syscall can return success leaving 0 available CUs.
16 : The instruction will fail at the next instruction (e.g., exit).
17 : To reproduce the same behavior, we do not return FD_VM_SYSCALL_ERR_COMPUTE_BUDGET_EXCEEDED
18 : when cu == 0.
19 :
20 : FD_VM_CU_MEM_UPDATE charges the vm the equivalent of sz bytes of
21 : compute units. Behavior is otherwise identical to FD_VM_CU_UPDATE.
22 : FIXME: THIS API PROBABLY BELONGS IN SYSCALL CPI LAND. */
23 :
24 35524 : #define FD_VM_CU_UPDATE( vm, cost ) (__extension__({ \
25 35524 : fd_vm_t * _vm = (vm); \
26 35524 : ulong _cost = (cost); \
27 35524 : ulong _cu = _vm->cu; \
28 35524 : if( FD_UNLIKELY( _cost>_cu ) ) { \
29 100 : _vm->cu = 0UL; \
30 100 : FD_VM_ERR_FOR_LOG_INSTR( vm, FD_EXECUTOR_INSTR_ERR_COMPUTE_BUDGET_EXCEEDED ); \
31 100 : return FD_VM_SYSCALL_ERR_COMPUTE_BUDGET_EXCEEDED; \
32 100 : } \
33 35524 : _vm->cu = _cu - _cost; \
34 35424 : }))
35 :
36 : /* https://github.com/anza-xyz/agave/blob/5263c9d61f3af060ac995956120bef11c1bbf182/programs/bpf_loader/src/syscalls/mem_ops.rs#L7 */
37 : #define FD_VM_CU_MEM_OP_UPDATE( vm, sz ) \
38 3750 : FD_VM_CU_UPDATE( vm, fd_ulong_max( FD_VM_MEM_OP_BASE_COST, sz / FD_VM_CPI_BYTES_PER_UNIT ) )
39 :
40 :
41 : /* fd_vm_mem API *****************************************************/
42 :
43 : /* fd_vm_haddr_query is a struct that contains information about a vaddr, align, sz, and whether it is a slice.
44 : The translated haddr is written into the `haddr` field of the struct on success. This struct is primarily used
45 : by the FD_VM_TRANSLATE_MUT macro. See more details in the macro's documentation. */
46 : struct fd_vm_haddr_query {
47 : ulong vaddr;
48 : ulong align;
49 : ulong sz;
50 : uchar is_slice;
51 : void * haddr; /* out field */
52 : };
53 : typedef struct fd_vm_haddr_query fd_vm_haddr_query_t;
54 :
55 : /* FD_VM_HADDR_QUERY_U8_SLICE_OR_ARRAY returns the haddr corresponding
56 : to _vaddr, when _vaddr is an u8 array of size _sz, and handles the
57 : difference between slice (_is_slice=1) or array (_is_slice=0).
58 : This is a common pattern in cryptographic syscalls, see for example
59 : fd_vm_syscall_crypto.c, fd_vm_syscall_curve.c */
60 6059 : #define FD_VM_HADDR_QUERY_U8_SLICE_OR_ARRAY(_vm,_vaddr,_sz,_is_slice) (__extension__({ \
61 6059 : fd_vm_haddr_query_t _result = { \
62 6059 : .vaddr = (_vaddr), \
63 6059 : .align = (_is_slice) ? FD_VM_ALIGN_RUST_U8 : FD_VM_ALIGN_RUST_POD_U8_ARRAY, \
64 6059 : .sz = (_sz), \
65 6059 : .is_slice = (_is_slice), \
66 6059 : }; \
67 6059 : fd_vm_haddr_query_t * queries[] = { &_result }; \
68 6059 : FD_VM_TRANSLATE_MUT( (_vm), queries ); \
69 6059 : _result.haddr; }));
70 :
71 5007 : #define FD_VM_HADDR_QUERY_U8_SLICE(_vm,_vaddr,_sz) FD_VM_HADDR_QUERY_U8_SLICE_OR_ARRAY(_vm,_vaddr,_sz,1)
72 1052 : #define FD_VM_HADDR_QUERY_U8_ARRAY(_vm,_vaddr,_sz) FD_VM_HADDR_QUERY_U8_SLICE_OR_ARRAY(_vm,_vaddr,_sz,0)
73 :
74 : /* FD_VM_MEM_HADDR_LD returns a read only pointer to the first byte
75 : in the host address space corresponding to vm's virtual address range
76 : [vaddr,vaddr+sz). If the vm has check_align enabled, the vaddr
77 : should be aligned to align and the returned pointer will be similarly
78 : aligned. Align is assumed to be a power of two <= 8 (FIXME: CHECK
79 : THIS LIMIT).
80 :
81 : If the virtual address range cannot be mapped to the host address
82 : space completely and/or (when applicable) vaddr is not appropriately
83 : aligned, this will cause the caller to return FD_VM_SYSCALL_ERR_SEGFAULT.
84 : This macro is robust. This is meant to be used by syscall
85 : implementations and strictly conforms with the vm-syscall ABI
86 : interface.
87 :
88 : FD_VM_MEM_HADDR_ST returns a read-write pointer but is otherwise
89 : identical to FD_VM_MEM_HADDR_LD.
90 :
91 : These macros intentionally don't support multi region loads/stores.
92 : The load/store macros are used by vm syscalls and mirror the use
93 : of translate_slice{_mut}. However, this check does not allow for
94 : multi region accesses. So if there is an attempt at a multi region
95 : translation, an error will be returned.
96 :
97 : FD_VM_MEM_HADDR_ST_UNCHECKED has all of the checks of a load or a
98 : store, but intentionally omits the is_writable checks for the
99 : input region that are done during memory translation.
100 :
101 : FD_VM_MEM_HADDR_ST_NO_SZ_CHECK does all of the checks of a load,
102 : except for a check on the validity of the size of a load. It only
103 : checks that the specific vaddr that is being translated is valid. */
104 :
105 50465 : #define FD_VM_MEM_HADDR_LD( vm, vaddr, align, sz ) (__extension__({ \
106 50465 : fd_vm_t * _vm = (vm); \
107 50465 : ulong _vaddr = (vaddr); \
108 50465 : ulong _haddr = fd_vm_mem_haddr( vm, _vaddr, (sz), _vm->region_haddr, _vm->region_ld_sz, 0, 0UL ); \
109 50465 : int _sigbus = fd_vm_is_check_align_enabled( vm ) & (!fd_ulong_is_aligned( _haddr, (align) )); \
110 50465 : if ( FD_UNLIKELY( sz > LONG_MAX ) ) { \
111 0 : FD_VM_ERR_FOR_LOG_SYSCALL( _vm, FD_VM_SYSCALL_ERR_INVALID_LENGTH ); \
112 0 : return FD_VM_SYSCALL_ERR_SEGFAULT; \
113 0 : } \
114 50465 : if( FD_UNLIKELY( (!_haddr) ) ) { \
115 318 : _vm->segv_vaddr = _vaddr; \
116 318 : _vm->segv_access_len = (sz); \
117 318 : _vm->segv_access_type = FD_VM_ACCESS_TYPE_LD; \
118 318 : FD_VM_ERR_FOR_LOG_EBPF( _vm, fd_vm_generate_access_violation( _vaddr, _vm->sbpf_version ) ); \
119 318 : return FD_VM_SYSCALL_ERR_SEGFAULT; \
120 318 : } \
121 50465 : if ( FD_UNLIKELY( _sigbus ) ) { \
122 5 : FD_VM_ERR_FOR_LOG_SYSCALL( _vm, FD_VM_SYSCALL_ERR_UNALIGNED_POINTER ); \
123 5 : return FD_VM_SYSCALL_ERR_SEGFAULT; \
124 5 : } \
125 50147 : (void const *)_haddr; \
126 50142 : }))
127 :
128 : #define FD_VM_MEM_HADDR_LD_UNCHECKED( vm, vaddr, align, sz ) (__extension__({ \
129 : fd_vm_t const * _vm = (vm); \
130 : ulong _vaddr = (vaddr); \
131 : ulong _haddr = fd_vm_mem_haddr( vm, _vaddr, (sz), _vm->region_haddr, _vm->region_ld_sz, 0, 0UL ); \
132 : (void const *)_haddr; \
133 : }))
134 :
135 :
136 : #define FD_VM_MEM_HADDR_LD_NO_SZ_CHECK( vm, vaddr, align ) (__extension__({ \
137 : FD_VM_MEM_HADDR_LD( vm, vaddr, align, 1UL ); \
138 : }))
139 :
140 : static inline void *
141 15074 : FD_VM_MEM_HADDR_ST_( fd_vm_t *vm, ulong vaddr, ulong align, ulong sz, int *err ) {
142 15074 : fd_vm_t * _vm = (vm);
143 15074 : ulong _vaddr = (vaddr);
144 15074 : ulong _haddr = fd_vm_mem_haddr( vm, _vaddr, (sz), _vm->region_haddr, _vm->region_st_sz, 1, 0UL );
145 15074 : int _sigbus = fd_vm_is_check_align_enabled( vm ) & (!fd_ulong_is_aligned( _haddr, (align) ));
146 15074 : if ( FD_UNLIKELY( sz > LONG_MAX ) ) {
147 0 : FD_VM_ERR_FOR_LOG_SYSCALL( _vm, FD_VM_SYSCALL_ERR_INVALID_LENGTH );
148 0 : *err = FD_VM_SYSCALL_ERR_SEGFAULT;
149 0 : return NULL;
150 0 : }
151 15074 : if( FD_UNLIKELY( (!_haddr) ) ) {
152 3 : vm->segv_vaddr = vaddr;
153 3 : vm->segv_access_len = (sz);
154 3 : vm->segv_access_type = FD_VM_ACCESS_TYPE_ST;
155 3 : FD_VM_ERR_FOR_LOG_EBPF( _vm, fd_vm_generate_access_violation( _vaddr, _vm->sbpf_version ) );
156 3 : *err = FD_VM_SYSCALL_ERR_SEGFAULT;
157 3 : return NULL;
158 3 : }
159 15071 : if ( FD_UNLIKELY( _sigbus ) ) {
160 10 : FD_VM_ERR_FOR_LOG_SYSCALL( _vm, FD_VM_SYSCALL_ERR_UNALIGNED_POINTER );
161 10 : *err = FD_VM_SYSCALL_ERR_SEGFAULT;
162 10 : return NULL;
163 10 : }
164 15061 : return (void *)_haddr;
165 15071 : }
166 :
167 15076 : #define FD_VM_MEM_HADDR_ST( vm, vaddr, align, sz ) (__extension__({ \
168 15076 : int _err = 0; \
169 15076 : void * ret = FD_VM_MEM_HADDR_ST_( vm, vaddr, align, sz, &_err ); \
170 15076 : if ( FD_UNLIKELY( 0 != _err )) \
171 15076 : return _err; \
172 15076 : ret; \
173 15063 : }))
174 :
175 : #define FD_VM_MEM_HADDR_ST_UNCHECKED( vm, vaddr, align, sz ) (__extension__({ \
176 : fd_vm_t * _vm = (vm); \
177 : ulong _vaddr = (vaddr); \
178 : ulong _haddr = fd_vm_mem_haddr( vm, _vaddr, (sz), _vm->region_haddr, _vm->region_st_sz, 1, 0UL ); \
179 : (void const *)_haddr; \
180 : }))
181 :
182 : #define FD_VM_MEM_HADDR_ST_WRITE_UNCHECKED( vm, vaddr, align, sz ) (__extension__({ \
183 : fd_vm_t * _vm = (vm); \
184 : ulong _vaddr = (vaddr); \
185 : ulong _haddr = fd_vm_mem_haddr( vm, _vaddr, (sz), _vm->region_haddr, _vm->region_st_sz, 0, 0UL ); \
186 : int _sigbus = fd_vm_is_check_align_enabled( vm ) & (!fd_ulong_is_aligned( _haddr, (align) )); \
187 : if ( FD_UNLIKELY( sz > LONG_MAX ) ) { \
188 : FD_VM_ERR_FOR_LOG_SYSCALL( _vm, FD_VM_SYSCALL_ERR_INVALID_LENGTH ); \
189 : return FD_VM_SYSCALL_ERR_SEGFAULT; \
190 : } \
191 : if( FD_UNLIKELY( !_haddr ) ) { \
192 : _vm->segv_vaddr = _vaddr; \
193 : _vm->segv_access_len = (sz); \
194 : _vm->segv_access_type = FD_VM_ACCESS_TYPE_ST; \
195 : FD_VM_ERR_FOR_LOG_EBPF( _vm, fd_vm_generate_access_violation( _vaddr, _vm->sbpf_version ) ); \
196 : return FD_VM_SYSCALL_ERR_SEGFAULT; \
197 : } \
198 : if ( FD_UNLIKELY( _sigbus ) ) { \
199 : FD_VM_ERR_FOR_LOG_SYSCALL( _vm, FD_VM_SYSCALL_ERR_UNALIGNED_POINTER ); \
200 : return FD_VM_SYSCALL_ERR_SEGFAULT; \
201 : } \
202 : (void *)_haddr; \
203 : }))
204 :
205 :
206 : #define FD_VM_MEM_HADDR_ST_NO_SZ_CHECK( vm, vaddr, align ) (__extension__({ \
207 : int _err = 0; \
208 : void * ret = FD_VM_MEM_HADDR_ST_( vm, vaddr, align, 1UL, &_err ); \
209 : if ( FD_UNLIKELY( 0 != _err )) \
210 : return _err; \
211 : ret; \
212 : }))
213 :
214 :
215 : /* FD_VM_MEM_SLICE_HADDR_[LD, ST] macros return an arbitrary value if sz == 0. This is because
216 : Agave's translate_slice function returns an empty array if the sz == 0.
217 :
218 : Users of this macro should be aware that they should never access the returned value if sz==0.
219 :
220 : https://github.com/solana-labs/solana/blob/767d24e5c10123c079e656cdcf9aeb8a5dae17db/programs/bpf_loader/src/syscalls/mod.rs#L560
221 :
222 : LONG_MAX check: https://github.com/anza-xyz/agave/blob/dc4b9dcbbf859ff48f40d00db824bde063fdafcc/programs/bpf_loader/src/syscalls/mod.rs#L580
223 : Technically, the check in Agave is against
224 : "pointer-sized signed integer type ... The size of this primitive is
225 : how many bytes it takes to reference any location in memory. For
226 : example, on a 32 bit target, this is 4 bytes and on a 64 bit target,
227 : this is 8 bytes."
228 : Realistically, given the amount of memory that a validator consumes,
229 : no one is going to be running on a 32 bit target. So, we don't bother
230 : with conditionally compiling in an INT_MAX check. We just assume
231 : LONG_MAX. */
232 30509 : #define FD_VM_MEM_SLICE_HADDR_LD( vm, vaddr, align, sz ) (__extension__({ \
233 30509 : if ( FD_UNLIKELY( sz > LONG_MAX ) ) { \
234 14 : FD_VM_ERR_FOR_LOG_SYSCALL( vm, FD_VM_SYSCALL_ERR_INVALID_LENGTH ); \
235 14 : return FD_VM_SYSCALL_ERR_INVALID_LENGTH; \
236 14 : } \
237 30509 : void const * haddr = 0UL; \
238 30495 : if ( FD_LIKELY( (ulong)sz > 0UL ) ) { \
239 87109 : haddr = FD_VM_MEM_HADDR_LD( vm, vaddr, align, sz ); \
240 87109 : } \
241 30495 : haddr; \
242 30349 : }))
243 :
244 8546 : #define FD_VM_MEM_SLICE_HADDR_ST( vm, vaddr, align, sz ) (__extension__({ \
245 8546 : if ( FD_UNLIKELY( sz > LONG_MAX ) ) { \
246 0 : FD_VM_ERR_FOR_LOG_SYSCALL( vm, FD_VM_SYSCALL_ERR_INVALID_LENGTH ); \
247 0 : return FD_VM_SYSCALL_ERR_INVALID_LENGTH; \
248 0 : } \
249 8546 : void * haddr = 0UL; \
250 8546 : if ( FD_LIKELY( (ulong)sz > 0UL ) ) { \
251 8210 : haddr = FD_VM_MEM_HADDR_ST( vm, vaddr, align, sz ); \
252 8210 : } \
253 8546 : haddr; \
254 8546 : }))
255 :
256 : /* FIXME: use overlap logic from runtime? */
257 1925 : #define FD_VM_MEM_CHECK_NON_OVERLAPPING( vm, addr0, sz0, addr1, sz1 ) do { \
258 1925 : if( FD_UNLIKELY(( ((addr0> addr1) && (fd_ulong_sat_sub(addr0, addr1) < sz1)) ) || \
259 1925 : ( ((addr1>=addr0) && (fd_ulong_sat_sub(addr1, addr0) < sz0)) ) )) { \
260 9 : FD_VM_ERR_FOR_LOG_SYSCALL( vm, FD_VM_SYSCALL_ERR_COPY_OVERLAPPING ); \
261 9 : return FD_VM_SYSCALL_ERR_COPY_OVERLAPPING; \
262 9 : } \
263 1925 : } while(0)
264 :
265 : /* https://github.com/anza-xyz/agave/blob/v4.4.0-beta.0/syscalls/src/lib.rs#L630-L656 */
266 : static inline int
267 : fd_vm_mem_touch_st( fd_vm_t * vm,
268 : ulong vaddr,
269 11041 : ulong sz ) {
270 11041 : ulong haddr = fd_vm_mem_haddr( vm, vaddr, sz, vm->region_haddr, vm->region_st_sz, 1, 0UL );
271 11041 : if( FD_UNLIKELY( !haddr ) ) {
272 261 : vm->segv_vaddr = vaddr;
273 261 : vm->segv_access_len = sz;
274 261 : vm->segv_access_type = FD_VM_ACCESS_TYPE_ST;
275 261 : FD_VM_ERR_FOR_LOG_EBPF( vm, fd_vm_generate_access_violation( vaddr, vm->sbpf_version ) );
276 261 : return FD_VM_SYSCALL_ERR_SEGFAULT;
277 261 : }
278 10780 : return FD_VM_SUCCESS;
279 11041 : }
280 :
281 : /* Mimics Agave's `translate_mut!` macro by taking in a variable number
282 : of (vaddr, align, sz) entries and translates each of them, failing
283 : if any one of the translations fail, or if any of the vaddrs have
284 : overlapping haddr regions. The caller is responsible for creating
285 : each `fd_vm_haddr_query_t` object containing information about the
286 : vaddr, align, sz, and whether it is a slice. Takes in any number
287 : of queries, provided into the input as an array of pointers to each
288 : query. The translated haddr is written into the `haddr` field
289 : of each of the `fd_vm_haddr_query_t` objects on success.
290 :
291 : https://github.com/anza-xyz/agave/blob/v4.4.0-beta.0/syscalls/src/lib.rs#L662-L713 */
292 10753 : #define FD_VM_TRANSLATE_MUT( _vm, _queries ) do { \
293 10753 : ulong _n = sizeof(_queries)/sizeof(fd_vm_haddr_query_t *); \
294 10753 : /* https://github.com/anza-xyz/agave/blob/v4.4.0-beta.0/syscalls/src/lib.rs#L699 */ \
295 21565 : for( ulong i=0UL; i<(_n); i++ ) { \
296 11073 : fd_vm_haddr_query_t * query = _queries[i]; \
297 11073 : if( query->is_slice && !query->sz ) continue; \
298 11073 : int touch_err = fd_vm_mem_touch_st( _vm, query->vaddr, query->sz ); \
299 11042 : if( FD_UNLIKELY( touch_err ) ) return touch_err; \
300 11042 : } \
301 10753 : /* https://github.com/anza-xyz/agave/blob/v4.4.0-beta.0/syscalls/src/lib.rs#L700 */ \
302 21302 : for( ulong i=0UL; i<(_n); i++ ) { \
303 10810 : fd_vm_haddr_query_t * query = _queries[i]; \
304 10810 : if( query->is_slice ) { \
305 14862 : query->haddr = FD_VM_MEM_SLICE_HADDR_ST( _vm, query->vaddr, query->align, query->sz ); \
306 14862 : } else { \
307 3379 : query->haddr = FD_VM_MEM_HADDR_ST( _vm, query->vaddr, query->align, query->sz ); \
308 3379 : } \
309 10810 : } \
310 10492 : /* https://github.com/anza-xyz/agave/blob/v4.4.0-beta.0/syscalls/src/lib.rs#L701-L710 */ \
311 21307 : for( ulong i=0UL; i<(_n); i++ ) { \
312 10818 : fd_vm_haddr_query_t * query = _queries[i]; \
313 11136 : for( ulong j=0UL; j<i; j++ ) { \
314 321 : fd_vm_haddr_query_t * other_query = _queries[j]; \
315 321 : FD_VM_MEM_CHECK_NON_OVERLAPPING( _vm, (ulong)query->haddr, query->sz, (ulong)other_query->haddr, other_query->sz ); \
316 321 : } \
317 10818 : } \
318 10492 : } while(0)
319 :
320 : #endif /* HEADER_fd_src_flamenco_vm_syscall_fd_vm_syscall_macros_h */
|
