/*
 * Copyright (c) 1991, 1992 Paul Kranenburg <pk@cs.few.eur.nl>
 * Copyright (c) 1993 Branko Lankester <branko@hacktic.nl>
 * Copyright (c) 1993, 1994, 1995, 1996 Rick Sladkey <jrs@world.std.com>
 * Copyright (c) 1999-2020 The strace developers.
 * All rights reserved.
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#ifndef STRACE_DEFS_H
# define STRACE_DEFS_H

# ifdef HAVE_CONFIG_H
#  include "config.h"
# endif

# include <features.h>
# include <stdbool.h>
# include <stdint.h>
# include <inttypes.h>
# include <sys/types.h>
# include <stddef.h>
# include <unistd.h>
# include <stdlib.h>
# include <stdio.h>
/* Open-coding isprint(ch) et al proved more efficient than calling
 * generalized libc interface. We don't *want* to do non-ASCII anyway.
 */
/* #include <ctype.h> */
# include <string.h>
# include <errno.h>
# include <time.h>
# include <sys/time.h>

# include "arch_defs.h"
# include "error_prints.h"
# include "gcc_compat.h"
# include "kernel_types.h"
# include "list.h"
# include "macros.h"
# include "mpers_type.h"
# include "string_to_uint.h"
# include "sysent.h"
# include "xmalloc.h"

# ifndef HAVE_STRERROR
const char *strerror(int);
# endif
# ifndef HAVE_STPCPY
/* Some libc have stpcpy, some don't. Sigh...
 * Roll our private implementation...
 */
#  undef stpcpy
#  define stpcpy strace_stpcpy
extern char *stpcpy(char *dst, const char *src);
# endif

/* Glibc has an efficient macro for sigemptyset
 * (it just does one or two assignments of 0 to internal vector of longs).
 */
# if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset)
#  define sigemptyset __sigemptyset
# endif

/* Configuration section */
# ifndef DEFAULT_STRLEN
/* default maximum # of bytes printed in `printstr', change with -s switch */
#  define DEFAULT_STRLEN	32
# endif
# ifndef DEFAULT_ACOLUMN
#  define DEFAULT_ACOLUMN	40	/* default alignment column for results */
# endif
/*
 * Maximum number of args to a syscall.
 *
 * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
 * linux/<ARCH>/syscallent*.h:
 *	all have nargs <= 6 except mips o32 which has nargs <= 7.
 */
# ifndef MAX_ARGS
#  ifdef LINUX_MIPSO32
#   define MAX_ARGS	7
#  else
#   define MAX_ARGS	6
#  endif
# endif
/* default sorting method for call profiling */
# ifndef DEFAULT_SORTBY
#  define DEFAULT_SORTBY "time"
# endif

/* To force NOMMU build, set to 1 */
# define NOMMU_SYSTEM 0

# ifndef ERESTARTSYS
#  define ERESTARTSYS    512
# endif
# ifndef ERESTARTNOINTR
#  define ERESTARTNOINTR 513
# endif
# ifndef ERESTARTNOHAND
#  define ERESTARTNOHAND 514
# endif
# ifndef ERESTART_RESTARTBLOCK
#  define ERESTART_RESTARTBLOCK 516
# endif

# define PERSONALITY0_WORDSIZE  SIZEOF_LONG
# define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
# define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
# define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"

# if SUPPORTED_PERSONALITIES > 1
#  define PERSONALITY1_WORDSIZE  4
#  define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
# endif

# if SUPPORTED_PERSONALITIES > 2
#  define PERSONALITY2_WORDSIZE  4
#  define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
# endif

# if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
#  define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
#  define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
#  define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
#  define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
#  define HAVE_PERSONALITY_1_MPERS 1
# else
#  define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
#  define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
#  define PERSONALITY1_INCLUDE_FUNCS "empty.h"
#  define HAVE_PERSONALITY_1_MPERS 0
# endif

# if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
#  define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
#  define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
#  define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
#  define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
#  define HAVE_PERSONALITY_2_MPERS 1
# else
#  define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
#  define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
#  define PERSONALITY2_INCLUDE_FUNCS "empty.h"
#  define HAVE_PERSONALITY_2_MPERS 0
# endif

# ifdef WORDS_BIGENDIAN
#  define is_bigendian true
# else
#  define is_bigendian false
# endif

# if SUPPORTED_PERSONALITIES > 1
extern void set_personality(unsigned int personality);
extern unsigned current_personality;
# else
#  define set_personality(personality) ((void)0)
#  define current_personality 0
# endif

# if SUPPORTED_PERSONALITIES == 1
#  define current_wordsize PERSONALITY0_WORDSIZE
#  define current_klongsize PERSONALITY0_KLONGSIZE
# else
#  if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
#   define current_wordsize PERSONALITY0_WORDSIZE
#  else
extern unsigned current_wordsize;
#  endif
#  if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
#   define current_klongsize PERSONALITY0_KLONGSIZE
#  else
extern unsigned current_klongsize;
#  endif
# endif

# define max_addr() (~0ULL >> ((8 - current_wordsize) * 8))
# define max_kaddr() (~0ULL >> ((8 - current_klongsize) * 8))

/* Shorthands for defining word/klong-based dispatcher function bodies */
# ifndef current_wordsize
#  define opt_wordsize(opt_64_, opt_32_) \
	((current_wordsize > sizeof(uint32_t)) ? (opt_64_) : (opt_32_))
#  define dispatch_wordsize(call_64_, call_32_, ...) \
	((current_wordsize > sizeof(uint32_t)) \
		? (call_64_)(__VA_ARGS__) : (call_32_)(__VA_ARGS__))
# elif current_wordsize > 4
#  define opt_wordsize(opt_64_, opt_32_) (opt_64_)
#  define dispatch_wordsize(call_64_, call_32_, ...) ((call_64_)(__VA_ARGS__))
# else /* current_wordsize == 4 */
#  define opt_wordsize(opt_64_, opt_32_) (opt_32_)
#  define dispatch_wordsize(call_64_, call_32_, ...) ((call_32_)(__VA_ARGS__))
# endif

# ifndef current_klongsize
#  define opt_klongsize(opt_64_, opt_32_) \
	((current_klongsize > sizeof(uint32_t)) ? (opt_64_) : (opt_32_))
#  define dispatch_klongsize(call_64_, call_32_, ...) \
	((current_klongsize > sizeof(uint32_t)) \
		? (call_64_)(__VA_ARGS__) : (call_32_)(__VA_ARGS__))
# elif current_klongsize > 4
#  define opt_klongsize(opt_64_, opt_32_) (opt_64_)
#  define dispatch_klongsize(call_64_, call_32_, ...) ((call_64_)(__VA_ARGS__))
# else /* current_klongsize == 4 */
#  define opt_klongsize(opt_64_, opt_32_) (opt_32_)
#  define dispatch_klongsize(call_64_, call_32_, ...) ((call_32_)(__VA_ARGS__))
# endif


typedef struct ioctlent {
	const char *symbol;
	unsigned int code;
} struct_ioctlent;

# define INJECT_F_SIGNAL		0x01
# define INJECT_F_ERROR		0x02
# define INJECT_F_RETVAL		0x04
# define INJECT_F_DELAY_ENTER	0x08
# define INJECT_F_DELAY_EXIT	0x10
# define INJECT_F_SYSCALL	0x20

# define INJECT_ACTION_FLAGS	\
	(INJECT_F_SIGNAL	\
	|INJECT_F_ERROR		\
	|INJECT_F_RETVAL	\
	|INJECT_F_DELAY_ENTER	\
	|INJECT_F_DELAY_EXIT	\
	)

struct inject_data {
	uint8_t flags;		/* 6 of 8 flags are used so far */
	uint8_t signo;		/* NSIG <= 128 */
	uint16_t rval_idx;	/* index in retval_vec */
	uint16_t delay_idx;	/* index in delay_data_vec */
	uint16_t scno;		/* syscall to be injected instead of -1 */
};

