usr.bin/truss/truss.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright 2001 Jamey Wood
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #include <sys/queue.h>
  31
  32 #define FOLLOWFORKS             0x00000001
  33 #define RELATIVETIMESTAMPS      0x00000002
  34 #define ABSOLUTETIMESTAMPS      0x00000004
  35 #define NOSIGS                  0x00000008
  36 #define EXECVEARGS              0x00000010
  37 #define EXECVEENVS              0x00000020
  38 #define COUNTONLY               0x00000040
  39 #define DISPLAYTIDS             0x00000080
  40
  41 struct procinfo;
  42 struct syscall;
  43 struct trussinfo;
  44
  45 /*
  46  * The lookup of normal system calls are optimized by using a fixed
  47  * array for the first 1024 system calls that can be indexed directly.
  48  * Unknown system calls with other IDs are stored in a linked list.
  49  */
  50 #define SYSCALL_NORMAL_COUNT    1024
  51
  52 struct extra_syscall {
  53         STAILQ_ENTRY(extra_syscall) entries;
  54         struct syscall *sc;
  55         u_int number;
  56 };
  57
  58 struct procabi {
  59         const char *type;
  60         enum sysdecode_abi abi;
  61         size_t pointer_size;
  62         const char *compat_prefix;
  63         STAILQ_HEAD(, extra_syscall) extra_syscalls;
  64         struct syscall *syscalls[SYSCALL_NORMAL_COUNT];
  65 };
  66
  67 /*
  68  * This is confusingly named.  It holds per-thread state about the
  69  * currently executing system call.  syscall.h defines a struct
  70  * syscall that holds metadata used to format system call arguments.
  71  *
  72  * NB: args[] stores the raw argument values (e.g. from registers)
  73  * passed to the system call.  s_args[] stores a string representation
  74  * of a system call's arguments.  These do not necessarily map one to
  75  * one.  A system call description may omit individual arguments
  76  * (padding) or combine adjacent arguments (e.g. when passing an off_t
  77  * argument on a 32-bit system).  The nargs member contains the count
  78  * of valid pointers in s_args[], not args[].
  79  */
  80 struct current_syscall {
  81         struct syscall *sc;
  82         unsigned int number;
  83         unsigned int nargs;
  84         unsigned long args[10];
  85         char *s_args[10];       /* the printable arguments */
  86 };
  87
  88 struct threadinfo
  89 {
  90         LIST_ENTRY(threadinfo) entries;
  91         struct procinfo *proc;
  92         lwpid_t tid;
  93         int in_syscall;
  94         struct current_syscall cs;
  95         struct timespec before;
  96         struct timespec after;
  97 };
  98
  99 struct procinfo {
 100         LIST_ENTRY(procinfo) entries;
 101         pid_t pid;
 102         struct procabi *abi;
 103
 104         LIST_HEAD(, threadinfo) threadlist;
 105 };
 106
 107 struct trussinfo
 108 {
 109         int flags;
 110         int strsize;
 111         FILE *outfile;
 112
 113         struct timespec start_time;
 114
 115         struct threadinfo *curthread;
 116
 117         LIST_HEAD(, procinfo) proclist;
 118 };