]> granicus.if.org Git - strace/blob - defs.h
netlink: introduce NETLINK_NETFILTER parser
[strace] / defs.h
1 /*
2  * Copyright (c) 1991, 1992 Paul Kranenburg <pk@cs.few.eur.nl>
3  * Copyright (c) 1993 Branko Lankester <branko@hacktic.nl>
4  * Copyright (c) 1993, 1994, 1995, 1996 Rick Sladkey <jrs@world.std.com>
5  * Copyright (c) 2001-2018 The strace developers.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef STRACE_DEFS_H
32 #define STRACE_DEFS_H
33
34 #ifdef HAVE_CONFIG_H
35 # include "config.h"
36 #endif
37
38 #include <features.h>
39 #include <stdbool.h>
40 #include <stdint.h>
41 #include <inttypes.h>
42 #include <sys/types.h>
43 #include <stddef.h>
44 #include <unistd.h>
45 #include <stdlib.h>
46 #include <stdio.h>
47 /* Open-coding isprint(ch) et al proved more efficient than calling
48  * generalized libc interface. We don't *want* to do non-ASCII anyway.
49  */
50 /* #include <ctype.h> */
51 #include <string.h>
52 #include <errno.h>
53 #include <time.h>
54 #include <sys/time.h>
55
56 #include "arch_defs.h"
57 #include "error_prints.h"
58 #include "gcc_compat.h"
59 #include "kernel_types.h"
60 #include "macros.h"
61 #include "mpers_type.h"
62 #include "string_to_uint.h"
63 #include "sysent.h"
64 #include "xmalloc.h"
65
66 #ifndef HAVE_STRERROR
67 const char *strerror(int);
68 #endif
69 #ifndef HAVE_STPCPY
70 /* Some libc have stpcpy, some don't. Sigh...
71  * Roll our private implementation...
72  */
73 #undef stpcpy
74 #define stpcpy strace_stpcpy
75 extern char *stpcpy(char *dst, const char *src);
76 #endif
77
78 /* Glibc has an efficient macro for sigemptyset
79  * (it just does one or two assignments of 0 to internal vector of longs).
80  */
81 #if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset)
82 # define sigemptyset __sigemptyset
83 #endif
84
85 /* Configuration section */
86 #ifndef DEFAULT_STRLEN
87 /* default maximum # of bytes printed in `printstr', change with -s switch */
88 # define DEFAULT_STRLEN 32
89 #endif
90 #ifndef DEFAULT_ACOLUMN
91 # define DEFAULT_ACOLUMN        40      /* default alignment column for results */
92 #endif
93 /*
94  * Maximum number of args to a syscall.
95  *
96  * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
97  * linux/<ARCH>/syscallent*.h:
98  *      all have nargs <= 6 except mips o32 which has nargs <= 7.
99  */
100 #ifndef MAX_ARGS
101 # ifdef LINUX_MIPSO32
102 #  define MAX_ARGS      7
103 # else
104 #  define MAX_ARGS      6
105 # endif
106 #endif
107 /* default sorting method for call profiling */
108 #ifndef DEFAULT_SORTBY
109 # define DEFAULT_SORTBY "time"
110 #endif
111 /*
112  * Experimental code using PTRACE_SEIZE can be enabled here.
113  * This needs Linux kernel 3.4.x or later to work.
114  */
115 #define USE_SEIZE 1
116 /* To force NOMMU build, set to 1 */
117 #define NOMMU_SYSTEM 0
118
119 #ifndef ERESTARTSYS
120 # define ERESTARTSYS    512
121 #endif
122 #ifndef ERESTARTNOINTR
123 # define ERESTARTNOINTR 513
124 #endif
125 #ifndef ERESTARTNOHAND
126 # define ERESTARTNOHAND 514
127 #endif
128 #ifndef ERESTART_RESTARTBLOCK
129 # define ERESTART_RESTARTBLOCK 516
130 #endif
131
132 #define PERSONALITY0_WORDSIZE  SIZEOF_LONG
133 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
134 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
135 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
136
137 #if SUPPORTED_PERSONALITIES > 1
138 # define PERSONALITY1_WORDSIZE  4
139 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
140 #endif
141
142 #if SUPPORTED_PERSONALITIES > 2
143 # define PERSONALITY2_WORDSIZE  4
144 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
145 #endif
146
147 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
148 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
149 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
150 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
151 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
152 # define HAVE_PERSONALITY_1_MPERS 1
153 #else
154 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
155 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
156 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
157 # define HAVE_PERSONALITY_1_MPERS 0
158 #endif
159
160 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
161 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
162 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
163 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
164 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
165 # define HAVE_PERSONALITY_2_MPERS 1
166 #else
167 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
168 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
169 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
170 # define HAVE_PERSONALITY_2_MPERS 0
171 #endif
172
173 typedef struct ioctlent {
174         const char *symbol;
175         unsigned int code;
176 } struct_ioctlent;
177
178 #define INJECT_F_SIGNAL 1
179 #define INJECT_F_RETVAL 2
180
181 struct inject_data {
182         uint8_t flags;          /* only 2 of 8 flags are used so far */
183         uint8_t signo;          /* NSIG <= 128 */
184         uint16_t reserved;
185         kernel_long_t rval;
186 };
187
188 struct inject_opts {
189         uint16_t first;
190         uint16_t step;
191         struct inject_data data;
192 };
193
194 #define MAX_ERRNO_VALUE                 4095
195
196 /* Trace Control Block */
197 struct tcb {
198         int flags;              /* See below for TCB_ values */
199         int pid;                /* If 0, this tcb is free */
200         int qual_flg;           /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
201         unsigned long u_error;  /* Error code */
202         kernel_ulong_t scno;    /* System call number */
203         kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
204         kernel_long_t u_rval;   /* Return value */
205 #if SUPPORTED_PERSONALITIES > 1
206         unsigned int currpers;  /* Personality at the time of scno update */
207 #endif
208         int sys_func_rval;      /* Syscall entry parser's return value */
209         int curcol;             /* Output column for this process */
210         FILE *outf;             /* Output file for this process */
211         const char *auxstr;     /* Auxiliary info from syscall (see RVAL_STR) */
212         void *_priv_data;       /* Private data for syscall decoding functions */
213         void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
214         const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
215         const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
216         struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
217         struct timeval stime;   /* System time usage as of last process wait */
218         struct timeval dtime;   /* Delta for system time usage */
219         struct timeval etime;   /* Syscall entry time */
220
221         struct mmap_cache_t *mmap_cache;
222         unsigned int mmap_cache_size;
223         unsigned int mmap_cache_generation;
224
225 #ifdef USE_LIBUNWIND
226         struct UPT_info *libunwind_ui;
227         struct queue_t *queue;
228 #endif
229 };
230
231 /* TCB flags */
232 /* We have attached to this process, but did not see it stopping yet */
233 #define TCB_STARTUP             0x01
234 #define TCB_IGNORE_ONE_SIGSTOP  0x02    /* Next SIGSTOP is to be ignored */
235 /*
236  * Are we in system call entry or in syscall exit?
237  *
238  * This bit is set in syscall_entering_finish() and cleared in
239  * syscall_exiting_finish().
240  * Other stops which are possible directly after syscall entry (death, ptrace
241  * event stop) are handled without calling syscall_{entering,exiting}_*().
242  *
243  * Use entering(tcp) / exiting(tcp) to check this bit to make code more
244  * readable.
245  */
246 #define TCB_INSYSCALL   0x04
247 #define TCB_ATTACHED    0x08    /* We attached to it already */
248 #define TCB_REPRINT     0x10    /* We should reprint this syscall on exit */
249 #define TCB_FILTERED    0x20    /* This system call has been filtered out */
250 #define TCB_TAMPERED    0x40    /* A syscall has been tampered with */
251 #define TCB_HIDE_LOG    0x80    /* We should hide everything (until execve) */
252 #define TCB_SKIP_DETACH_ON_FIRST_EXEC   0x100   /* -b execve should skip detach on first execve */
253 #define TCB_GRABBED     0x200   /* We grab the process and can catch it
254                                  * in the middle of a syscall */
255 #define TCB_RECOVERING  0x400   /* We try to recover after detecting incorrect
256                                  * syscall entering/exiting state */
257
258 /* qualifier flags */
259 #define QUAL_TRACE      0x001   /* this system call should be traced */
260 #define QUAL_ABBREV     0x002   /* abbreviate the structures of this syscall */
261 #define QUAL_VERBOSE    0x004   /* decode the structures of this syscall */
262 #define QUAL_RAW        0x008   /* print all args in hex for this syscall */
263 #define QUAL_INJECT     0x010   /* tamper with this system call on purpose */
264
265 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
266
267 #define entering(tcp)   (!((tcp)->flags & TCB_INSYSCALL))
268 #define exiting(tcp)    ((tcp)->flags & TCB_INSYSCALL)
269 #define syserror(tcp)   ((tcp)->u_error != 0)
270 #define traced(tcp)     ((tcp)->qual_flg & QUAL_TRACE)
271 #define verbose(tcp)    ((tcp)->qual_flg & QUAL_VERBOSE)
272 #define abbrev(tcp)     ((tcp)->qual_flg & QUAL_ABBREV)
273 #define raw(tcp)        ((tcp)->qual_flg & QUAL_RAW)
274 #define inject(tcp)     ((tcp)->qual_flg & QUAL_INJECT)
275 #define filtered(tcp)   ((tcp)->flags & TCB_FILTERED)
276 #define hide_log(tcp)   ((tcp)->flags & TCB_HIDE_LOG)
277 #define syscall_tampered(tcp)   ((tcp)->flags & TCB_TAMPERED)
278 #define recovering(tcp) ((tcp)->flags & TCB_RECOVERING)
279
280 #include "xlat.h"
281
282 extern const struct xlat addrfams[];
283 extern const struct xlat arp_hardware_types[];
284 extern const struct xlat at_flags[];
285 extern const struct xlat clocknames[];
286 extern const struct xlat dirent_types[];
287
288 /** Ethernet protocols list, sorted and unterminated, defined in sockaddr.c. */
289 extern const struct xlat ethernet_protocols[];
290 /** Ethernet protocols array size without terminating record. */
291 extern const size_t ethernet_protocols_size;
292
293 extern const struct xlat evdev_abs[];
294 extern const struct xlat iffflags[];
295 extern const struct xlat inet_protocols[];
296 extern const struct xlat ip_type_of_services[];
297 extern const struct xlat msg_flags[];
298 extern const struct xlat netlink_protocols[];
299 extern const struct xlat nl_route_types[];
300 extern const struct xlat open_access_modes[];
301 extern const struct xlat open_mode_flags[];
302 extern const struct xlat resource_flags[];
303 extern const struct xlat routing_scopes[];
304 extern const struct xlat routing_table_ids[];
305 extern const struct xlat routing_types[];
306 extern const struct xlat seccomp_filter_flags[];
307 extern const struct xlat seccomp_ret_action[];
308 extern const struct xlat setns_types[];
309 extern const struct xlat sg_io_info[];
310 extern const struct xlat socketlayers[];
311 extern const struct xlat socktypes[];
312 extern const struct xlat tcp_state_flags[];
313 extern const struct xlat tcp_states[];
314 extern const struct xlat whence_codes[];
315
316 /* Format of syscall return values */
317 #define RVAL_DECIMAL    000     /* decimal format */
318 #define RVAL_HEX        001     /* hex format */
319 #define RVAL_OCTAL      002     /* octal format */
320 #define RVAL_UDECIMAL   003     /* unsigned decimal format */
321 #define RVAL_FD         010     /* file descriptor */
322 #define RVAL_MASK       013     /* mask for these values */
323
324 #define RVAL_STR        020     /* Print `auxstr' field after return val */
325 #define RVAL_NONE       040     /* Print nothing */
326
327 #define RVAL_DECODED    0100    /* syscall decoding finished */
328 #define RVAL_IOCTL_DECODED 0200 /* ioctl sub-parser successfully decoded
329                                    the argument */
330 #define RVAL_PRINT_ERR_VAL 0400 /* Print decoded error code along with
331                                    syscall return value.  Needed for modify_ldt
332                                    that for some reason decides to return
333                                    an error with higher bits set to 0.  */
334
335 #define IOCTL_NUMBER_UNKNOWN 0
336 #define IOCTL_NUMBER_HANDLED 1
337 #define IOCTL_NUMBER_STOP_LOOKUP 010
338
339 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
340
341 enum sock_proto {
342         SOCK_PROTO_UNKNOWN,
343         SOCK_PROTO_UNIX,
344         SOCK_PROTO_TCP,
345         SOCK_PROTO_UDP,
346         SOCK_PROTO_TCPv6,
347         SOCK_PROTO_UDPv6,
348         SOCK_PROTO_NETLINK
349 };
350 extern enum sock_proto get_proto_by_name(const char *);
351
352 enum iov_decode {
353         IOV_DECODE_ADDR,
354         IOV_DECODE_STR,
355         IOV_DECODE_NETLINK
356 };
357
358 typedef enum {
359         CFLAG_NONE = 0,
360         CFLAG_ONLY_STATS,
361         CFLAG_BOTH
362 } cflag_t;
363 extern cflag_t cflag;
364 extern bool Tflag;
365 extern bool iflag;
366 extern bool count_wallclock;
367 extern unsigned int qflag;
368 extern bool not_failing_only;
369 extern unsigned int show_fd_path;
370 /* are we filtering traces based on paths? */
371 extern struct path_set {
372         const char **paths_selected;
373         size_t num_selected;
374         size_t size;
375 } global_path_set;
376 #define tracing_paths (global_path_set.num_selected != 0)
377 extern unsigned xflag;
378 extern unsigned followfork;
379 #ifdef USE_LIBUNWIND
380 /* if this is true do the stack trace for every system call */
381 extern bool stack_trace_enabled;
382 #endif
383 extern unsigned ptrace_setoptions;
384 extern unsigned max_strlen;
385 extern unsigned os_release;
386 #undef KERNEL_VERSION
387 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
388
389 extern int read_int_from_file(struct tcb *, const char *, int *);
390
391 extern void set_sortby(const char *);
392 extern void set_overhead(int);
393 extern void print_pc(struct tcb *);
394
395 extern int syscall_entering_decode(struct tcb *);
396 extern int syscall_entering_trace(struct tcb *, unsigned int *);
397 extern void syscall_entering_finish(struct tcb *, int);
398
399 extern int syscall_exiting_decode(struct tcb *, struct timeval *);
400 extern int syscall_exiting_trace(struct tcb *, struct timeval, int);
401 extern void syscall_exiting_finish(struct tcb *);
402
403 extern void count_syscall(struct tcb *, const struct timeval *);
404 extern void call_summary(FILE *);
405
406 extern void clear_regs(struct tcb *tcp);
407 extern int get_scno(struct tcb *);
408 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
409
410 /**
411  * Convert a (shuffled) syscall number to the corresponding syscall name.
412  *
413  * @param scno Syscall number.
414  * @return     String literal corresponding to the syscall number in case latter
415  *             is valid; NULL otherwise.
416  */
417 extern const char *syscall_name(kernel_ulong_t scno);
418 /**
419  * Convert a syscall name to the corresponding (shuffled) syscall number.
420  *
421  * @param s     Syscall name.
422  * @param p     Personality.
423  * @param start From which position in syscall entry table resume the search.
424  * @return      Shuffled syscall number (ready to use against sysent_vec)
425  *              if syscall name is found; -1 otherwise.
426  */
427 extern kernel_long_t scno_by_name(const char *s, unsigned p,
428                                   kernel_long_t start);
429 /**
430  * Shuffle syscall numbers so that we don't have huge gaps in syscall table.
431  * The shuffling should be an involution: shuffle_scno(shuffle_scno(n)) == n.
432  *
433  * @param scno Raw or shuffled syscall number.
434  * @return     Shuffled or raw syscall number, respectively.
435  */
436 extern kernel_ulong_t shuffle_scno(kernel_ulong_t scno);
437 extern const char *err_name(unsigned long err);
438
439 extern bool is_erestart(struct tcb *);
440 extern void temporarily_clear_syserror(struct tcb *);
441 extern void restore_cleared_syserror(struct tcb *);
442
443 extern void *get_tcb_priv_data(const struct tcb *);
444 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
445                              void (*free_priv_data)(void *));
446 extern void free_tcb_priv_data(struct tcb *);
447
448 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
449 {
450         return (unsigned long) get_tcb_priv_data(tcp);
451 }
452
453 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
454 {
455         return set_tcb_priv_data(tcp, (void *) val, 0);
456 }
457
458 extern int
459 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
460 #define umove(pid, addr, objp)  \
461         umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
462
463 extern int
464 umoven_or_printaddr(struct tcb *, kernel_ulong_t addr,
465                     unsigned int len, void *laddr);
466 #define umove_or_printaddr(pid, addr, objp)     \
467         umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
468
469 extern int
470 umoven_or_printaddr_ignore_syserror(struct tcb *, kernel_ulong_t addr,
471                                     unsigned int len, void *laddr);
472
473 extern int
474 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
475
476 extern int upeek(struct tcb *tcp, unsigned long, kernel_ulong_t *);
477 extern int upoke(struct tcb *tcp, unsigned long, kernel_ulong_t);
478
479 extern bool
480 print_array(struct tcb *,
481             kernel_ulong_t start_addr,
482             size_t nmemb,
483             void *elem_buf,
484             size_t elem_size,
485             int (*umoven_func)(struct tcb *,
486                                      kernel_ulong_t,
487                                      unsigned int,
488                                      void *),
489             bool (*print_func)(struct tcb *,
490                                      void *elem_buf,
491                                      size_t elem_size,
492                                      void *opaque_data),
493             void *opaque_data);
494
495 #if HAVE_ARCH_GETRVAL2
496 extern long getrval2(struct tcb *);
497 #endif
498
499 extern const char *signame(const int);
500 extern void pathtrace_select_set(const char *, struct path_set *);
501 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
502 #define pathtrace_select(tcp)   \
503         pathtrace_select_set(tcp, &global_path_set)
504 #define pathtrace_match(tcp)    \
505         pathtrace_match_set(tcp, &global_path_set)
506 extern int getfdpath(struct tcb *, int, char *, unsigned);
507 extern unsigned long getfdinode(struct tcb *, int);
508 extern enum sock_proto getfdproto(struct tcb *, int);
509
510 extern const char *xlookup(const struct xlat *, const uint64_t);
511 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
512
513 struct dyxlat;
514 struct dyxlat *dyxlat_alloc(size_t nmemb);
515 void dyxlat_free(struct dyxlat *);
516 const struct xlat *dyxlat_get(const struct dyxlat *);
517 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
518
519 const struct xlat *genl_families_xlat(struct tcb *tcp);
520
521 extern unsigned long get_pagesize(void);
522 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
523
524 /*
525  * Returns STR if it does not start with PREFIX,
526  * or a pointer to the first char in STR after PREFIX.
527  * The length of PREFIX is specified by PREFIX_LEN.
528  */
529 static inline const char *
530 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
531 {
532         return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
533 }
534
535 #define STR_STRIP_PREFIX(str, prefix)   \
536         str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
537
538 #define QUOTE_0_TERMINATED                      0x01
539 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES      0x02
540 #define QUOTE_OMIT_TRAILING_0                   0x08
541 #define QUOTE_FORCE_HEX                         0x10
542 #define QUOTE_EMIT_COMMENT                      0x20
543
544 extern int string_quote(const char *, char *, unsigned int, unsigned int,
545                         const char *escape_chars);
546 extern int print_quoted_string_ex(const char *, unsigned int, unsigned int,
547                                   const char *escape_chars);
548 extern int print_quoted_string(const char *, unsigned int, unsigned int);
549 extern int print_quoted_cstring(const char *, unsigned int);
550
551 /* a refers to the lower numbered u_arg,
552  * b refers to the higher numbered u_arg
553  */
554 #ifdef WORDS_BIGENDIAN
555 # define ULONG_LONG(a, b) \
556         ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
557 #else
558 # define ULONG_LONG(a, b) \
559         ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
560 #endif
561 extern int getllval(struct tcb *, unsigned long long *, int);
562 extern int printllval(struct tcb *, const char *, int)
563         ATTRIBUTE_FORMAT((printf, 2, 0));
564
565 extern void printaddr64(uint64_t addr);
566 extern void printaddr(kernel_ulong_t addr);
567 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
568         ATTRIBUTE_SENTINEL;
569 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
570         uint64_t val, const char *dflt);
571 /**
572  * Wrapper around printxval_searchn that passes ARRAY_SIZE - 1
573  * as the array size, as all arrays are XLAT_END-terminated and
574  * printxval_searchn expects a size without the terminating record.
575  */
576 #define printxval_search(xlat__, val__, dflt__) \
577         printxval_searchn(xlat__, ARRAY_SIZE(xlat__) - 1, val__, dflt__)
578 extern int sprintxval(char *buf, size_t size, const struct xlat *,
579         unsigned int val, const char *dflt);
580 extern int printargs(struct tcb *);
581 extern int printargs_u(struct tcb *);
582 extern int printargs_d(struct tcb *);
583
584 extern void addflags(const struct xlat *, uint64_t);
585 extern int printflags_ex(uint64_t, const char *, const struct xlat *, ...)
586         ATTRIBUTE_SENTINEL;
587 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
588 extern const char *sprinttime(long long sec);
589 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
590 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
591 extern void print_symbolic_mode_t(unsigned int);
592 extern void print_numeric_umode_t(unsigned short);
593 extern void print_numeric_long_umask(unsigned long);
594 extern void print_dev_t(unsigned long long dev);
595 extern void print_abnormal_hi(kernel_ulong_t);
596
597 extern kernel_ulong_t *
598 fetch_indirect_syscall_args(struct tcb *, kernel_ulong_t addr, unsigned int n_args);
599
600 extern void
601 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
602
603 extern void
604 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
605
606 extern void
607 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
608
609 extern void
610 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
611
612 extern int
613 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
614             unsigned int user_style);
615
616 extern int
617 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
618
619 extern int
620 printpath(struct tcb *, kernel_ulong_t addr);
621
622 #define TIMESPEC_TEXT_BUFSIZE \
623                 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
624 extern void printfd(struct tcb *, int);
625 extern void print_sockaddr(const void *sa, int len);
626 extern bool
627 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
628 extern bool
629 decode_inet_addr(struct tcb *, kernel_ulong_t addr,
630                  unsigned int len, int family, const char *var_name);
631 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
632 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
633 extern void print_dirfd(struct tcb *, int);
634
635 extern int
636 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
637
638 extern void printuid(const char *, const unsigned int);
639
640 extern void
641 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
642 extern void
643 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
644
645 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
646 #define tprintsigmask_addr(prefix, mask) \
647         tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
648 extern void printsignal(int);
649
650 extern void
651 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
652                 enum iov_decode, kernel_ulong_t data_size);
653
654 extern void
655 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
656
657 extern void tprint_open_modes(unsigned int);
658 extern const char *sprint_open_modes(unsigned int);
659
660 extern void
661 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
662
663 extern void
664 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
665
666 extern void
667 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
668
669 extern void
670 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
671
672 struct strace_stat;
673 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
674
675 struct strace_statfs;
676 struct strace_keyctl_kdf_params;
677
678 extern void
679 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
680
681 extern void
682 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
683
684 extern void print_ifindex(unsigned int);
685
686 extern void qualify(const char *);
687 extern unsigned int qual_flags(const unsigned int);
688
689 #define DECL_IOCTL(name)                                                \
690 extern int                                                              \
691 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)  \
692 /* End of DECL_IOCTL definition. */
693
694 DECL_IOCTL(dm);
695 DECL_IOCTL(file);
696 DECL_IOCTL(fs_x);
697 DECL_IOCTL(kvm);
698 DECL_IOCTL(nsfs);
699 DECL_IOCTL(ptp);
700 DECL_IOCTL(scsi);
701 DECL_IOCTL(term);
702 DECL_IOCTL(ubi);
703 DECL_IOCTL(uffdio);
704 #undef DECL_IOCTL
705
706 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
707
708 struct nlmsghdr;
709
710 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
711                                   kernel_ulong_t addr, unsigned int len);
712
713 #define DECL_NETLINK(name)                                              \
714 extern bool                                                             \
715 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *,          \
716                         kernel_ulong_t addr, unsigned int len)          \
717 /* End of DECL_NETLINK definition. */
718
719 DECL_NETLINK(crypto);
720 DECL_NETLINK(netfilter);
721 DECL_NETLINK(route);
722 DECL_NETLINK(selinux);
723 DECL_NETLINK(sock_diag);
724
725 extern int tv_nz(const struct timeval *);
726 extern int tv_cmp(const struct timeval *, const struct timeval *);
727 extern double tv_float(const struct timeval *);
728 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
729 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
730 extern void tv_mul(struct timeval *, const struct timeval *, int);
731 extern void tv_div(struct timeval *, const struct timeval *, int);
732
733 #ifdef USE_LIBUNWIND
734 extern void unwind_init(void);
735 extern void unwind_tcb_init(struct tcb *);
736 extern void unwind_tcb_fin(struct tcb *);
737 extern void unwind_print_stacktrace(struct tcb *);
738 extern void unwind_capture_stacktrace(struct tcb *);
739 #endif
740
741 static inline int
742 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
743 {
744         return printstr_ex(tcp, addr, len, 0);
745 }
746
747 static inline int
748 printstr(struct tcb *tcp, kernel_ulong_t addr)
749 {
750         return printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
751 }
752
753 static inline int
754 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
755 {
756         return printflags_ex(flags, dflt, x, NULL);
757 }
758
759 static inline int
760 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
761 {
762         return printflags64(x, flags, dflt);
763 }
764
765 static inline int
766 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
767 {
768         return printxvals(val, dflt, x, NULL);
769 }
770
771 static inline int
772 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
773 {
774         return printxvals(val, dflt, x, NULL);
775 }
776
777 static inline void
778 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
779            enum iov_decode decode_iov)
780 {
781         tprint_iov_upto(tcp, len, addr, decode_iov, -1);
782 }
783
784 #ifdef ALPHA
785 typedef struct {
786         int tv_sec, tv_usec;
787 } timeval32_t;
788
789 extern void print_timeval32_t(const timeval32_t *);
790 extern void printrusage32(struct tcb *, kernel_ulong_t);
791 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
792 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
793 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
794 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
795 #endif
796
797 #ifdef HAVE_STRUCT_USER_DESC
798 /**
799  * Filter what to print from the point of view of the get_thread_area syscall.
800  * Kernel copies only entry_number field at first and then tries to write the
801  * whole structure.
802  */
803 enum user_desc_print_filter {
804         /* Print the "entering" part of struct user_desc - entry_number.  */
805         USER_DESC_ENTERING = 1,
806         /* Print the "exiting" part of the structure.  */
807         USER_DESC_EXITING  = 2,
808         USER_DESC_BOTH     = USER_DESC_ENTERING | USER_DESC_EXITING,
809 };
810
811 extern void print_user_desc(struct tcb *, kernel_ulong_t addr,
812                             enum user_desc_print_filter filter);
813 #endif
814
815 /* Strace log generation machinery.
816  *
817  * printing_tcp: tcb which has incomplete line being printed right now.
818  * NULL if last line has been completed ('\n'-terminated).
819  * printleader(tcp) examines it, finishes incomplete line if needed,
820  * the sets it to tcp.
821  * line_ended() clears printing_tcp and resets ->curcol = 0.
822  * tcp->curcol == 0 check is also used to detect completeness
823  * of last line, since in -ff mode just checking printing_tcp for NULL
824  * is not enough.
825  *
826  * If you change this code, test log generation in both -f and -ff modes
827  * using:
828  * strace -oLOG -f[f] test/threaded_execve
829  * strace -oLOG -f[f] test/sigkill_rain
830  * strace -oLOG -f[f] -p "`pidof web_browser`"
831  */
832 extern struct tcb *printing_tcp;
833 extern void printleader(struct tcb *);
834 extern void line_ended(void);
835 extern void tabto(void);
836 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
837 extern void tprints(const char *str);
838 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
839 extern void tprints_comment(const char *str);
840
841 #if SUPPORTED_PERSONALITIES > 1
842 extern void set_personality(unsigned int personality);
843 extern unsigned current_personality;
844 #else
845 # define set_personality(personality) ((void)0)
846 # define current_personality 0
847 #endif
848
849 #if SUPPORTED_PERSONALITIES == 1
850 # define current_wordsize PERSONALITY0_WORDSIZE
851 # define current_klongsize PERSONALITY0_KLONGSIZE
852 #else
853 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
854 #  define current_wordsize PERSONALITY0_WORDSIZE
855 # else
856 extern unsigned current_wordsize;
857 # endif
858 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
859 #  define current_klongsize PERSONALITY0_KLONGSIZE
860 # else
861 extern unsigned current_klongsize;
862 # endif
863 #endif
864
865 #if SIZEOF_KERNEL_LONG_T > 4            \
866  && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize))
867 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG     1
868 #else
869 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG     0
870 #endif
871
872 #define DECL_PRINTNUM(name)                                             \
873 extern bool                                                             \
874 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)   \
875         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
876 /* End of DECL_PRINTNUM definition. */
877
878 DECL_PRINTNUM(short);
879 DECL_PRINTNUM(int);
880 DECL_PRINTNUM(int64);
881 #undef DECL_PRINTNUM
882
883 #define DECL_PRINTNUM_ADDR(name)                                        \
884 extern bool                                                             \
885 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr)               \
886 /* End of DECL_PRINTNUM_ADDR definition. */
887
888 DECL_PRINTNUM_ADDR(int);
889 DECL_PRINTNUM_ADDR(int64);
890 #undef DECL_PRINTNUM_ADDR
891
892 #ifndef current_wordsize
893 extern bool
894 printnum_long_int(struct tcb *, kernel_ulong_t addr,
895                   const char *fmt_long, const char *fmt_int)
896         ATTRIBUTE_FORMAT((printf, 3, 0))
897         ATTRIBUTE_FORMAT((printf, 4, 0));
898 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
899 # define printnum_slong(tcp, addr) \
900         printnum_long_int((tcp), (addr), "%" PRId64, "%d")
901 # define printnum_ulong(tcp, addr) \
902         printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
903 # define printnum_ptr(tcp, addr) \
904         printnum_addr_long_int((tcp), (addr))
905 #elif current_wordsize > 4
906 # define printnum_slong(tcp, addr) \
907         printnum_int64((tcp), (addr), "%" PRId64)
908 # define printnum_ulong(tcp, addr) \
909         printnum_int64((tcp), (addr), "%" PRIu64)
910 # define printnum_ptr(tcp, addr) \
911         printnum_addr_int64((tcp), (addr))
912 #else /* current_wordsize == 4 */
913 # define printnum_slong(tcp, addr) \
914         printnum_int((tcp), (addr), "%d")
915 # define printnum_ulong(tcp, addr) \
916         printnum_int((tcp), (addr), "%u")
917 # define printnum_ptr(tcp, addr) \
918         printnum_addr_int((tcp), (addr))
919 #endif
920
921 #ifndef current_klongsize
922 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
923 # define printnum_kptr(tcp, addr) \
924         printnum_addr_klong_int((tcp), (addr))
925 #elif current_klongsize > 4
926 # define printnum_kptr(tcp, addr) \
927         printnum_addr_int64((tcp), (addr))
928 #else /* current_klongsize == 4 */
929 # define printnum_kptr(tcp, addr) \
930         printnum_addr_int((tcp), (addr))
931 #endif
932
933 #define DECL_PRINTPAIR(name)                                            \
934 extern bool                                                             \
935 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)  \
936         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
937 /* End of DECL_PRINTPAIR definition. */
938
939 DECL_PRINTPAIR(int);
940 DECL_PRINTPAIR(int64);
941 #undef DECL_PRINTPAIR
942
943 static inline kernel_long_t
944 truncate_klong_to_current_wordsize(const kernel_long_t v)
945 {
946 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
947         if (current_wordsize < sizeof(v)) {
948                 return (int) v;
949         } else
950 #endif
951         {
952                 return v;
953         }
954 }
955
956 static inline kernel_ulong_t
957 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
958 {
959 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
960         if (current_wordsize < sizeof(v)) {
961                 return (unsigned int) v;
962         } else
963 #endif
964         {
965                 return v;
966         }
967 }
968
969 /*
970  * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
971  */
972 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
973
974 /*
975  * Zero-extend a signed integer type to unsigned long long.
976  */
977 #define zero_extend_signed_to_ull(v) \
978         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
979          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
980          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
981          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
982          (unsigned long long) (v))
983
984 /*
985  * Sign-extend an unsigned integer type to long long.
986  */
987 #define sign_extend_unsigned_to_ll(v) \
988         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
989          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
990          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
991          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
992          (long long) (v))
993
994 extern const struct_sysent sysent0[];
995 extern const char *const errnoent0[];
996 extern const char *const signalent0[];
997 extern const struct_ioctlent ioctlent0[];
998
999 extern const char *const personality_names[];
1000
1001 #if SUPPORTED_PERSONALITIES > 1
1002 extern const struct_sysent *sysent;
1003 extern const char *const *errnoent;
1004 extern const char *const *signalent;
1005 extern const struct_ioctlent *ioctlent;
1006 #else
1007 # define sysent     sysent0
1008 # define errnoent   errnoent0
1009 # define signalent  signalent0
1010 # define ioctlent   ioctlent0
1011 #endif
1012
1013 extern unsigned nsyscalls;
1014 extern unsigned nerrnos;
1015 extern unsigned nsignals;
1016 extern unsigned nioctlents;
1017
1018 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
1019 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
1020 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
1021
1022 #ifdef IN_MPERS_BOOTSTRAP
1023 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
1024 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
1025 #else /* !IN_MPERS_BOOTSTRAP */
1026 # if SUPPORTED_PERSONALITIES > 1
1027 #  include "printers.h"
1028 # else
1029 #  include "native_printer_decls.h"
1030 # endif
1031 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
1032 #endif /* !IN_MPERS_BOOTSTRAP */
1033
1034 /* Checks that sysent[scno] is not out of range. */
1035 static inline bool
1036 scno_in_range(kernel_ulong_t scno)
1037 {
1038         return scno < nsyscalls;
1039 }
1040
1041 /*
1042  * Checks whether scno is not out of range,
1043  * its corresponding sysent[scno].sys_func is non-NULL,
1044  * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
1045  */
1046 static inline bool
1047 scno_is_valid(kernel_ulong_t scno)
1048 {
1049         return scno_in_range(scno)
1050                && sysent[scno].sys_func
1051                && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1052 }
1053
1054 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1055 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1056 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1057
1058 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1059
1060 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1061
1062 #endif /* !STRACE_DEFS_H */