struct inject_opts {
	uint16_t first;
	uint16_t last;
	uint16_t step;
	struct inject_data data;
};

# define INJECT_LAST_INF	((uint16_t) -1)

# define MAX_ERRNO_VALUE			4095

/* Trace Control Block */
struct tcb {
	int flags;		/* See below for TCB_ values */
	int pid;		/* If 0, this tcb is free */
	int qual_flg;		/* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
# if SUPPORTED_PERSONALITIES > 1
	unsigned int currpers;	/* Personality at the time of scno update */
# endif
	unsigned long u_error;	/* Error code */
	kernel_ulong_t scno;	/* System call number */
	kernel_ulong_t u_arg[MAX_ARGS];	/* System call arguments */
	kernel_long_t u_rval;	/* Return value */
	int sys_func_rval;	/* Syscall entry parser's return value */
	int curcol;		/* Output column for this process */
	FILE *outf;		/* Output file for this process */
	struct staged_output_data *staged_output_data;

	const char *auxstr;	/* Auxiliary info from syscall (see RVAL_STR) */
	void *_priv_data;	/* Private data for syscall decoding functions */
	void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
	const struct_sysent *s_ent; /* sysent[scno] or a stub struct for bad
				     * scno.  Use tcp_sysent() macro for access.
				     */
	const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
	struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
	struct timespec stime;	/* System time usage as of last process wait */
	struct timespec ltime;	/* System time usage as of last syscall entry */
	struct timespec atime;	/* System time right after attach */
	struct timespec etime;	/* Syscall entry time (CLOCK_MONOTONIC) */
	struct timespec delay_expiration_time; /* When does the delay end */

	/*
	 * The ID of the PID namespace of this process
	 * (inode number of /proc/<pid>/ns/pid)
	 * (0: not initialized)
	 */
	unsigned int pid_ns;

	struct mmap_cache_t *mmap_cache;

	/*
	 * Data that is stored during process wait traversal.
	 * We use indices as the actual data is stored in an array
	 * that is realloc'ed at runtime.
	 */
	size_t wait_data_idx;
	/** Wait data storage for a delayed process. */
	struct tcb_wait_data *delayed_wait_data;
	struct list_item wait_list;


# ifdef HAVE_LINUX_KVM_H
	struct vcpu_info *vcpu_info_list;
# endif

# ifdef ENABLE_STACKTRACE
	void *unwind_ctx;
	struct unwind_queue_t *unwind_queue;
# endif
};

/* TCB flags */
/* We have attached to this process, but did not see it stopping yet */
# define TCB_STARTUP		0x01
# define TCB_IGNORE_ONE_SIGSTOP	0x02	/* Next SIGSTOP is to be ignored */
/*
 * Are we in system call entry or in syscall exit?
 *
 * This bit is set in syscall_entering_finish() and cleared in
 * syscall_exiting_finish().
 * Other stops which are possible directly after syscall entry (death, ptrace
 * event stop) are handled without calling syscall_{entering,exiting}_*().
 *
 * Use entering(tcp) / exiting(tcp) to check this bit to make code more
 * readable.
 */
# define TCB_INSYSCALL	0x04
# define TCB_ATTACHED	0x08	/* We attached to it already */
# define TCB_REPRINT	0x10	/* We should reprint this syscall on exit */
# define TCB_FILTERED	0x20	/* This system call has been filtered out */
# define TCB_TAMPERED	0x40	/* A syscall has been tampered with */
# define TCB_HIDE_LOG	0x80	/* We should hide everything (until execve) */
# define TCB_CHECK_EXEC_SYSCALL	0x100	/* Check whether this execve syscall succeeded */
# define TCB_SKIP_DETACH_ON_FIRST_EXEC	0x200	/* -b execve should skip detach on first execve */
# define TCB_GRABBED	0x400	/* We grab the process and can catch it
				 * in the middle of a syscall */
# define TCB_RECOVERING	0x800	/* We try to recover after detecting incorrect
				 * syscall entering/exiting state */
# define TCB_INJECT_DELAY_EXIT	0x1000	/* Current syscall needs to be delayed
					   on exit */
# define TCB_DELAYED	0x2000	/* Current syscall has been delayed */
# define TCB_TAMPERED_NO_FAIL 0x4000	/* We tamper tcb with syscall
					   that should not fail. */
# define TCB_SECCOMP_FILTER	0x8000	/* This process has a seccomp filter
					 * attached.
					 */

/* qualifier flags */
# define QUAL_TRACE	0x001	/* this system call should be traced */
# define QUAL_ABBREV	0x002	/* abbreviate the structures of this syscall */
# define QUAL_VERBOSE	0x004	/* decode the structures of this syscall */
# define QUAL_RAW	0x008	/* print all args in hex for this syscall */
# define QUAL_INJECT	0x010	/* tamper with this system call on purpose */

# define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)

# define entering(tcp)	(!((tcp)->flags & TCB_INSYSCALL))
# define exiting(tcp)	((tcp)->flags & TCB_INSYSCALL)
# define syserror(tcp)	((tcp)->u_error != 0)
# define traced(tcp)	((tcp)->qual_flg & QUAL_TRACE)
# define verbose(tcp)	((tcp)->qual_flg & QUAL_VERBOSE)
# define abbrev(tcp)	((tcp)->qual_flg & QUAL_ABBREV)
# define raw(tcp)	((tcp)->qual_flg & QUAL_RAW)
# define inject(tcp)	((tcp)->qual_flg & QUAL_INJECT)
# define filtered(tcp)	((tcp)->flags & TCB_FILTERED)
# define hide_log(tcp)	((tcp)->flags & TCB_HIDE_LOG)
# define check_exec_syscall(tcp)	((tcp)->flags & TCB_CHECK_EXEC_SYSCALL)
# define syscall_tampered(tcp)	((tcp)->flags & TCB_TAMPERED)
# define recovering(tcp)	((tcp)->flags & TCB_RECOVERING)
# define inject_delay_exit(tcp)	((tcp)->flags & TCB_INJECT_DELAY_EXIT)
# define syscall_delayed(tcp)	((tcp)->flags & TCB_DELAYED)
# define syscall_tampered_nofail(tcp) ((tcp)->flags & TCB_TAMPERED_NO_FAIL)
# define has_seccomp_filter(tcp)	((tcp)->flags & TCB_SECCOMP_FILTER)

extern const struct_sysent stub_sysent;
# define tcp_sysent(tcp) (tcp->s_ent ?: &stub_sysent)
# define n_args(tcp) (tcp_sysent(tcp)->nargs)

# include "xlat.h"

extern const struct xlat addrfams[];
extern const struct xlat arp_hardware_types[];
extern const struct xlat at_flags[];
extern const struct xlat clocknames[];
extern const struct xlat dirent_types[];
extern const struct xlat ethernet_protocols[];
extern const struct xlat inet_protocols[];
extern const struct xlat evdev_abs[];
extern const struct xlat audit_arch[];
extern const struct xlat evdev_ev[];
extern const struct xlat iffflags[];
extern const struct xlat ip_type_of_services[];
extern const struct xlat ipc_private[];
extern const struct xlat msg_flags[];
extern const struct xlat netlink_protocols[];
extern const struct xlat nl_netfilter_msg_types[];
extern const struct xlat nl_route_types[];
extern const struct xlat open_access_modes[];
extern const struct xlat open_mode_flags[];
extern const struct xlat pollflags[];
extern const struct xlat ptrace_cmds[];
extern const struct xlat resource_flags[];
extern const struct xlat routing_scopes[];
extern const struct xlat routing_table_ids[];
extern const struct xlat routing_types[];
extern const struct xlat rwf_flags[];
extern const struct xlat seccomp_filter_flags[];
extern const struct xlat seccomp_ret_action[];
extern const struct xlat setns_types[];
extern const struct xlat sg_io_info[];
extern const struct xlat socketlayers[];
extern const struct xlat socktypes[];
extern const struct xlat tcp_state_flags[];
extern const struct xlat tcp_states[];
extern const struct xlat whence_codes[];

