drd/tests/Makefile.am: Fix indentation
[valgrind.git] / coregrind / m_syswrap / priv_syswrap-linux.h
blob0cfe7823324d319996f2a42464c404d9f862f687
2 /*--------------------------------------------------------------------*/
3 /*--- Linux-specific syscalls stuff. priv_syswrap-linux.h ---*/
4 /*--------------------------------------------------------------------*/
6 /*
7 This file is part of Valgrind, a dynamic binary instrumentation
8 framework.
10 Copyright (C) 2000-2017 Nicholas Nethercote
11 njn@valgrind.org
13 This program is free software; you can redistribute it and/or
14 modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation; either version 2 of the
16 License, or (at your option) any later version.
18 This program is distributed in the hope that it will be useful, but
19 WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 General Public License for more details.
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, see <http://www.gnu.org/licenses/>.
26 The GNU General Public License is contained in the file COPYING.
29 #ifndef __PRIV_SYSWRAP_LINUX_H
30 #define __PRIV_SYSWRAP_LINUX_H
32 #include "pub_core_basics.h" // ThreadId
33 #include "priv_types_n_macros.h" // DECL_TEMPLATE
35 // Clone-related functions
36 extern Word ML_(start_thread_NORETURN) ( void* arg );
37 extern Addr ML_(allocstack) ( ThreadId tid );
38 extern void ML_(call_on_new_stack_0_1) ( Addr stack, Addr retaddr,
39 void (*f)(Word), Word arg1 );
41 // Linux-specific (but non-arch-specific) syscalls
43 DECL_TEMPLATE(linux, sys_clone)
44 DECL_TEMPLATE(linux, sys_mount);
45 DECL_TEMPLATE(linux, sys_oldumount);
46 DECL_TEMPLATE(linux, sys_umount);
47 DECL_TEMPLATE(linux, sys_perf_event_open);
48 DECL_TEMPLATE(linux, sys_preadv);
49 DECL_TEMPLATE(linux, sys_preadv2);
50 DECL_TEMPLATE(linux, sys_pwritev);
51 DECL_TEMPLATE(linux, sys_pwritev2);
52 DECL_TEMPLATE(linux, sys_sendmmsg);
53 DECL_TEMPLATE(linux, sys_recvmmsg);
54 DECL_TEMPLATE(linux, sys_dup3);
55 DECL_TEMPLATE(linux, sys_getcpu);
56 DECL_TEMPLATE(linux, sys_splice);
57 DECL_TEMPLATE(linux, sys_tee);
58 DECL_TEMPLATE(linux, sys_vmsplice);
59 DECL_TEMPLATE(linux, sys_readahead);
60 DECL_TEMPLATE(linux, sys_move_pages);
62 // clone is similar enough between linux variants to have a generic
63 // version, but which will call an extern defined in syswrap-<platform>-linux.c
64 DECL_TEMPLATE(linux, sys_clone);
66 // POSIX, but various sub-cases differ between Linux and Darwin.
67 DECL_TEMPLATE(linux, sys_fcntl);
68 DECL_TEMPLATE(linux, sys_fcntl64);
69 DECL_TEMPLATE(linux, sys_ioctl);
71 DECL_TEMPLATE(linux, sys_setfsuid16);
72 DECL_TEMPLATE(linux, sys_setfsuid);
73 DECL_TEMPLATE(linux, sys_setfsgid16);
74 DECL_TEMPLATE(linux, sys_setfsgid);
75 DECL_TEMPLATE(linux, sys_setresuid16); // man page says "non-standard";
76 DECL_TEMPLATE(linux, sys_setresuid); // man page says "non-standard"
77 DECL_TEMPLATE(linux, sys_getresuid16);
78 DECL_TEMPLATE(linux, sys_getresuid);
79 DECL_TEMPLATE(linux, sys_setresgid16); // man page says "non-standard"
80 DECL_TEMPLATE(linux, sys_setresgid); // man page says "non-standard"
81 DECL_TEMPLATE(linux, sys_getresgid16);
82 DECL_TEMPLATE(linux, sys_getresgid);
84 DECL_TEMPLATE(linux, sys_exit_group);
85 DECL_TEMPLATE(linux, sys_llseek);
86 DECL_TEMPLATE(linux, sys_adjtimex);
87 DECL_TEMPLATE(linux, sys_ioperm);
88 DECL_TEMPLATE(linux, sys_syslog);
89 DECL_TEMPLATE(linux, sys_vhangup);
90 DECL_TEMPLATE(linux, sys_sysinfo);
91 DECL_TEMPLATE(linux, sys_personality);
92 DECL_TEMPLATE(linux, sys_pivot_root);
93 DECL_TEMPLATE(linux, sys_sysctl);
94 DECL_TEMPLATE(linux, sys_prctl);
95 DECL_TEMPLATE(linux, sys_sendfile);
96 DECL_TEMPLATE(linux, sys_sendfile64);
97 DECL_TEMPLATE(linux, sys_futex);
98 DECL_TEMPLATE(linux, sys_set_robust_list);
99 DECL_TEMPLATE(linux, sys_get_robust_list);
100 DECL_TEMPLATE(linux, sys_pselect6);
101 DECL_TEMPLATE(linux, sys_ppoll);
103 DECL_TEMPLATE(linux, sys_epoll_create);
104 DECL_TEMPLATE(linux, sys_epoll_create1);
105 DECL_TEMPLATE(linux, sys_epoll_ctl);
106 DECL_TEMPLATE(linux, sys_epoll_wait);
107 DECL_TEMPLATE(linux, sys_epoll_pwait);
108 DECL_TEMPLATE(linux, sys_eventfd);
109 DECL_TEMPLATE(linux, sys_eventfd2);
111 DECL_TEMPLATE(linux, sys_fallocate);
113 DECL_TEMPLATE(linux, sys_prlimit64);
115 DECL_TEMPLATE(linux, sys_gettid);
116 DECL_TEMPLATE(linux, sys_set_tid_address);
117 DECL_TEMPLATE(linux, sys_tkill);
118 DECL_TEMPLATE(linux, sys_tgkill);
120 DECL_TEMPLATE(linux, sys_fadvise64);
121 DECL_TEMPLATE(linux, sys_fadvise64_64);
123 DECL_TEMPLATE(linux, sys_io_setup);
124 DECL_TEMPLATE(linux, sys_io_destroy);
125 DECL_TEMPLATE(linux, sys_io_getevents);
126 DECL_TEMPLATE(linux, sys_io_submit);
127 DECL_TEMPLATE(linux, sys_io_cancel);
129 DECL_TEMPLATE(linux, sys_ioprio_set);
130 DECL_TEMPLATE(linux, sys_ioprio_get);
132 DECL_TEMPLATE(linux, sys_mbind);
133 DECL_TEMPLATE(linux, sys_set_mempolicy);
134 DECL_TEMPLATE(linux, sys_get_mempolicy);
136 DECL_TEMPLATE(linux, sys_inotify_init);
137 DECL_TEMPLATE(linux, sys_inotify_init1);
138 DECL_TEMPLATE(linux, sys_inotify_add_watch);
139 DECL_TEMPLATE(linux, sys_inotify_rm_watch);
141 DECL_TEMPLATE(linux, sys_mq_open);
142 DECL_TEMPLATE(linux, sys_mq_unlink);
143 DECL_TEMPLATE(linux, sys_mq_timedsend);
144 DECL_TEMPLATE(linux, sys_mq_timedreceive);
145 DECL_TEMPLATE(linux, sys_mq_notify);
146 DECL_TEMPLATE(linux, sys_mq_getsetattr);
148 DECL_TEMPLATE(linux, sys_clock_settime);
149 DECL_TEMPLATE(linux, sys_clock_gettime);
150 DECL_TEMPLATE(linux, sys_clock_getres);
151 DECL_TEMPLATE(linux, sys_clock_nanosleep);
152 DECL_TEMPLATE(linux, sys_clock_adjtime);
154 DECL_TEMPLATE(linux, sys_timer_create); // Linux: varies across archs?
155 DECL_TEMPLATE(linux, sys_timer_settime);
156 DECL_TEMPLATE(linux, sys_timer_gettime);
157 DECL_TEMPLATE(linux, sys_timer_getoverrun);
158 DECL_TEMPLATE(linux, sys_timer_delete);
159 DECL_TEMPLATE(linux, sys_timerfd_create);
160 DECL_TEMPLATE(linux, sys_timerfd_gettime);
161 DECL_TEMPLATE(linux, sys_timerfd_settime);
163 DECL_TEMPLATE(linux, sys_signalfd);
164 DECL_TEMPLATE(linux, sys_signalfd4);
166 DECL_TEMPLATE(linux, sys_capget);
167 DECL_TEMPLATE(linux, sys_capset);
169 DECL_TEMPLATE(linux, sys_openat);
170 DECL_TEMPLATE(linux, sys_mkdirat);
171 DECL_TEMPLATE(linux, sys_mknodat);
172 DECL_TEMPLATE(linux, sys_fchownat);
173 DECL_TEMPLATE(linux, sys_futimesat);
174 DECL_TEMPLATE(linux, sys_newfstatat);
175 DECL_TEMPLATE(linux, sys_unlinkat);
176 DECL_TEMPLATE(linux, sys_renameat);
177 DECL_TEMPLATE(linux, sys_renameat2);
178 DECL_TEMPLATE(linux, sys_linkat);
179 DECL_TEMPLATE(linux, sys_symlinkat);
180 DECL_TEMPLATE(linux, sys_readlinkat);
181 DECL_TEMPLATE(linux, sys_fchmodat);
182 DECL_TEMPLATE(linux, sys_faccessat);
183 DECL_TEMPLATE(linux, sys_utimensat);
184 DECL_TEMPLATE(linux, sys_name_to_handle_at);
185 DECL_TEMPLATE(linux, sys_open_by_handle_at);
187 DECL_TEMPLATE(linux, sys_add_key);
188 DECL_TEMPLATE(linux, sys_request_key);
189 DECL_TEMPLATE(linux, sys_keyctl);
191 // These ones have 32-bit generic equivalents, but the 16-bit versions (they
192 // use 16-bit gid_t and uid_t types) seem to be Linux-specific.
193 DECL_TEMPLATE(linux, sys_getuid16);
194 DECL_TEMPLATE(linux, sys_setuid16);
195 DECL_TEMPLATE(linux, sys_getgid16);
196 DECL_TEMPLATE(linux, sys_setgid16);
197 DECL_TEMPLATE(linux, sys_geteuid16);
198 DECL_TEMPLATE(linux, sys_getegid16);
199 DECL_TEMPLATE(linux, sys_setreuid16);
200 DECL_TEMPLATE(linux, sys_setregid16);
201 DECL_TEMPLATE(linux, sys_getgroups16);
202 DECL_TEMPLATE(linux, sys_setgroups16);
204 // Again, these 16-bit versions are Linux-specific, the 32-bit versions are
205 // generic.
206 DECL_TEMPLATE(linux, sys_chown16);
207 DECL_TEMPLATE(linux, sys_fchown16);
208 //DECL_TEMPLATE(linux, sys_lchown16); // not yet encountered
210 // Are these POSIX? In Darwin they have an extra parameter 'position',
211 // so put them here.
212 DECL_TEMPLATE(linux, sys_setxattr);
213 DECL_TEMPLATE(linux, sys_lsetxattr);
214 DECL_TEMPLATE(linux, sys_fsetxattr);
215 DECL_TEMPLATE(linux, sys_getxattr);
216 DECL_TEMPLATE(linux, sys_lgetxattr);
217 DECL_TEMPLATE(linux, sys_fgetxattr);
218 DECL_TEMPLATE(linux, sys_listxattr);
219 DECL_TEMPLATE(linux, sys_llistxattr);
220 DECL_TEMPLATE(linux, sys_flistxattr);
221 DECL_TEMPLATE(linux, sys_removexattr);
222 DECL_TEMPLATE(linux, sys_lremovexattr);
223 DECL_TEMPLATE(linux, sys_fremovexattr);
225 // These are Posix, but not necessarily syscalls. Darwin only supports
226 // sched_get_priority_{min,max} and sched_yield, but as libc functions, not
227 // syscalls.
228 DECL_TEMPLATE(linux, sys_sched_setparam);
229 DECL_TEMPLATE(linux, sys_sched_getparam);
230 DECL_TEMPLATE(linux, sys_sched_setscheduler);
231 DECL_TEMPLATE(linux, sys_sched_getscheduler);
232 DECL_TEMPLATE(linux, sys_sched_yield);
233 DECL_TEMPLATE(linux, sys_sched_get_priority_max);
234 DECL_TEMPLATE(linux, sys_sched_get_priority_min);
235 DECL_TEMPLATE(linux, sys_sched_rr_get_interval);
236 DECL_TEMPLATE(linux, sys_sched_setaffinity);
237 DECL_TEMPLATE(linux, sys_sched_getaffinity);
239 DECL_TEMPLATE(linux, sys_unshare);
241 // These ones have different parameters and/or return values on Darwin.
242 // Also, some archs on Linux do not match the generic wrapper for sys_pipe.
243 DECL_TEMPLATE(linux, sys_munlockall);
244 DECL_TEMPLATE(linux, sys_pipe);
245 DECL_TEMPLATE(linux, sys_pipe2);
246 DECL_TEMPLATE(linux, sys_quotactl);
247 DECL_TEMPLATE(linux, sys_waitid);
249 // Posix, but in Darwin utime is a libc function that calls syscall utimes.
250 DECL_TEMPLATE(linux, sys_utime);
252 // On Darwin, off_t is 64-bits even on 32-bit platforms.
253 DECL_TEMPLATE(linux, sys_lseek);
255 // Darwin (and probably other OSes) don't have the old_sigset_t type.
256 DECL_TEMPLATE(linux, sys_sigpending);
257 DECL_TEMPLATE(linux, sys_sigprocmask);
258 DECL_TEMPLATE(linux, sys_sigaction);
260 // I think these are Linux-specific?
261 DECL_TEMPLATE(linux, sys_rt_sigaction);
262 DECL_TEMPLATE(linux, sys_rt_sigprocmask);
263 DECL_TEMPLATE(linux, sys_rt_sigpending);
264 DECL_TEMPLATE(linux, sys_rt_sigtimedwait);
265 DECL_TEMPLATE(linux, sys_rt_sigqueueinfo);
266 DECL_TEMPLATE(linux, sys_rt_tgsigqueueinfo);
267 DECL_TEMPLATE(linux, sys_rt_sigsuspend);
269 // Linux-specific?
270 DECL_TEMPLATE(linux, sys_sync_file_range);
271 DECL_TEMPLATE(linux, sys_sync_file_range2);
272 DECL_TEMPLATE(linux, sys_stime); /* maybe generic? I'm not sure */
274 // Linux specific (kernel modules)
275 DECL_TEMPLATE(linux, sys_init_module);
276 DECL_TEMPLATE(linux, sys_finit_module);
277 DECL_TEMPLATE(linux, sys_delete_module);
279 // Linux-specific (oprofile-related)
280 DECL_TEMPLATE(linux, sys_lookup_dcookie); // (*/32/64) L
282 // Linux-specific (new in Linux 3.2)
283 DECL_TEMPLATE(linux, sys_process_vm_readv);
284 DECL_TEMPLATE(linux, sys_process_vm_writev);
286 // Linux-specific (new in Linux 2.6.36)
287 DECL_TEMPLATE(linux, sys_fanotify_init);
288 DECL_TEMPLATE(linux, sys_fanotify_mark);
290 // Linux-specific (new in Linux 3.17)
291 DECL_TEMPLATE(linux, sys_getrandom);
292 DECL_TEMPLATE(linux, sys_memfd_create);
294 DECL_TEMPLATE(linux, sys_syncfs);
296 DECL_TEMPLATE(linux, sys_membarrier);
298 // Linux-specific (new in Linux 3.18)
299 DECL_TEMPLATE(linux, sys_bpf);
301 // Linux-specific (new in Linux 4.11)
302 DECL_TEMPLATE(linux, sys_statx);
304 // Linux-specific memory protection key syscalls (since Linux 4.9)
305 DECL_TEMPLATE(linux, sys_pkey_alloc);
306 DECL_TEMPLATE(linux, sys_pkey_free);
307 DECL_TEMPLATE(linux, sys_pkey_mprotect);
309 // Linux io_uring system calls. See also commit 2b188cc1bb85 ("Add io_uring IO
310 // interface") # v5.1. See also commit edafccee56ff ("io_uring: add support
311 // for pre-mapped user IO buffers") # v5.1.
312 DECL_TEMPLATE(linux, sys_io_uring_setup);
313 DECL_TEMPLATE(linux, sys_io_uring_enter);
314 DECL_TEMPLATE(linux, sys_io_uring_register);
316 /* ---------------------------------------------------------------------
317 Wrappers for sockets and ipc-ery. These are split into standalone
318 procedures because x86-linux hides them inside multiplexors
319 (sys_socketcall and sys_ipc).
320 ------------------------------------------------------------------ */
322 #define TId ThreadId
323 #define UW UWord
324 #define SR SysRes
326 extern void ML_(linux_PRE_sys_msgsnd) ( TId, UW, UW, UW, UW );
327 extern void ML_(linux_PRE_sys_msgrcv) ( TId, UW, UW, UW, UW, UW );
328 extern void ML_(linux_POST_sys_msgrcv) ( TId, UW, UW, UW, UW, UW, UW );
329 extern void ML_(linux_PRE_sys_msgctl) ( TId, UW, UW, UW );
330 extern void ML_(linux_POST_sys_msgctl) ( TId, UW, UW, UW, UW );
331 extern void ML_(linux_PRE_sys_getsockopt) ( TId, UW, UW, UW, UW, UW );
332 extern void ML_(linux_POST_sys_getsockopt) ( TId, SR, UW, UW, UW, UW, UW );
333 extern void ML_(linux_PRE_sys_setsockopt) ( TId, UW, UW, UW, UW, UW );
334 extern void ML_(linux_PRE_sys_recvmmsg) ( TId, UW, UW, UW, UW, UW );
335 extern void ML_(linux_POST_sys_recvmmsg) ( TId, UW, UW, UW, UW, UW, UW );
336 extern void ML_(linux_PRE_sys_sendmmsg) ( TId, UW, UW, UW, UW );
337 extern void ML_(linux_POST_sys_sendmmsg) ( TId, UW, UW, UW, UW, UW );
339 // Linux-specific (but non-arch-specific) ptrace wrapper helpers
340 extern void ML_(linux_PRE_getregset) ( ThreadId, long, long );
341 extern void ML_(linux_PRE_setregset) ( ThreadId, long, long );
342 extern void ML_(linux_POST_traceme) ( ThreadId );
343 extern void ML_(linux_POST_getregset)( ThreadId, long, long );
345 #undef TId
346 #undef UW
347 #undef SR
349 /* sys_ipc and sys_socketcall are multiplexors which implements several syscalls.
350 Used e.g. by x86, ppc32, ppc64, ... */
351 DECL_TEMPLATE(linux, sys_ipc);
352 DECL_TEMPLATE(linux, sys_socketcall);
354 /* Depending on the platform, the below are implemented as
355 direct syscalls or via the above sys_socketcall multiplexor. */
357 /* Direct ipc related syscalls. */
358 /* Semaphore */
359 DECL_TEMPLATE(linux, sys_semget);
360 DECL_TEMPLATE(linux, sys_semop);
361 DECL_TEMPLATE(linux, sys_semctl);
362 DECL_TEMPLATE(linux, sys_semtimedop);
363 /* Shared memory */
364 DECL_TEMPLATE(linux, sys_shmat);
365 DECL_TEMPLATE(linux, sys_shmget);
366 DECL_TEMPLATE(linux, sys_shmdt);
367 DECL_TEMPLATE(linux, sys_shmctl);
368 /* Message queue */
369 DECL_TEMPLATE(linux, sys_msgget);
370 DECL_TEMPLATE(linux, sys_msgrcv);
371 DECL_TEMPLATE(linux, sys_msgsnd);
372 DECL_TEMPLATE(linux, sys_msgctl);
374 /* Direct socket related syscalls. */
375 DECL_TEMPLATE(linux, sys_socket);
376 DECL_TEMPLATE(linux, sys_setsockopt);
377 DECL_TEMPLATE(linux, sys_getsockopt);
378 DECL_TEMPLATE(linux, sys_connect);
379 DECL_TEMPLATE(linux, sys_accept);
380 DECL_TEMPLATE(linux, sys_accept4);
381 DECL_TEMPLATE(linux, sys_send);
382 DECL_TEMPLATE(linux, sys_sendto);
383 DECL_TEMPLATE(linux, sys_recv);
384 DECL_TEMPLATE(linux, sys_recvfrom);
385 DECL_TEMPLATE(linux, sys_sendmsg);
386 DECL_TEMPLATE(linux, sys_recvmsg);
387 DECL_TEMPLATE(linux, sys_shutdown);
388 DECL_TEMPLATE(linux, sys_bind);
389 DECL_TEMPLATE(linux, sys_listen);
390 DECL_TEMPLATE(linux, sys_getsockname);
391 DECL_TEMPLATE(linux, sys_getpeername);
392 DECL_TEMPLATE(linux, sys_socketpair);
393 DECL_TEMPLATE(linux, sys_kcmp);
394 DECL_TEMPLATE(linux, sys_copy_file_range);
396 // Some arch specific functions called from syswrap-linux.c
397 extern Int do_syscall_clone_x86_linux ( Word (*fn)(void *),
398 void* stack,
399 Int flags,
400 void* arg,
401 Int* child_tid,
402 Int* parent_tid,
403 void* tls_ptr);
404 extern SysRes ML_(x86_sys_set_thread_area) ( ThreadId tid,
405 vki_modify_ldt_t* info );
406 extern void ML_(x86_setup_LDT_GDT) ( /*OUT*/ ThreadArchState *child,
407 /*IN*/ ThreadArchState *parent );
409 extern Long do_syscall_clone_amd64_linux ( Word (*fn)(void *),
410 void* stack,
411 Long flags,
412 void* arg,
413 Int* child_tid,
414 Int* parent_tid,
415 void* tls_ptr);
416 extern ULong do_syscall_clone_ppc32_linux ( Word (*fn)(void *),
417 void* stack,
418 Int flags,
419 void* arg,
420 Int* child_tid,
421 Int* parent_tid,
422 void* tls_ptr);
423 extern ULong do_syscall_clone_ppc64_linux ( Word (*fn)(void *),
424 void* stack,
425 Int flags,
426 void* arg,
427 Int* child_tid,
428 Int* parent_tid,
429 void* tls_ptr );
430 extern ULong do_syscall_clone_s390x_linux ( void *stack,
431 ULong flags,
432 Int *parent_tid,
433 Int *child_tid,
434 void* tls_ptr,
435 Word (*fn)(void *),
436 void *arg);
437 extern Long do_syscall_clone_arm64_linux ( Word (*fn)(void *),
438 void* stack,
439 Long flags,
440 void* arg,
441 Int* child_tid,
442 Int* parent_tid,
443 void* tls_ptr );
444 extern ULong do_syscall_clone_arm_linux ( Word (*fn)(void *),
445 void* stack,
446 Int flags,
447 void* arg,
448 Int* child_tid,
449 Int* parent_tid,
450 void* tls_ptr );
451 extern ULong do_syscall_clone_mips64_linux ( Word (*fn) (void *), /* a0 - 4 */
452 void* stack, /* a1 - 5 */
453 Int flags, /* a2 - 6 */
454 void* arg, /* a3 - 7 */
455 Int* parent_tid, /* a4 - 8 */
456 void* tls_ptr, /* a5 - 9 */
457 Int* child_tid ); /* a6 - 10 */
458 extern UInt do_syscall_clone_mips_linux ( Word (*fn) (void *), //a0 0 32
459 void* stack, //a1 4 36
460 Int flags, //a2 8 40
461 void* arg, //a3 12 44
462 Int* child_tid, //stack 16 48
463 Int* parent_tid, //stack 20 52
464 void* tls_ptr); //stack 24 56
465 extern UInt do_syscall_clone_nanomips_linux ( Word (*fn) (void *), /* a0 - 4 */
466 void* stack, /* a1 - 5 */
467 Int flags, /* a2 - 6 */
468 void* arg, /* a3 - 7 */
469 Int* child_tid, /* a4 - 8 */
470 Int* parent_tid, /* a5 - 9 */
471 void* tls_ptr); /* a6 - 10 */
472 #endif // __PRIV_SYSWRAP_LINUX_H
474 /*--------------------------------------------------------------------*/
475 /*--- end ---*/
476 /*--------------------------------------------------------------------*/