1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
/* Machine independent support for Solaris /proc (process file system) for GDB.
Copyright (C) 1999-2023 Free Software Foundation, Inc.
Written by Michael Snyder at Cygnus Solutions.
Based on work by Fred Fish, Stu Grossman, Geoff Noer, and others.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
/*
* Pretty-print trace of api calls to the /proc api
*/
#include "defs.h"
#include "gdbcmd.h"
#include "completer.h"
#include <sys/types.h>
#include <sys/procfs.h>
#include <sys/proc.h> /* for struct proc */
#include <sys/user.h> /* for struct user */
#include <fcntl.h> /* for O_RDWR etc. */
#include "gdbsupport/gdb_wait.h"
#include "proc-utils.h"
/* Much of the information used in the /proc interface, particularly for
printing status information, is kept as tables of structures of the
following form. These tables can be used to map numeric values to
their symbolic names and to a string that describes their specific use. */
struct trans
{
long value; /* The numeric value */
const char *name; /* The equivalent symbolic value */
const char *desc; /* Short description of value */
};
static bool procfs_trace = false;
static FILE *procfs_file = NULL;
static std::string procfs_filename = "procfs_trace";
static void
prepare_to_trace (void)
{
if (procfs_trace) /* if procfs tracing turned on */
if (procfs_file == NULL) /* if output file not yet open */
procfs_file
= fopen (procfs_filename.c_str (), "a"); /* open output file */
}
static void
set_procfs_trace_cmd (const char *args, int from_tty,
struct cmd_list_element *c)
{
#if 0 /* not sure what I might actually need to do here, if anything */
if (procfs_file)
fflush (procfs_file);
#endif
}
static void
set_procfs_file_cmd (const char *args, int from_tty,
struct cmd_list_element *c)
{
/* Just changed the filename for procfs tracing.
If a file was already open, close it. */
if (procfs_file)
fclose (procfs_file);
procfs_file = NULL;
}
static struct trans rw_table[]
= { { PCAGENT, "PCAGENT", "create agent lwp with regs from argument" },
{ PCCFAULT, "PCCFAULT", "clear current fault" },
{ PCCSIG, "PCCSIG", "clear current signal" },
{ PCDSTOP, "PCDSTOP", "post stop request" },
{ PCKILL, "PCKILL", "post a signal" },
{ PCNICE, "PCNICE", "set nice priority" },
{ PCREAD, "PCREAD", "read from the address space" },
{ PCWRITE, "PCWRITE", "write to the address space" },
{ PCRUN, "PCRUN", "make process/lwp runnable" },
{ PCSASRS, "PCSASRS", "set ancillary state registers" },
{ PCSCRED, "PCSCRED", "set process credentials" },
{ PCSENTRY, "PCSENTRY", "set traced syscall entry set" },
{ PCSET, "PCSET", "set modes" },
{ PCSEXIT, "PCSEXIT", "set traced syscall exit set" },
{ PCSFAULT, "PCSFAULT", "set traced fault set" },
{ PCSFPREG, "PCSFPREG", "set floating point registers" },
{ PCSHOLD, "PCSHOLD", "set signal mask" },
{ PCSREG, "PCSREG", "set general registers" },
{ PCSSIG, "PCSSIG", "set current signal" },
{ PCSTOP, "PCSTOP", "post stop request and wait" },
{ PCSTRACE, "PCSTRACE", "set traced signal set" },
{ PCSVADDR, "PCSVADDR", "set pc virtual address" },
{ PCSXREG, "PCSXREG", "set extra registers" },
{ PCTWSTOP, "PCTWSTOP", "wait for stop, with timeout arg" },
{ PCUNKILL, "PCUNKILL", "delete a pending signal" },
{ PCUNSET, "PCUNSET", "unset modes" },
{ PCWATCH, "PCWATCH", "set/unset watched memory area" },
{ PCWSTOP, "PCWSTOP", "wait for process/lwp to stop, no timeout" },
{ 0, NULL, NULL } };
static off_t lseek_offset;
int
write_with_trace (int fd, void *varg, size_t len, char *file, int line)
{
int i = ARRAY_SIZE (rw_table) - 1;
int ret;
procfs_ctl_t *arg = (procfs_ctl_t *) varg;
prepare_to_trace ();
if (procfs_trace)
{
procfs_ctl_t opcode = arg[0];
for (i = 0; rw_table[i].name != NULL; i++)
if (rw_table[i].value == opcode)
break;
if (info_verbose)
fprintf (procfs_file ? procfs_file : stdout, "%s:%d -- ", file, line);
switch (opcode)
{
case PCSET:
fprintf (procfs_file ? procfs_file : stdout,
"write (PCSET, %s) %s\n",
arg[1] == PR_FORK ? "PR_FORK"
: arg[1] == PR_RLC ? "PR_RLC"
: arg[1] == PR_ASYNC ? "PR_ASYNC"
: "<unknown flag>",
info_verbose ? rw_table[i].desc : "");
break;
case PCUNSET:
fprintf (procfs_file ? procfs_file : stdout,
"write (PCRESET, %s) %s\n",
arg[1] == PR_FORK ? "PR_FORK"
: arg[1] == PR_RLC ? "PR_RLC"
: arg[1] == PR_ASYNC ? "PR_ASYNC"
: "<unknown flag>",
info_verbose ? rw_table[i].desc : "");
break;
case PCSTRACE:
fprintf (procfs_file ? procfs_file : stdout, "write (PCSTRACE) ");
proc_prettyfprint_signalset (procfs_file ? procfs_file : stdout,
(sigset_t *) &arg[1], 0);
break;
case PCSFAULT:
fprintf (procfs_file ? procfs_file : stdout, "write (PCSFAULT) ");
proc_prettyfprint_faultset (procfs_file ? procfs_file : stdout,
(fltset_t *) &arg[1], 0);
break;
case PCSENTRY:
fprintf (procfs_file ? procfs_file : stdout, "write (PCSENTRY) ");
proc_prettyfprint_syscalls (procfs_file ? procfs_file : stdout,
(sysset_t *) &arg[1], 0);
break;
case PCSEXIT:
fprintf (procfs_file ? procfs_file : stdout, "write (PCSEXIT) ");
proc_prettyfprint_syscalls (procfs_file ? procfs_file : stdout,
(sysset_t *) &arg[1], 0);
break;
case PCSHOLD:
fprintf (procfs_file ? procfs_file : stdout, "write (PCSHOLD) ");
proc_prettyfprint_signalset (procfs_file ? procfs_file : stdout,
(sigset_t *) &arg[1], 0);
break;
case PCSSIG:
fprintf (procfs_file ? procfs_file : stdout, "write (PCSSIG) ");
proc_prettyfprint_signal (procfs_file ? procfs_file : stdout,
arg[1] ? ((siginfo_t *) &arg[1])->si_signo
: 0,
0);
fprintf (procfs_file ? procfs_file : stdout, "\n");
break;
case PCRUN:
fprintf (procfs_file ? procfs_file : stdout, "write (PCRUN) ");
if (arg[1] & PRCSIG)
fprintf (procfs_file ? procfs_file : stdout, "clearSig ");
if (arg[1] & PRCFAULT)
fprintf (procfs_file ? procfs_file : stdout, "clearFlt ");
if (arg[1] & PRSTEP)
fprintf (procfs_file ? procfs_file : stdout, "step ");
if (arg[1] & PRSABORT)
fprintf (procfs_file ? procfs_file : stdout, "syscallAbort ");
if (arg[1] & PRSTOP)
fprintf (procfs_file ? procfs_file : stdout, "stopReq ");
fprintf (procfs_file ? procfs_file : stdout, "\n");
break;
case PCKILL:
fprintf (procfs_file ? procfs_file : stdout, "write (PCKILL) ");
proc_prettyfprint_signal (procfs_file ? procfs_file : stdout, arg[1],
0);
fprintf (procfs_file ? procfs_file : stdout, "\n");
break;
default:
{
if (rw_table[i].name)
fprintf (procfs_file ? procfs_file : stdout, "write (%s) %s\n",
rw_table[i].name, info_verbose ? rw_table[i].desc : "");
else
{
if (lseek_offset != -1)
fprintf (procfs_file ? procfs_file : stdout,
"write (<unknown>, %lud bytes at 0x%08lx) \n",
(unsigned long) len, (unsigned long) lseek_offset);
else
fprintf (procfs_file ? procfs_file : stdout,
"write (<unknown>, %lud bytes) \n",
(unsigned long) len);
}
break;
}
}
if (procfs_file)
fflush (procfs_file);
}
errno = 0;
ret = write (fd, (void *) arg, len);
if (procfs_trace && ret != len)
{
fprintf (procfs_file ? procfs_file : stdout,
"[write (%s) FAILED! (%s)]\n",
rw_table[i].name != NULL ? rw_table[i].name : "<unknown>",
safe_strerror (errno));
if (procfs_file)
fflush (procfs_file);
}
lseek_offset = -1;
return ret;
}
off_t
lseek_with_trace (int fd, off_t offset, int whence, char *file, int line)
{
off_t ret;
prepare_to_trace ();
errno = 0;
ret = lseek (fd, offset, whence);
lseek_offset = ret;
if (procfs_trace && (ret == -1 || errno != 0))
{
fprintf (procfs_file ? procfs_file : stdout,
"[lseek (0x%08lx) FAILED! (%s)]\n", (unsigned long) offset,
safe_strerror (errno));
if (procfs_file)
fflush (procfs_file);
}
return ret;
}
int
open_with_trace (char *filename, int mode, char *file, int line)
{
int ret;
prepare_to_trace ();
errno = 0;
ret = open (filename, mode);
if (procfs_trace)
{
if (info_verbose)
fprintf (procfs_file ? procfs_file : stdout, "%s:%d -- ", file, line);
if (errno)
{
fprintf (procfs_file ? procfs_file : stdout,
"[open FAILED! (%s) line %d]\\n", safe_strerror (errno),
line);
}
else
{
fprintf (procfs_file ? procfs_file : stdout, "%d = open (%s, ", ret,
filename);
if (mode == O_RDONLY)
fprintf (procfs_file ? procfs_file : stdout, "O_RDONLY) %d\n",
line);
else if (mode == O_WRONLY)
fprintf (procfs_file ? procfs_file : stdout, "O_WRONLY) %d\n",
line);
else if (mode == O_RDWR)
fprintf (procfs_file ? procfs_file : stdout, "O_RDWR) %d\n",
line);
}
if (procfs_file)
fflush (procfs_file);
}
return ret;
}
int
close_with_trace (int fd, char *file, int line)
{
int ret;
prepare_to_trace ();
errno = 0;
ret = close (fd);
if (procfs_trace)
{
if (info_verbose)
fprintf (procfs_file ? procfs_file : stdout, "%s:%d -- ", file, line);
if (errno)
fprintf (procfs_file ? procfs_file : stdout, "[close FAILED! (%s)]\n",
safe_strerror (errno));
else
fprintf (procfs_file ? procfs_file : stdout, "%d = close (%d)\n", ret,
fd);
if (procfs_file)
fflush (procfs_file);
}
return ret;
}
pid_t
wait_with_trace (int *wstat, char *file, int line)
{
int ret, lstat = 0;
prepare_to_trace ();
if (procfs_trace)
{
if (info_verbose)
fprintf (procfs_file ? procfs_file : stdout, "%s:%d -- ", file, line);
fprintf (procfs_file ? procfs_file : stdout, "wait (line %d) ", line);
if (procfs_file)
fflush (procfs_file);
}
errno = 0;
ret = wait (&lstat);
if (procfs_trace)
{
if (errno)
fprintf (procfs_file ? procfs_file : stdout, "[wait FAILED! (%s)]\n",
safe_strerror (errno));
else
fprintf (procfs_file ? procfs_file : stdout,
"returned pid %d, status 0x%x\n", ret, lstat);
if (procfs_file)
fflush (procfs_file);
}
if (wstat)
*wstat = lstat;
return ret;
}
void
procfs_note (const char *msg, const char *file, int line)
{
prepare_to_trace ();
if (procfs_trace)
{
if (info_verbose)
fprintf (procfs_file ? procfs_file : stdout, "%s:%d -- ", file, line);
fprintf (procfs_file ? procfs_file : stdout, "%s", msg);
if (procfs_file)
fflush (procfs_file);
}
}
void
proc_prettyfprint_status (long flags, int why, int what, int thread)
{
prepare_to_trace ();
if (procfs_trace)
{
if (thread)
fprintf (procfs_file ? procfs_file : stdout, "Thread %d: ", thread);
proc_prettyfprint_flags (procfs_file ? procfs_file : stdout, flags, 0);
if (flags & (PR_STOPPED | PR_ISTOP))
proc_prettyfprint_why (procfs_file ? procfs_file : stdout, why, what,
0);
if (procfs_file)
fflush (procfs_file);
}
}
void _initialize_proc_api ();
void
_initialize_proc_api ()
{
add_setshow_boolean_cmd ("procfs-trace", no_class, &procfs_trace, _ ("\
Set tracing for /proc api calls."),
_ ("\
Show tracing for /proc api calls."),
NULL, set_procfs_trace_cmd, NULL, /* FIXME: i18n: */
&setlist, &showlist);
add_setshow_filename_cmd ("procfs-file", no_class, &procfs_filename, _ ("\
Set filename for /proc tracefile."),
_ ("\
Show filename for /proc tracefile."),
NULL, set_procfs_file_cmd, NULL, /* FIXME: i18n: */
&setlist, &showlist);
}
|