/* Format of syscall return values */
# define RVAL_UDECIMAL	000	/* unsigned decimal format */
# define RVAL_HEX	001	/* hex format */
# define RVAL_OCTAL	002	/* octal format */
# define RVAL_FD		010	/* file descriptor */
# define RVAL_TID	011	/* task ID */
# define RVAL_SID	012	/* session ID */
# define RVAL_TGID	013	/* thread group ID */
# define RVAL_PGID	014	/* process group ID */
# define RVAL_MASK	017	/* mask for these values */

# define RVAL_STR	020	/* Print `auxstr' field after return val */
# define RVAL_NONE	040	/* Print nothing */

# define RVAL_DECODED	0100	/* syscall decoding finished */
# define RVAL_IOCTL_DECODED 0200	/* ioctl sub-parser successfully decoded
				   the argument */

# define IOCTL_NUMBER_UNKNOWN 0
# define IOCTL_NUMBER_HANDLED 1
# define IOCTL_NUMBER_STOP_LOOKUP 010

# define indirect_ipccall(tcp) (tcp_sysent(tcp)->sys_flags & TRACE_INDIRECT_SUBCALL)

enum pid_type {
	PT_TID,
	PT_TGID,
	PT_PGID,
	PT_SID,

	PT_COUNT,
	PT_NONE = -1
};

enum sock_proto {
	SOCK_PROTO_UNKNOWN,
	SOCK_PROTO_UNIX,
	SOCK_PROTO_TCP,
	SOCK_PROTO_UDP,
	SOCK_PROTO_UDPLITE,
	SOCK_PROTO_DCCP,
	SOCK_PROTO_SCTP,
	SOCK_PROTO_L2TP_IP,
	SOCK_PROTO_PING,
	SOCK_PROTO_RAW,
	SOCK_PROTO_TCPv6,
	SOCK_PROTO_UDPv6,
	SOCK_PROTO_UDPLITEv6,
	SOCK_PROTO_DCCPv6,
	SOCK_PROTO_L2TP_IPv6,
	SOCK_PROTO_SCTPv6,
	SOCK_PROTO_PINGv6,
	SOCK_PROTO_RAWv6,
	SOCK_PROTO_NETLINK,
};
extern enum sock_proto get_proto_by_name(const char *);
extern int get_family_by_proto(enum sock_proto proto);

enum iov_decode {
	IOV_DECODE_ADDR,
	IOV_DECODE_STR,
	IOV_DECODE_NETLINK
};

typedef enum {
	CFLAG_NONE = 0,
	CFLAG_ONLY_STATS,
	CFLAG_BOTH
} cflag_t;
extern cflag_t cflag;
extern bool Tflag;
extern int Tflag_scale;
extern int Tflag_width;
extern bool iflag;
extern bool count_wallclock;
extern unsigned int pidns_translation;
/* are we filtering traces based on paths? */
extern struct path_set {
	const char **paths_selected;
	size_t num_selected;
	size_t size;
} global_path_set;
# define tracing_paths (global_path_set.num_selected != 0)
enum xflag_opts {
	HEXSTR_NONE,
	HEXSTR_NON_ASCII,
	HEXSTR_ALL,

	NUM_HEXSTR_OPTS
};
extern unsigned xflag;
extern bool followfork;
extern bool output_separately;
# ifdef ENABLE_STACKTRACE
/* if this is true do the stack trace for every system call */
extern bool stack_trace_enabled;
# else
#  define stack_trace_enabled 0
# endif
extern unsigned ptrace_setoptions;
extern unsigned max_strlen;
extern unsigned os_release;
# undef KERNEL_VERSION
# define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))

extern int read_int_from_file(const char *, int *);

extern void set_sortby(const char *);
extern int set_overhead(const char *);
extern void set_count_summary_columns(const char *columns);

extern bool get_instruction_pointer(struct tcb *, kernel_ulong_t *);
extern bool get_stack_pointer(struct tcb *, kernel_ulong_t *);
extern void print_instruction_pointer(struct tcb *);

extern void print_syscall_resume(struct tcb *tcp);

extern int syscall_entering_decode(struct tcb *);
extern int syscall_entering_trace(struct tcb *, unsigned int *);
extern void syscall_entering_finish(struct tcb *, int);

extern int syscall_exiting_decode(struct tcb *, struct timespec *);
extern int syscall_exiting_trace(struct tcb *, struct timespec *, int);
extern void syscall_exiting_finish(struct tcb *);

extern void count_syscall(struct tcb *, const struct timespec *);
extern void call_summary(FILE *);

extern void clear_regs(struct tcb *tcp);
extern int get_scno(struct tcb *);
extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);

/**
 * Convert a (shuffled) syscall number to the corresponding syscall name.
 *
 * @param scno Syscall number.
 * @return     String literal corresponding to the syscall number in case latter
 *             is valid; NULL otherwise.
 */
extern const char *syscall_name(kernel_ulong_t scno);
/**
 * Convert a syscall name to the corresponding (shuffled) syscall number.
 *
 * @param s     Syscall name.
 * @param p     Personality.
 * @param start From which position in syscall entry table resume the search.
 * @return      Shuffled syscall number (ready to use against sysent_vec)
 *              if syscall name is found; -1 otherwise.
 */
extern kernel_long_t scno_by_name(const char *s, unsigned p,
				  kernel_long_t start);
/**
 * Shuffle syscall numbers so that we don't have huge gaps in syscall table.
 * The shuffling should be an involution: shuffle_scno(shuffle_scno(n)) == n.
 *
 * @param scno Raw or shuffled syscall number.
 * @return     Shuffled or raw syscall number, respectively.
 */
extern kernel_ulong_t shuffle_scno(kernel_ulong_t scno);
/**
 * Print error name in accordance with current xlat style setting.
 *
 * @param err     Error value.
 * @param negated If set to true, negative values of the err parameter indicate
 *                error condition, otherwise positive.
 */
extern void print_err(int64_t err, bool negated);

extern bool is_erestart(struct tcb *);
extern void temporarily_clear_syserror(struct tcb *);
extern void restore_cleared_syserror(struct tcb *);

extern void *get_tcb_priv_data(const struct tcb *);
extern int set_tcb_priv_data(struct tcb *, void *priv_data,
			     void (*free_priv_data)(void *));
extern void free_tcb_priv_data(struct tcb *);

static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
{
	return (unsigned long) get_tcb_priv_data(tcp);
}

static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
{
	return set_tcb_priv_data(tcp, (void *) val, 0);
}

/**
 * @return 0 on success, -1 on error.
 */
extern int
umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
# define umove(pid, addr, objp)	\
	umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))

/**
 * @return true on success, false on error.
 */
extern bool
tfetch_mem64(struct tcb *, uint64_t addr, unsigned int len, void *laddr);

static inline bool
tfetch_mem(struct tcb *tcp, const kernel_ulong_t addr,
	   unsigned int len, void *laddr)
{
	return tfetch_mem64(tcp, addr, len, laddr);
}
# define tfetch_obj(pid, addr, objp)	\
	tfetch_mem((pid), (addr), sizeof(*(objp)), (void *) (objp))

/**
 * @return true on success, false on error.
 */
extern bool
tfetch_mem64_ignore_syserror(struct tcb *, uint64_t addr,
			     unsigned int len, void *laddr);

static inline bool
tfetch_mem_ignore_syserror(struct tcb *tcp, const kernel_ulong_t addr,
			   unsigned int len, void *laddr)
{
	return tfetch_mem64_ignore_syserror(tcp, addr, len, laddr);
}

