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