Update copyright year range in all GDB files.
[external/binutils.git] / gdb / proc-utils.h
1 /* Machine independent support for SVR4 /proc (process file system) for GDB.
2    Copyright (C) 1999-2019 Free Software Foundation, Inc.
3
4    This file is part of GDB.
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19 /* From proc-why.c */
20
21 /*
22  * Pretty-print functions for /proc data 
23  */
24
25 extern void proc_prettyprint_why (unsigned long why, unsigned long what,
26                                   int verbose);
27
28 extern void proc_prettyprint_syscalls (sysset_t *sysset, int verbose);
29
30 extern void proc_prettyprint_syscall (int num, int verbose);
31
32 extern void proc_prettyprint_signalset (sigset_t *sigset, int verbose);
33
34 extern void proc_prettyprint_signal (int signo, int verbose);
35
36 extern void proc_prettyprint_faultset (fltset_t *fltset, int verbose);
37
38 extern void proc_prettyprint_fault (int faultno, int verbose);
39
40 extern void proc_prettyprint_actionset (struct sigaction *actions,
41                                         int verbose);
42
43 extern void proc_prettyfprint_signalset (FILE *file, sigset_t *sigset,
44                                          int verbose);
45
46 extern void proc_prettyfprint_faultset (FILE *file, fltset_t *fltset,
47                                         int verbose);
48
49 extern void proc_prettyfprint_syscall (FILE *file, int num, int verbose);
50
51 extern void proc_prettyfprint_signal (FILE *file, int signo, int verbose);
52
53 extern void proc_prettyfprint_flags (FILE *file, unsigned long flags,
54                                      int verbose);
55
56 extern void proc_prettyfprint_why (FILE *file, unsigned long why, 
57                                    unsigned long what, int verbose);
58
59 extern void proc_prettyfprint_fault (FILE *file, int faultno, int verbose);
60
61 extern void proc_prettyfprint_syscalls (FILE *file, sysset_t *sysset,
62                                         int verbose);
63
64 extern void proc_prettyfprint_status (long, int, int, int);
65
66
67 /* From proc-flags.c */
68
69 /*
70  * Pretty-print the prstatus flags.
71  */
72
73 extern void proc_prettyprint_flags (unsigned long flags, int verbose);
74
75 extern void proc_prettyfprint_flags (FILE *file, unsigned long flags,
76                                      int verbose);
77
78
79 /* From proc-api.c */
80
81 /*
82  * Trace functions for /proc api.
83  */
84
85 extern  int   write_with_trace (int, void *, size_t, char *, int);
86 extern  off_t lseek_with_trace (int, off_t,  int,    char *, int);
87 extern  int   ioctl_with_trace (int, long, void *, char *, int);
88 extern  pid_t wait_with_trace  (int *, char *, int);
89 extern  int   open_with_trace  (char *, int, char *, int);
90 extern  int   close_with_trace (int, char *, int);
91 extern  void  procfs_note      (const char *, const char *, int);
92
93 #ifdef PROCFS_TRACE
94 /*
95  * Debugging code:
96  *
97  * These macros allow me to trace the system calls that we make
98  * to control the child process.  This is quite handy for comparing
99  * with the older version of procfs.
100  */
101
102 #define write(X,Y,Z)   write_with_trace (X, Y, Z, __FILE__, __LINE__)
103 #define lseek(X,Y,Z)   lseek_with_trace (X, Y, Z, __FILE__, __LINE__)
104 #define ioctl(X,Y,Z)   ioctl_with_trace (X, Y, Z, __FILE__, __LINE__)
105 #define open(X,Y)      open_with_trace  (X, Y,    __FILE__, __LINE__)
106 #define close(X)       close_with_trace (X,       __FILE__, __LINE__)
107 #define wait(X)        wait_with_trace  (X,       __FILE__, __LINE__)
108 #endif
109 #define PROCFS_NOTE(X) procfs_note      (X,       __FILE__, __LINE__)
110 #define PROC_PRETTYFPRINT_STATUS(X,Y,Z,T) \
111      proc_prettyfprint_status (X, Y, Z, T)
112
113 /* Define the type (and more importantly the width) of the control
114    word used to write to the /proc/PID/ctl file.  */
115 typedef long procfs_ctl_t;