/**
 * @return 0 on success, -1 on error (and print addr).
 */
extern int
umoven_or_printaddr64(struct tcb *, uint64_t addr,
		      unsigned int len, void *laddr);
# define umove_or_printaddr64(pid, addr, objp)	\
	umoven_or_printaddr64((pid), (addr), sizeof(*(objp)), (void *) (objp))

static inline int
umoven_or_printaddr(struct tcb *tcp, const kernel_ulong_t addr,
		    unsigned int len, void *laddr)
{
	return umoven_or_printaddr64(tcp, addr, len, laddr);
}
# define umove_or_printaddr(pid, addr, objp)	\
	umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))

/**
 * @return 0 on success, -1 on error (and print addr).
 */
extern int
umoven_or_printaddr64_ignore_syserror(struct tcb *, uint64_t addr,
				      unsigned int len, void *laddr);
# define umove_or_printaddr64_ignore_syserror(pid, addr, objp)	\
	umoven_or_printaddr64_ignore_syserror((pid), (addr), sizeof(*(objp)), \
					      (void *) (objp))

static inline int
umoven_or_printaddr_ignore_syserror(struct tcb *tcp, const kernel_ulong_t addr,
				    unsigned int len, void *laddr)
{
	return umoven_or_printaddr64_ignore_syserror(tcp, addr, len, laddr);
}
# define umove_or_printaddr_ignore_syserror(pid, addr, objp)	\
	umoven_or_printaddr_ignore_syserror((pid), (addr), sizeof(*(objp)), \
					    (void *) (objp))

/**
 * @return strlen + 1 on success, 0 on success and no NUL seen, -1 on error.
 */
extern int
umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);

/* Invalidate the cache used by umove* functions.  */
extern void invalidate_umove_cache(void);

extern int upeek(struct tcb *tcp, unsigned long, kernel_ulong_t *);
extern int upoke(struct tcb *tcp, unsigned long, kernel_ulong_t);

# if HAVE_ARCH_GETRVAL2
extern long getrval2(struct tcb *);
# endif

extern const char *signame(const int);
extern const char *sprintsigname(const int);
extern void pathtrace_select_set(const char *, struct path_set *);
extern bool pathtrace_match_set(struct tcb *, struct path_set *);

static inline void
pathtrace_select(const char *path)
{
	return pathtrace_select_set(path, &global_path_set);
}

static inline bool
pathtrace_match(struct tcb *tcp)
{
	return pathtrace_match_set(tcp, &global_path_set);
}

extern int getfdpath_pid(pid_t pid, int fd, char *buf, unsigned bufsize);

static inline int
getfdpath(struct tcb *tcp, int fd, char *buf, unsigned bufsize)
{
	return getfdpath_pid(tcp->pid, fd, buf, bufsize);
}

extern unsigned long getfdinode(struct tcb *, int);
extern enum sock_proto getfdproto(struct tcb *, int);

extern const char *xlookup(const struct xlat *, const uint64_t);
extern const char *xlookup_le(const struct xlat *, uint64_t *);

struct dyxlat;
struct dyxlat *dyxlat_alloc(size_t nmemb);
void dyxlat_free(struct dyxlat *);
const struct xlat *dyxlat_get(const struct dyxlat *);
void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);

const struct xlat *genl_families_xlat(struct tcb *tcp);

extern unsigned long get_pagesize(void);
extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);

/*
 * Returns STR if it does not start with PREFIX,
 * or a pointer to the first char in STR after PREFIX.
 * The length of PREFIX is specified by PREFIX_LEN.
 */
static inline const char *
str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
{
	return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
}

# define STR_STRIP_PREFIX(str, prefix)	\
	str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)

/** String is '\0'-terminated. */
# define QUOTE_0_TERMINATED			0x01
/** Do not emit leading and ending '"' characters. */
# define QUOTE_OMIT_LEADING_TRAILING_QUOTES	0x02
/** Do not print '\0' if it is the last character. */
# define QUOTE_OMIT_TRAILING_0			0x08
/** Print ellipsis if the last character is not '\0' */
# define QUOTE_EXPECT_TRAILING_0		0x10
/** Print string in hex (using '\xHH' notation). */
# define QUOTE_FORCE_HEX			0x20
/** Enclose the string in C comment syntax. */
# define QUOTE_EMIT_COMMENT			0x40

extern int string_quote(const char *, char *, unsigned int, unsigned int,
			const char *escape_chars);
extern int print_quoted_string_ex(const char *, unsigned int, unsigned int,
				  const char *escape_chars);
extern int print_quoted_string(const char *, unsigned int, unsigned int);
extern int print_quoted_cstring(const char *, unsigned int);

/* a refers to the lower numbered u_arg,
 * b refers to the higher numbered u_arg
 */
# ifdef WORDS_BIGENDIAN
#  define ULONG_LONG(a, b) \
	((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
# else
#  define ULONG_LONG(a, b) \
	((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
# endif
extern int getllval(struct tcb *, unsigned long long *, int);
extern int printllval(struct tcb *, const char *, int)
	ATTRIBUTE_FORMAT((printf, 2, 0));

extern void printaddr64(uint64_t addr);

static inline void
printaddr(const kernel_ulong_t addr)
{
	printaddr64(addr);
}

# define xlat_verbose(style_) ((style_) & XLAT_STYLE_VERBOSITY_MASK)
# define xlat_format(style_)  ((style_) & XLAT_STYLE_FORMAT_MASK)

extern enum xlat_style xlat_verbosity;

extern int printxvals_ex(uint64_t val, const char *dflt,
			 enum xlat_style, const struct xlat *, ...)
	ATTRIBUTE_SENTINEL;
# define printxvals(val_, dflt_, ...) \
	printxvals_ex((val_), (dflt_), XLAT_STYLE_DEFAULT, __VA_ARGS__)
# define printxval_ex(xlat_, val_, dflt_, style_) \
	printxvals_ex((val_), (dflt_), (style_), (xlat_), NULL)

extern int sprintxval_ex(char *buf, size_t size, const struct xlat *,
			 unsigned int val, const char *dflt, enum xlat_style);

static inline int
sprintxval(char *buf, size_t size, const struct xlat *xlat, unsigned int val,
	   const char *dflt)
{
	return sprintxval_ex(buf, size, xlat, val, dflt, XLAT_STYLE_DEFAULT);
}

enum xlat_style_private_flag_bits {
	/* print_array */
	PAF_PRINT_INDICES_BIT = XLAT_STYLE_SPEC_BITS + 1,
	PAF_ARRAY_TRUNCATED_BIT,

	/* print_xlat */
	PXF_DEFAULT_STR_BIT,
};

enum xlat_style_private_flags {
	/* print_array */
	FLAG(PAF_PRINT_INDICES),
	FLAG(PAF_ARRAY_TRUNCATED),

	/* print_xlat */
	FLAG(PXF_DEFAULT_STR),
};

/**
 * Print a value in accordance with xlat formatting settings.
 *
 * @param val   Value itself.
 * @param str   String representation of the value.  Semantics may be affected
 *              by style argument;
 * @param style Combination of flags from enum xlat_style and PXF_* flags
 *              from enum xlat_style_private_flags:
 *               - PXF_DEFAULT_STR - interpret str argument as default
 *                 (fallback) string and not as string representation of val.
 */
extern void print_xlat_ex(uint64_t val, const char *str, uint32_t style);
# define print_xlat(val_) \
	print_xlat_ex((val_), #val_, XLAT_STYLE_DEFAULT)
# define print_xlat32(val_) \
	print_xlat_ex((uint32_t) (val_), #val_, XLAT_STYLE_DEFAULT)
# define print_xlat_u(val_) \
	print_xlat_ex((val_), #val_, XLAT_STYLE_FMT_U)
# define print_xlat_d(val_) \
	print_xlat_ex((val_), #val_, XLAT_STYLE_FMT_D)

extern int printargs(struct tcb *);
extern int printargs_u(struct tcb *);
extern int printargs_d(struct tcb *);

extern int printflags_ex(uint64_t flags, const char *dflt,
			 enum xlat_style, const struct xlat *, ...)
	ATTRIBUTE_SENTINEL;
extern const char *sprintflags_ex(const char *prefix, const struct xlat *,
				  uint64_t flags, char sep, enum xlat_style);

static inline const char *
sprintflags(const char *prefix, const struct xlat *xlat, uint64_t flags)
{
	return sprintflags_ex(prefix, xlat, flags, '\0', XLAT_STYLE_DEFAULT);
}

extern const char *sprinttime(long long sec);
extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
extern const char *sprinttime_usec(long long sec, unsigned long long usec);

# ifndef MAX_ADDR_LEN
#  define MAX_ADDR_LEN 32
# endif

extern const char *sprint_mac_addr(const uint8_t addr[], size_t size);
extern void print_mac_addr(const char *prefix,
			   const uint8_t addr[], size_t size);

extern const char *sprint_hwaddr(const uint8_t addr[], size_t size,
				 uint32_t devtype);
extern void print_hwaddr(const char *prefix,
			 const uint8_t addr[], size_t size, uint32_t devtype);

extern void print_uuid(const unsigned char *uuid);

extern void print_symbolic_mode_t(unsigned int);
extern void print_numeric_umode_t(unsigned short);
extern void print_numeric_umode_t_64(uint64_t);
extern void print_numeric_long_umask(unsigned long);
extern void print_dev_t(unsigned long long dev);
extern void print_kernel_version(unsigned long version);
extern void print_abnormal_hi(kernel_ulong_t);
extern void print_ioprio(unsigned int ioprio);

extern bool print_int32_array_member(struct tcb *, void *elem_buf,
				     size_t elem_size, void *data);
extern bool print_uint32_array_member(struct tcb *, void *elem_buf,
				      size_t elem_size, void *data);
extern bool print_uint64_array_member(struct tcb *, void *elem_buf,
				      size_t elem_size, void *data);
extern bool print_xint32_array_member(struct tcb *, void *elem_buf,
				      size_t elem_size, void *data);
extern bool print_xint64_array_member(struct tcb *, void *elem_buf,
				      size_t elem_size, void *data);

static inline bool
print_xlong_array_member(struct tcb *tcp, void *elem_buf, size_t elem_size,
			 void *data)
{
	return dispatch_wordsize(print_xint64_array_member,
				 print_xint32_array_member,
				 tcp, elem_buf, elem_size, data);
}


typedef bool (*tfetch_mem_fn)(struct tcb *, kernel_ulong_t addr,
			      unsigned int size, void *dest);
typedef bool (*print_fn)(struct tcb *, void *elem_buf,
			 size_t elem_size, void *opaque_data);
typedef int (*print_obj_by_addr_fn)(struct tcb *, kernel_ulong_t);
typedef const char * (*sprint_obj_by_addr_fn)(struct tcb *, kernel_ulong_t);


/**
 * Array printing function with over-engineered interface.
 *
 * @param start_addr       If tfetch_mem_fn is non-NULL: address in tracee's
 *                         memory where the start of the array is located.
 *                         If tfetch_mem_fn is NULL: ignored.
 * @param nmemb            Number of elements in array.
 * @param elem_buf         If tfetch_mem_fn is non-NULL: a buffer where each
 *                         element fetched by tfetch_mem_fn is stored.
 *                         If tfetch_mem_fn is NULL: address of the start of
 *                         the array in local memory.
 * @param elem_size        Size (in bytes) of each element in the array.
 * @param tfetch_mem_fn    Fetching function. If NULL, then elem_buf is treated
 *                         as local array of nmemb members elem_size each;
 *                         start_addr is ignored.
 * @param print_func       Element printing callback.
 * @param opaque_data      A value that is unconditionally passed to print_func
 *                         in opaque_data argument.
 * @param flags            Combination of xlat style settings and additional
 *                         flags from enum print_array_flags.
 * @param index_xlat       Xlat array that is used for printing indices.
 * @param index_xlat_size  The size of xlat array.
 * @param index_dflt       Default string for the values not found
 *                         in index_xlat.
 */
extern bool
print_array_ex(struct tcb *,
	       kernel_ulong_t start_addr,
	       size_t nmemb,
	       void *elem_buf,
	       size_t elem_size,
	       tfetch_mem_fn tfetch_mem_func,
	       print_fn print_func,
	       void *opaque_data,
	       unsigned int flags,
	       const struct xlat *index_xlat,
	       const char *index_dflt);

/** Print an array from tracee's memory without any index printing features. */
static inline bool
print_array(struct tcb *const tcp,
	    const kernel_ulong_t start_addr,
	    const size_t nmemb,
	    void *const elem_buf,
	    const size_t elem_size,
	    tfetch_mem_fn tfetch_mem_func,
	    print_fn print_func,
	    void *const opaque_data)
{
	return print_array_ex(tcp, start_addr, nmemb, elem_buf, elem_size,
			      tfetch_mem_func, print_func, opaque_data,
			      0, NULL, NULL);
}

/** Shorthand for printing local arrays. */
static inline bool
print_local_array_ex(struct tcb *tcp,
		     void *start_addr,
		     const size_t nmemb,
		     const size_t elem_size,
		     print_fn print_func,
		     void *const opaque_data,
		     unsigned int flags,
		     const struct xlat *index_xlat,
		     const char *index_dflt)
{
	return print_array_ex(tcp, (uintptr_t) start_addr, nmemb,
			      NULL, elem_size, NULL, print_func,
			      opaque_data, flags, index_xlat, index_dflt);
}

/** Shorthand for a shorthand for printing local arrays. */
# define print_local_array(tcp_, start_addr_, print_func_)      \
	print_local_array_ex((tcp_), (start_addr_), ARRAY_SIZE(start_addr_), \
			     sizeof((start_addr_)[0]), (print_func_),        \
			     NULL, 0, NULL, NULL)

extern kernel_ulong_t *
fetch_indirect_syscall_args(struct tcb *, kernel_ulong_t addr, unsigned int n_args);

extern void pidns_init(void);

/**
 * Returns the pid of the tracee as present in /proc of the tracer (can be
 * different from tcp->pid if /proc and the tracer process are in different PID
 * namespaces).
 */
extern int get_proc_pid(struct tcb *);

/**
 * Translates a pid from tracee's namespace to our namepace.
 *
 * @param tcp             The tcb of the tracee
 *                        (NULL: from_id is in strace's namespace. Useful for
 *                         getting the proc PID of from_id)
 * @param from_id         The id to be translated
 * @param type            The PID type of from_id
 * @param proc_pid_ptr    If not NULL, writes the proc PID to this location
 * @return                The translated id, or 0 if translation fails.
 */
extern int translate_pid(struct tcb *, int dest_id, enum pid_type type,
		    int *proc_pid_ptr);

extern void
dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);

extern void
dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);

extern void
dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);

extern void
dumpstr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);

extern int
printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
	    unsigned int user_style);

/**
 * Print a region of tracee memory only in case non-zero bytes are present
 * there.  It almost fits into printstr_ex, but it has some pretty specific
 * behaviour peculiarities (like printing of ellipsis on error) to readily
 * integrate it there.
 *
 * Since it is expected to be used for printing tail of a structure in tracee's
 * memory, it accepts a combination of start_addr/start_offs/total_len and does
 * the relevant calculations itself.
 *
 * @param prefix     A string printed in cases something is going to be printed.
 * @param start_addr Address of the beginning of a structure (whose tail
 *                   is supposedly to be printed) in tracee's memory.
 * @param start_offs Offset from the beginning of the structure where the tail
 *                   data starts.
 * @param total_len  Total size of the tracee's memory region containing
 *                   the structure and the tail data.
 *                   Caller is responsible for imposing a sensible (usually
 *                   mandated by the kernel interface, like get_pagesize())
 *                   limit here.
 * @param style      Passed to string_quote as "style" parameter.
 * @return           Returns true is anything was printed, false otherwise.
 */
extern bool print_nonzero_bytes(struct tcb *const tcp, const char *prefix,
				const kernel_ulong_t start_addr,
				const unsigned int start_offs,
				const unsigned int total_len,
				const unsigned int style);

extern int
printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);

extern int
printpath(struct tcb *, kernel_ulong_t addr);

# define TIMESPEC_TEXT_BUFSIZE \
		(sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))

/**
 * Returns the pid associated with pidfd of the process with ID pid_of_fd
 */
extern pid_t pidfd_get_pid(pid_t pid_of_fd, int fd);
/**
 * Print file descriptor fd owned by process with ID pid (from the PID NS
 * of the tracer).
 */
extern void printfd_pid(struct tcb *tcp, pid_t pid, int fd);

static inline void
printfd(struct tcb *tcp, int fd)
{
	printfd_pid(tcp, tcp->pid, fd);
}

/**
 * Print file descriptor fd owned by process with ID pid (from the PID NS
 * of the tracee).
 */
extern void printfd_pid_tracee_ns(struct tcb *tcp, pid_t pid, int fd);

/** Prints a PID specified in the tracee's PID namespace */
extern void printpid(struct tcb *, int pid, enum pid_type type);

/**
 * Prints pid as a TGID if positive, and PGID if negative
 * (like the first argument of kill).
 */
extern void printpid_tgid_pgid(struct tcb *, int pid);
extern void print_sockaddr(struct tcb *, const void *sa, int len);
extern bool
print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
extern bool
decode_inet_addr(struct tcb *, kernel_ulong_t addr,
		 unsigned int len, int family, const char *var_name);
extern void print_ax25_addr(const void /* ax25_address */ *addr);
extern void print_x25_addr(const void /* struct x25_address */ *addr);
extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
extern void print_dirfd(struct tcb *, int);

extern int
decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);

extern void printuid(const char *, const unsigned int);

extern void
print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
extern void
print_sigset_addr(struct tcb *, kernel_ulong_t addr);

extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
# define tprintsigmask_addr(prefix, mask) \
	tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
extern void printsignal(int);

extern void
tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
		enum iov_decode, kernel_ulong_t data_size);

extern void
decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);

extern void tprint_open_modes(unsigned int);
extern const char *sprint_open_modes(unsigned int);

extern void
decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);

extern void
print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);

extern void
decode_sock_fprog(struct tcb *, kernel_ulong_t addr);

extern void
print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);

struct strace_stat;
extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);

struct strace_statfs;
struct strace_keyctl_kdf_params;

extern void
print_struct_statfs(struct tcb *, kernel_ulong_t addr);

extern void
print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);

extern int
fetch_perf_event_attr(struct tcb *const tcp, const kernel_ulong_t addr);
extern void
print_perf_event_attr(struct tcb *const tcp, const kernel_ulong_t addr);

extern const char *get_ifname(const unsigned int ifindex);
extern void print_ifindex(unsigned int);

extern void print_bpf_filter_code(const uint16_t code, bool extended);

extern void qualify(const char *);
extern void qualify_trace(const char *);
extern void qualify_abbrev(const char *);
extern void qualify_verbose(const char *);
extern void qualify_raw(const char *);
extern void qualify_signals(const char *);
extern void qualify_status(const char *);
extern void qualify_quiet(const char *);
extern void qualify_decode_fd(const char *);
extern void qualify_read(const char *);
extern void qualify_write(const char *);
extern void qualify_fault(const char *);
extern void qualify_inject(const char *);
extern void qualify_kvm(const char *);
extern unsigned int qual_flags(const unsigned int);

# define DECL_IOCTL(name)						\
extern int								\
name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)	\
/* End of DECL_IOCTL definition. */

DECL_IOCTL(dm);
DECL_IOCTL(evdev);
DECL_IOCTL(file);
DECL_IOCTL(fs_x);
DECL_IOCTL(inotify);
DECL_IOCTL(kvm);
DECL_IOCTL(nbd);
DECL_IOCTL(nsfs);
DECL_IOCTL(ptp);
DECL_IOCTL(random);
DECL_IOCTL(scsi);
DECL_IOCTL(term);
DECL_IOCTL(ubi);
DECL_IOCTL(uffdio);
DECL_IOCTL(watchdog);
# undef DECL_IOCTL

extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
extern void print_evdev_ff_type(const kernel_ulong_t val);

struct nlmsghdr;

typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
				  kernel_ulong_t addr, unsigned int len);

# define DECL_NETLINK(name)						\
extern bool								\
decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *,		\
			kernel_ulong_t addr, unsigned int len)		\
/* End of DECL_NETLINK definition. */

DECL_NETLINK(crypto);
DECL_NETLINK(netfilter);
DECL_NETLINK(route);
DECL_NETLINK(selinux);
DECL_NETLINK(sock_diag);

extern void
decode_netlink_kobject_uevent(struct tcb *, kernel_ulong_t addr,
			      kernel_ulong_t len);

enum find_xlat_flag_bits {
	FXL_CASE_SENSITIVE_BIT,
};

enum find_xlat_flags {
	/** Whether to use strcmp instead of strcasecmp for comparison */
	FLAG(FXL_CASE_SENSITIVE),
};

/**
 * Searches for a string-value pair in the provided array of pairs.
 *
 * @param items     Array of string-value pairs to search in.
 * @param s         String to search for.
 * @param num_items Item count in items array.
 * @param flags     Bitwise-or'ed flags from enum find_xlat_flags.
 * @return          Pointer to the first matching string-value pair inside items
 *                  or NULL if nothing has been found.
 */
extern const struct xlat_data *find_xlat_val_ex(const struct xlat_data *items,
						const char *s, size_t num_items,
						unsigned int flags);
# define find_xlat_val(items_, s_) \
	find_xlat_val_ex((items_), (s_), ARRAY_SIZE(items_), 0)
# define find_xlat_val_case(items_, s_) \
	find_xlat_val_ex((items_), (s_), ARRAY_SIZE(items_), FXL_CASE_SENSITIVE)

/**
 * A find_xlat_val_ex wrapper for option arguments parsing.  Provides a value
 * from strs array that matched the supplied arg string.  If arg is NULL,
 * default_val is returned.  If nothing has matched, not_found value
 * is returned.
 *
 * find_arg_val provides a wrapper for the common case of statically-defined
 * strs arrays.
 *
 * @param arg         Argument string to parse
 * @param strs        Array of string-value pairs to match arg against.
 * @param strs_size   Element count in the strs array.
 * @param default_val Value to return if arg is NULL.
 * @param not_found   Value to return if arg hasn't found among strs.
 * @return            default_val is arg is NULL, value part of the matched
 *                    string-value pair, or not_found if nothing has matched.
 */
extern uint64_t find_arg_val_(const char *arg, const struct xlat_data *strs,
			      size_t strs_size, uint64_t default_val,
			      uint64_t not_found);
/** A find_arg_val_ wrapper that supplies strs_size to it using ARRAY_SIZE. */
# define find_arg_val(arg_, strs_, dflt_, not_found_) \
	find_arg_val_((arg_), (strs_), ARRAY_SIZE(strs_), (dflt_), (not_found_))

/**
 * A find_arg_val wrapper for parsing time scale names.
 *
 * @param arg        String to parse
 * @param empty_dflt Default scale for the empty arg.
 * @param null_dflt  Default scale for the NULL arg.
 * @param width      Width of the field required to print the second part
 *                   with the specified precision.
 * @return           Time scale (amount of nanoseconds) if found,
 *                   empty_dflt if arg is empty, null_dflt if arg is NULL,
 *                   -1 if arg doesn't match any known time scale.
 */
extern int str2timescale_ex(const char *arg, int empty_dflt, int null_dflt,
			    int *width);
/** str2timescale_ex wrapper for handling a separate argument. */
# define str2timescale_optarg(arg_, w_) str2timescale_ex((arg_), -1, 1000, (w_))
/** str2timescale_ex wrapper for handling a suffix in existing argument. */
# define str2timescale_sfx(arg_, w_) str2timescale_ex((arg_), 1000, -1, (w_))

extern int ts_nz(const struct timespec *);
extern int ts_cmp(const struct timespec *, const struct timespec *);
extern double ts_float(const struct timespec *);
extern void ts_add(struct timespec *, const struct timespec *, const struct timespec *);
extern void ts_sub(struct timespec *, const struct timespec *, const struct timespec *);
extern void ts_mul(struct timespec *, const struct timespec *, uint64_t);
extern void ts_div(struct timespec *, const struct timespec *, uint64_t);
extern const struct timespec *ts_min(const struct timespec *, const struct timespec *);
extern const struct timespec *ts_max(const struct timespec *, const struct timespec *);
extern int parse_ts(const char *s, struct timespec *t);

# ifdef ENABLE_STACKTRACE
extern void unwind_init(void);
extern void unwind_tcb_init(struct tcb *);
extern void unwind_tcb_fin(struct tcb *);
extern void unwind_tcb_print(struct tcb *);
extern void unwind_tcb_capture(struct tcb *);
# endif

# ifdef HAVE_LINUX_KVM_H
extern void kvm_run_structure_decoder_init(void);
extern void kvm_vcpu_info_free(struct tcb *);
# endif

static inline int
printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
{
	return printstr_ex(tcp, addr, len, 0);
}

static inline int
printstr(struct tcb *tcp, kernel_ulong_t addr)
{
	return printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
}

static inline int
printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
{
	return printflags_ex(flags, dflt, XLAT_STYLE_DEFAULT, x, NULL);
}

static inline int
printflags(const struct xlat *x, unsigned int flags, const char *dflt)
{
	return printflags64(x, flags, dflt);
}

static inline int
printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
{
	return printxvals(val, dflt, x, NULL);
}

static inline int
printxval(const struct xlat *x, const unsigned int val, const char *dflt)
{
	return printxvals(val, dflt, x, NULL);
}

static inline int
printxval64_u(const struct xlat *x, const uint64_t val, const char *dflt)
{
	return printxvals_ex(val, dflt, XLAT_STYLE_FMT_U, x, NULL);
}

static inline int
printxval_u(const struct xlat *x, const unsigned int val, const char *dflt)
{
	return printxvals_ex(val, dflt, XLAT_STYLE_FMT_U, x, NULL);
}

static inline int
printxval64_d(const struct xlat *x, const int64_t val, const char *dflt)
{
	return printxvals_ex(val, dflt, XLAT_STYLE_FMT_D, x, NULL);
}

static inline int
printxval_d(const struct xlat *x, const int val, const char *dflt)
{
	return printxvals_ex(val, dflt, XLAT_STYLE_FMT_D, x, NULL);
}

static inline void
tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
	   enum iov_decode decode_iov)
{
	tprint_iov_upto(tcp, len, addr, decode_iov, -1);
}

# if HAVE_ARCH_TIME32_SYSCALLS || HAVE_ARCH_TIMESPEC32
extern bool print_timespec32_data_size(const void *arg, size_t size);
extern bool print_timespec32_array_data_size(const void *arg,
					     unsigned int nmemb,
					     size_t size);
# endif /* HAVE_ARCH_TIME32_SYSCALLS || HAVE_ARCH_TIMESPEC32 */
# if HAVE_ARCH_TIME32_SYSCALLS
extern int print_timespec32(struct tcb *, kernel_ulong_t);
extern const char *sprint_timespec32(struct tcb *, kernel_ulong_t);
extern int print_timespec32_utime_pair(struct tcb *, kernel_ulong_t);
extern int print_itimerspec32(struct tcb *, kernel_ulong_t);
extern int print_timex32(struct tcb *, kernel_ulong_t);
# endif /* HAVE_ARCH_TIME32_SYSCALLS */

extern bool print_timespec64_data_size(const void *arg, size_t size);
extern bool print_timespec64_array_data_size(const void *arg,
					     unsigned int nmemb,
					     size_t size);
extern int print_timespec64(struct tcb *, kernel_ulong_t);
extern const char *sprint_timespec64(struct tcb *, kernel_ulong_t);
extern int print_timespec64_utime_pair(struct tcb *, kernel_ulong_t);
extern int print_itimerspec64(struct tcb *, kernel_ulong_t);

extern bool print_timeval64_data_size(const void *arg, size_t size);

extern int print_timex64(struct tcb *, kernel_ulong_t);

# ifdef SPARC64
extern int print_sparc64_timex(struct tcb *, kernel_ulong_t);
# endif

# ifdef ALPHA
typedef struct {
	int tv_sec, tv_usec;
} timeval32_t;

extern void print_timeval32_t(const timeval32_t *);
extern void printrusage32(struct tcb *, kernel_ulong_t);
extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
extern int print_timeval32(struct tcb *, kernel_ulong_t addr);
extern int print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
extern int print_itimerval32(struct tcb *, kernel_ulong_t addr);
# endif

# ifdef HAVE_STRUCT_USER_DESC
/**
 * Filter what to print from the point of view of the get_thread_area syscall.
 * Kernel copies only entry_number field at first and then tries to write the
 * whole structure.
 */
enum user_desc_print_filter {
	/* Print the "entering" part of struct user_desc - entry_number.  */
	USER_DESC_ENTERING = 1,
	/* Print the "exiting" part of the structure.  */
	USER_DESC_EXITING  = 2,
	USER_DESC_BOTH     = USER_DESC_ENTERING | USER_DESC_EXITING,
};

extern void print_user_desc(struct tcb *, kernel_ulong_t addr,
			    enum user_desc_print_filter filter);
# endif

/* Strace log generation machinery.
 *
 * printing_tcp: tcb which has incomplete line being printed right now.
 * NULL if last line has been completed ('\n'-terminated).
 * printleader(tcp) examines it, finishes incomplete line if needed,
 * the sets it to tcp.
 * line_ended() clears printing_tcp and resets ->curcol = 0.
 * tcp->curcol == 0 check is also used to detect completeness
 * of last line, since in -ff mode just checking printing_tcp for NULL
 * is not enough.
 *
 * If you change this code, test log generation in both -f and -ff modes
 * using:
 * strace -oLOG -f[f] test/threaded_execve
 * strace -oLOG -f[f] test/sigkill_rain
 * strace -oLOG -f[f] -p "`pidof web_browser`"
 */
extern struct tcb *printing_tcp;
extern void printleader(struct tcb *);
extern void line_ended(void);
extern void tabto(void);
extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
extern void tprints(const char *str);
extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
extern void tprints_comment(const char *str);

/*
 * Staging output for status qualifier.
 */
extern FILE *strace_open_memstream(struct tcb *tcp);
extern void strace_close_memstream(struct tcb *tcp, bool publish);

static inline void
printaddr_comment(const kernel_ulong_t addr)
{
	tprintf_comment("%#llx", (unsigned long long) addr);
}

/*
 * When u64 is interpreted by the kernel as an address, there is a difference
 * in behaviour between 32-bit and 64-bit kernel in the way u64_to_user_ptr
 * works (32-bit kernel trims higher bits during conversion which may result
 * to a valid address).  Since 32-bit strace cannot figure out what kind of
 * kernel the tracee is running on, it has to account for both possibilities.
 */
# if CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL

/**
 * Print raw 64-bit value as an address if it's too big to fit in strace's
 * kernel_long_t.
 */
static inline void
print_big_u64_addr(const uint64_t addr)
{
	if (sizeof(kernel_long_t) < 8 && addr > max_kaddr()) {
		printaddr64(addr);
		tprints(" or ");
	}
}
# else /* !CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL */
#  define print_big_u64_addr(addr_) ((void) 0)
# endif /* CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL */

# if SIZEOF_KERNEL_LONG_T > 4		\
 && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize))
#  define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG	1
# else
#  define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG	0
# endif

# define DECL_PRINTNUM(name)						\
extern bool								\
printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)	\
	ATTRIBUTE_FORMAT((printf, 3, 0))				\
/* End of DECL_PRINTNUM definition. */

DECL_PRINTNUM(short);
DECL_PRINTNUM(int);
DECL_PRINTNUM(int64);
# undef DECL_PRINTNUM

# define DECL_PRINTNUM_ADDR(name)					\
extern bool								\
printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr)		\
/* End of DECL_PRINTNUM_ADDR definition. */

DECL_PRINTNUM_ADDR(int);
DECL_PRINTNUM_ADDR(int64);
# undef DECL_PRINTNUM_ADDR

extern bool
printnum_fd(struct tcb *, kernel_ulong_t addr);

extern bool
printnum_pid(struct tcb *const tcp, const kernel_ulong_t addr, enum pid_type type);

static inline bool
printnum_slong(struct tcb *tcp, kernel_ulong_t addr)
{
	return dispatch_wordsize(printnum_int64, printnum_int,
				 tcp, addr, opt_wordsize("%" PRId64, "%d"));
}

static inline bool
printnum_ulong(struct tcb *tcp, kernel_ulong_t addr)
{
	return dispatch_wordsize(printnum_int64, printnum_int,
				 tcp, addr, opt_wordsize("%" PRIu64, "%u"));
}

static inline bool
printnum_ptr(struct tcb *tcp, kernel_ulong_t addr)
{
	return dispatch_wordsize(printnum_addr_int64, printnum_addr_int,
				 tcp, addr);
}

static inline bool
printnum_kptr(struct tcb *tcp, kernel_ulong_t addr)
{
	return dispatch_klongsize(printnum_addr_int64, printnum_addr_int,
				  tcp, addr);
}


# define DECL_PRINTPAIR(name)						\
extern bool								\
printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)	\
	ATTRIBUTE_FORMAT((printf, 3, 0))				\
/* End of DECL_PRINTPAIR definition. */

DECL_PRINTPAIR(int);
DECL_PRINTPAIR(int64);
# undef DECL_PRINTPAIR

static inline kernel_long_t
truncate_klong_to_current_wordsize(const kernel_long_t v)
{
# if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
	if (current_wordsize < sizeof(v)) {
		return (int) v;
	} else
# endif
	{
		return v;
	}
}

static inline kernel_ulong_t
truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
{
# if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
	if (current_wordsize < sizeof(v)) {
		return (unsigned int) v;
	} else
# endif
	{
		return v;
	}
}

/*
 * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
 */
# define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))

/*
 * Zero-extend a signed integer type to unsigned long long.
 */
# define zero_extend_signed_to_ull(v) \
	(sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
	 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
	 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
	 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
	 (unsigned long long) (v))

/*
 * Sign-extend an unsigned integer type to long long.
 */
# define sign_extend_unsigned_to_ll(v) \
	(sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
	 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
	 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
	 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
	 (long long) (v))

/*
 * Computes the popcount of a vector of 32-bit values.
 */
static inline unsigned int
popcount32(const uint32_t *a, unsigned int size)
{
	unsigned int count = 0;

	for (; size; ++a, --size) {
		uint32_t x = *a;

# ifdef HAVE___BUILTIN_POPCOUNT
		count += __builtin_popcount(x);
# else
		for (; x; ++count)
			x &= x - 1;
# endif
	}

	return count;
}

extern const char *const errnoent[];
extern const char *const signalent[];
extern const unsigned int nerrnos;
extern const unsigned int nsignals;

extern const struct_sysent sysent0[];
extern const struct_ioctlent ioctlent0[];

extern const char *const personality_names[];
/* Personality designators to be used for specifying personality */
extern const char *const personality_designators[];

# if SUPPORTED_PERSONALITIES > 1
extern const struct_sysent *sysent;
extern const struct_ioctlent *ioctlent;
# else
#  define sysent     sysent0
#  define ioctlent   ioctlent0
# endif

extern unsigned nsyscalls;
extern unsigned nioctlents;

extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];

# ifdef ENABLE_COVERAGE_GCOV
#  ifdef HAVE_GCOV_H
#   include <gcov.h>
#  else
extern void __gcov_dump(void);
#  endif
#  define GCOV_DUMP __gcov_dump()
# else
#  define GCOV_DUMP
# endif

# ifdef IN_MPERS_BOOTSTRAP
/* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
#  define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
# else /* !IN_MPERS_BOOTSTRAP */
#  if SUPPORTED_PERSONALITIES > 1
#   include "printers.h"
#  else
#   include "native_printer_decls.h"
#  endif
#  define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
# endif /* !IN_MPERS_BOOTSTRAP */

/* Checks that sysent[scno] is not out of range. */
static inline bool
scno_in_range(kernel_ulong_t scno)
{
	return scno < nsyscalls;
}

/*
 * Checks whether scno is not out of range,
 * its corresponding sysent[scno].sys_func is non-NULL,
 * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
 */
static inline bool
scno_is_valid(kernel_ulong_t scno)
{
	return scno_in_range(scno)
	       && sysent[scno].sys_func
	       && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
}

# define MPERS_FUNC_NAME__(prefix, name) prefix ## name
# define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
# define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)

# define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)

# define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)

#define ILOG2_ITER_(val_, ret_, bit_)					\
	do {								\
		typeof(ret_) shift_ =					\
			((val_) > ((((typeof(val_)) 1)			\
				   << (1 << (bit_))) - 1)) << (bit_);	\
		(val_) >>= shift_;					\
		(ret_) |= shift_;					\
	} while (0)

/**
 * Calculate floor(log2(val)), with the exception of val == 0, for which 0
 * is returned as well.
 *
 * @param val 64-bit value to calculate integer base-2 logarithm for.
 * @return    (unsigned int) floor(log2(val)) if val > 0, 0 if val == 0.
 */
static inline unsigned int
ilog2_64(uint64_t val)
{
	unsigned int ret = 0;

	ILOG2_ITER_(val, ret, 5);
	ILOG2_ITER_(val, ret, 4);
	ILOG2_ITER_(val, ret, 3);
	ILOG2_ITER_(val, ret, 2);
	ILOG2_ITER_(val, ret, 1);
	ILOG2_ITER_(val, ret, 0);

	return ret;
}

/**
 * Calculate floor(log2(val)), with the exception of val == 0, for which 0
 * is returned as well.
 *
 * @param val 32-bit value to calculate integer base-2 logarithm for.
 * @return    (unsigned int) floor(log2(val)) if val > 0, 0 if val == 0.
 */
static inline unsigned int
ilog2_32(uint32_t val)
{
	unsigned int ret = 0;

	ILOG2_ITER_(val, ret, 4);
	ILOG2_ITER_(val, ret, 3);
	ILOG2_ITER_(val, ret, 2);
	ILOG2_ITER_(val, ret, 1);
	ILOG2_ITER_(val, ret, 0);

	return ret;
}

#if SIZEOF_KERNEL_LONG_T > 4
# define ilog2_klong ilog2_64
#else
# define ilog2_klong ilog2_32
#endif

#undef ILOG2_ITER_

#endif /* !STRACE_DEFS_H */
