lib/libc/sys/ptrace.2

   1 .\" $FreeBSD$
   2 .\"     $NetBSD: ptrace.2,v 1.2 1995/02/27 12:35:37 cgd Exp $
   3 .\"
   4 .\" This file is in the public domain.
   5 .Dd May 20, 2021
   6 .Dt PTRACE 2
   7 .Os
   8 .Sh NAME
   9 .Nm ptrace
  10 .Nd process tracing and debugging
  11 .Sh LIBRARY
  12 .Lb libc
  13 .Sh SYNOPSIS
  14 .In sys/types.h
  15 .In sys/ptrace.h
  16 .Ft int
  17 .Fn ptrace "int request" "pid_t pid" "caddr_t addr" "int data"
  18 .Sh DESCRIPTION
  19 The
  20 .Fn ptrace
  21 system call
  22 provides tracing and debugging facilities.
  23 It allows one process
  24 (the
  25 .Em tracing
  26 process)
  27 to control another
  28 (the
  29 .Em traced
  30 process).
  31 The tracing process must first attach to the traced process, and then
  32 issue a series of
  33 .Fn ptrace
  34 system calls to control the execution of the process, as well as access
  35 process memory and register state.
  36 For the duration of the tracing session, the traced process will be
  37 .Dq re-parented ,
  38 with its parent process ID (and resulting behavior)
  39 changed to the tracing process.
  40 It is permissible for a tracing process to attach to more than one
  41 other process at a time.
  42 When the tracing process has completed its work, it must detach the
  43 traced process; if a tracing process exits without first detaching all
  44 processes it has attached, those processes will be killed.
  45 .Pp
  46 Most of the time, the traced process runs normally, but when it
  47 receives a signal
  48 (see
  49 .Xr sigaction 2 ) ,
  50 it stops.
  51 The tracing process is expected to notice this via
  52 .Xr wait 2
  53 or the delivery of a
  54 .Dv SIGCHLD
  55 signal, examine the state of the stopped process, and cause it to
  56 terminate or continue as appropriate.
  57 The signal may be a normal process signal, generated as a result of
  58 traced process behavior, or use of the
  59 .Xr kill 2
  60 system call; alternatively, it may be generated by the tracing facility
  61 as a result of attaching, stepping by the tracing
  62 process,
  63 or an event in the traced process.
  64 The tracing process may choose to intercept the signal, using it to
  65 observe process behavior (such as
  66 .Dv SIGTRAP ) ,
  67 or forward the signal to the process if appropriate.
  68 The
  69 .Fn ptrace
  70 system call
  71 is the mechanism by which all this happens.
  72 .Pp
  73 A traced process may report additional signal stops corresponding to
  74 events in the traced process.
  75 These additional signal stops are reported as
  76 .Dv SIGTRAP
  77 or
  78 .Dv SIGSTOP
  79 signals.
  80 The tracing process can use the
  81 .Dv PT_LWPINFO
  82 request to determine which events are associated with a
  83 .Dv SIGTRAP
  84 or
  85 .Dv SIGSTOP
  86 signal.
  87 Note that multiple events may be associated with a single signal.
  88 For example, events indicated by the
  89 .Dv PL_FLAG_BORN ,
  90 .Dv PL_FLAG_FORKED ,
  91 and
  92 .Dv PL_FLAG_EXEC
  93 flags are also reported as a system call exit event
  94 .Pq Dv PL_FLAG_SCX .
  95 The signal stop for a new child process enabled via
  96 .Dv PTRACE_FORK
  97 will report a
  98 .Dv SIGSTOP
  99 signal.
 100 All other additional signal stops use
 101 .Dv SIGTRAP .
 102 .Sh DETACH AND TERMINATION
 103 .Pp
 104 Normally, exiting tracing process should wait for all pending
 105 debugging events and then detach from all alive traced processes
 106 before exiting using
 107 .Dv PT_DETACH
 108 request.
 109 If tracing process exits without detaching, for instance due to abnormal
 110 termination, the destiny of the traced children processes is determined
 111 by the
 112 .Dv kern.kill_on_debugger_exit
 113 sysctl control.
 114 .Pp
 115 If the control is set to the default value 1, such traced processes
 116 are terminated.
 117 If set to zero, kernel implicitly detaches traced processes.
 118 Traced processes are un-stopped if needed, and then continue the execution
 119 without tracing.
 120 Kernel drops any
 121 .Dv SIGTRAP
 122 signals queued to the traced children, which could be either generated by
 123 not yet consumed debug events, or sent by other means, the later should
 124 not be done anyway.
 125 .Sh TRACING EVENTS
 126 .Pp
 127 Each traced process has a tracing event mask.
 128 An event in the traced process only reports a
 129 signal stop if the corresponding flag is set in the tracing event mask.
 130 The current set of tracing event flags include:
 131 .Bl -tag -width "Dv PTRACE_SYSCALL"
 132 .It Dv PTRACE_EXEC
 133 Report a stop for a successful invocation of
 134 .Xr execve 2 .
 135 This event is indicated by the
 136 .Dv PL_FLAG_EXEC
 137 flag in the
 138 .Va pl_flags
 139 member of
 140 .Vt "struct ptrace_lwpinfo" .
 141 .It Dv PTRACE_SCE
 142 Report a stop on each system call entry.
 143 This event is indicated by the
 144 .Dv PL_FLAG_SCE
 145 flag in the
 146 .Va pl_flags
 147 member of
 148 .Vt "struct ptrace_lwpinfo" .
 149 .It Dv PTRACE_SCX
 150 Report a stop on each system call exit.
 151 This event is indicated by the
 152 .Dv PL_FLAG_SCX
 153 flag in the
 154 .Va pl_flags
 155 member of
 156 .Vt "struct ptrace_lwpinfo" .
 157 .It Dv PTRACE_SYSCALL
 158 Report stops for both system call entry and exit.
 159 .It Dv PTRACE_FORK
 160 This event flag controls tracing for new child processes of a traced process.
 161 .Pp
 162 When this event flag is enabled,
 163 new child processes will enable tracing and stop before executing their
 164 first instruction.
 165 The new child process will include the
 166 .Dv PL_FLAG_CHILD
 167 flag in the
 168 .Va pl_flags
 169 member of
 170 .Vt "struct ptrace_lwpinfo" .
 171 The traced process will report a stop that includes the
 172 .Dv PL_FLAG_FORKED
 173 flag.
 174 The process ID of the new child process will also be present in the
 175 .Va pl_child_pid
 176 member of
 177 .Vt "struct ptrace_lwpinfo" .
 178 If the new child process was created via
 179 .Xr vfork 2 ,
 180 the traced process's stop will also include the
 181 .Dv PL_FLAG_VFORKED
 182 flag.
 183 Note that new child processes will be attached with the default
 184 tracing event mask;
 185 they do not inherit the event mask of the traced process.
 186 .Pp
 187 When this event flag is not enabled,
 188 new child processes will execute without tracing enabled.
 189 .It Dv PTRACE_LWP
 190 This event flag controls tracing of LWP
 191 .Pq kernel thread
 192 creation and destruction.
 193 When this event is enabled,
 194 new LWPs will stop and report an event with
 195 .Dv PL_FLAG_BORN
 196 set before executing their first instruction,
 197 and exiting LWPs will stop and report an event with
 198 .Dv PL_FLAG_EXITED
 199 set before completing their termination.
 200 .Pp
 201 Note that new processes do not report an event for the creation of their
 202 initial thread,
 203 and exiting processes do not report an event for the termination of the
 204 last thread.
 205 .It Dv PTRACE_VFORK
 206 Report a stop event when a parent process resumes after a
 207 .Xr vfork 2 .
 208 .Pp
 209 When a thread in the traced process creates a new child process via
 210 .Xr vfork 2 ,
 211 the stop that reports
 212 .Dv PL_FLAG_FORKED
 213 and
 214 .Dv PL_FLAG_SCX
 215 occurs just after the child process is created,
 216 but before the thread waits for the child process to stop sharing process
 217 memory.
 218 If a debugger is not tracing the new child process,
 219 it must ensure that no breakpoints are enabled in the shared process
 220 memory before detaching from the new child process.
 221 This means that no breakpoints are enabled in the parent process either.
 222 .Pp
 223 The
 224 .Dv PTRACE_VFORK
 225 flag enables a new stop that indicates when the new child process stops
 226 sharing the process memory of the parent process.
 227 A debugger can reinsert breakpoints in the parent process and resume it
 228 in response to this event.
 229 This event is indicated by setting the
 230 .Dv PL_FLAG_VFORK_DONE
 231 flag.
 232 .El
 233 .Pp
 234 The default tracing event mask when attaching to a process via
 235 .Dv PT_ATTACH ,
 236 .Dv PT_TRACE_ME ,
 237 or
 238 .Dv PTRACE_FORK
 239 includes only
 240 .Dv PTRACE_EXEC
 241 events.
 242 All other event flags are disabled.
 243 .Sh PTRACE REQUESTS
 244 .Pp
 245 The
 246 .Fa request
 247 argument specifies what operation is being performed; the meaning of
 248 the rest of the arguments depends on the operation, but except for one
 249 special case noted below, all
 250 .Fn ptrace
 251 calls are made by the tracing process, and the
 252 .Fa pid
 253 argument specifies the process ID of the traced process
 254 or a corresponding thread ID.
 255 The
 256 .Fa request
 257 argument
 258 can be:
 259 .Bl -tag -width "Dv PT_GET_EVENT_MASK"
 260 .It Dv PT_TRACE_ME
 261 This request is the only one used by the traced process; it declares
 262 that the process expects to be traced by its parent.
 263 All the other arguments are ignored.
 264 (If the parent process does not expect to trace the child, it will
 265 probably be rather confused by the results; once the traced process
 266 stops, it cannot be made to continue except via
 267 .Fn ptrace . )
 268 When a process has used this request and calls
 269 .Xr execve 2
 270 or any of the routines built on it
 271 (such as
 272 .Xr execv 3 ) ,
 273 it will stop before executing the first instruction of the new image.
 274 Also, any setuid or setgid bits on the executable being executed will
 275 be ignored.
 276 If the child was created by
 277 .Xr vfork 2
 278 system call or
 279 .Xr rfork 2
 280 call with the
 281 .Dv RFMEM
 282 flag specified, the debugging events are reported to the parent
 283 only after the
 284 .Xr execve 2
 285 is executed.
 286 .It Dv PT_READ_I , Dv PT_READ_D
 287 These requests read a single
 288 .Vt int
 289 of data from the traced process's address space.
 290 Traditionally,
 291 .Fn ptrace
 292 has allowed for machines with distinct address spaces for instruction
 293 and data, which is why there are two requests: conceptually,
 294 .Dv PT_READ_I
 295 reads from the instruction space and
 296 .Dv PT_READ_D
 297 reads from the data space.
 298 In the current
 299 .Fx
 300 implementation, these two requests are completely identical.
 301 The
 302 .Fa addr
 303 argument specifies the address
 304 (in the traced process's virtual address space)
 305 at which the read is to be done.
 306 This address does not have to meet any alignment constraints.
 307 The value read is returned as the return value from
 308 .Fn ptrace .
 309 .It Dv PT_WRITE_I , Dv PT_WRITE_D
 310 These requests parallel
 311 .Dv PT_READ_I
 312 and
 313 .Dv PT_READ_D ,
 314 except that they write rather than read.
 315 The
 316 .Fa data
 317 argument supplies the value to be written.
 318 .It Dv PT_IO
 319 This request allows reading and writing arbitrary amounts of data in
 320 the traced process's address space.
 321 The
 322 .Fa addr
 323 argument specifies a pointer to a
 324 .Vt "struct ptrace_io_desc" ,
 325 which is defined as follows:
 326 .Bd -literal
 327 struct ptrace_io_desc {
 328         int     piod_op;        /* I/O operation */
 329         void    *piod_offs;     /* child offset */
 330         void    *piod_addr;     /* parent offset */
 331         size_t  piod_len;       /* request length */
 332 };
 333
 334 /*
 335  * Operations in piod_op.
 336  */
 337 #define PIOD_READ_D     1       /* Read from D space */
 338 #define PIOD_WRITE_D    2       /* Write to D space */
 339 #define PIOD_READ_I     3       /* Read from I space */
 340 #define PIOD_WRITE_I    4       /* Write to I space */
 341 .Ed
 342 .Pp
 343 The
 344 .Fa data
 345 argument is ignored.
 346 The actual number of bytes read or written is stored in
 347 .Va piod_len
 348 upon return.
 349 .It Dv PT_CONTINUE
 350 The traced process continues execution.
 351 The
 352 .Fa addr
 353 argument
 354 is an address specifying the place where execution is to be resumed
 355 (a new value for the program counter),
 356 or
 357 .Po Vt caddr_t Pc Ns 1
 358 to indicate that execution is to pick up where it left off.
 359 The
 360 .Fa data
 361 argument
 362 provides a signal number to be delivered to the traced process as it
 363 resumes execution, or 0 if no signal is to be sent.
 364 .It Dv PT_STEP
 365 The traced process is single stepped one instruction.
 366 The
 367 .Fa addr
 368 argument
 369 should be passed
 370 .Po Vt caddr_t Pc Ns 1 .
 371 The
 372 .Fa data
 373 argument
 374 provides a signal number to be delivered to the traced process as it
 375 resumes execution, or 0 if no signal is to be sent.
 376 .It Dv PT_KILL
 377 The traced process terminates, as if
 378 .Dv PT_CONTINUE
 379 had been used with
 380 .Dv SIGKILL
 381 given as the signal to be delivered.
 382 .It Dv PT_ATTACH
 383 This request allows a process to gain control of an otherwise
 384 unrelated process and begin tracing it.
 385 It does not need any cooperation from the to-be-traced process.
 386 In
 387 this case,
 388 .Fa pid
 389 specifies the process ID of the to-be-traced process, and the other
 390 two arguments are ignored.
 391 This request requires that the target process must have the same real
 392 UID as the tracing process, and that it must not be executing a setuid
 393 or setgid executable.
 394 (If the tracing process is running as root, these restrictions do not
 395 apply.)
 396 The tracing process will see the newly-traced process stop and may
 397 then control it as if it had been traced all along.
 398 .It Dv PT_DETACH
 399 This request is like PT_CONTINUE, except that it does not allow
 400 specifying an alternate place to continue execution, and after it
 401 succeeds, the traced process is no longer traced and continues
 402 execution normally.
 403 .It Dv PT_GETREGS
 404 This request reads the traced process's machine registers into the
 405 .Do
 406 .Vt "struct reg"
 407 .Dc
 408 (defined in
 409 .In machine/reg.h )
 410 pointed to by
 411 .Fa addr .
 412 .It Dv PT_SETREGS
 413 This request is the converse of
 414 .Dv PT_GETREGS ;
 415 it loads the traced process's machine registers from the
 416 .Do
 417 .Vt "struct reg"
 418 .Dc
 419 (defined in
 420 .In machine/reg.h )
 421 pointed to by
 422 .Fa addr .
 423 .It Dv PT_GETFPREGS
 424 This request reads the traced process's floating-point registers into
 425 the
 426 .Do
 427 .Vt "struct fpreg"
 428 .Dc
 429 (defined in
 430 .In machine/reg.h )
 431 pointed to by
 432 .Fa addr .
 433 .It Dv PT_SETFPREGS
 434 This request is the converse of
 435 .Dv PT_GETFPREGS ;
 436 it loads the traced process's floating-point registers from the
 437 .Do
 438 .Vt "struct fpreg"
 439 .Dc
 440 (defined in
 441 .In machine/reg.h )
 442 pointed to by
 443 .Fa addr .
 444 .It Dv PT_GETDBREGS
 445 This request reads the traced process's debug registers into
 446 the
 447 .Do
 448 .Vt "struct dbreg"
 449 .Dc
 450 (defined in
 451 .In machine/reg.h )
 452 pointed to by
 453 .Fa addr .
 454 .It Dv PT_SETDBREGS
 455 This request is the converse of
 456 .Dv PT_GETDBREGS ;
 457 it loads the traced process's debug registers from the
 458 .Do
 459 .Vt "struct dbreg"
 460 .Dc
 461 (defined in
 462 .In machine/reg.h )
 463 pointed to by
 464 .Fa addr .
 465 .It Dv PT_LWPINFO
 466 This request can be used to obtain information about the kernel thread,
 467 also known as light-weight process, that caused the traced process to stop.
 468 The
 469 .Fa addr
 470 argument specifies a pointer to a
 471 .Vt "struct ptrace_lwpinfo" ,
 472 which is defined as follows:
 473 .Bd -literal
 474 struct ptrace_lwpinfo {
 475         lwpid_t pl_lwpid;
 476         int     pl_event;
 477         int     pl_flags;
 478         sigset_t pl_sigmask;
 479         sigset_t pl_siglist;
 480         siginfo_t pl_siginfo;
 481         char    pl_tdname[MAXCOMLEN + 1];
 482         pid_t   pl_child_pid;
 483         u_int   pl_syscall_code;
 484         u_int   pl_syscall_narg;
 485 };
 486 .Ed
 487 .Pp
 488 The
 489 .Fa data
 490 argument is to be set to the size of the structure known to the caller.
 491 This allows the structure to grow without affecting older programs.
 492 .Pp
 493 The fields in the
 494 .Vt "struct ptrace_lwpinfo"
 495 have the following meaning:
 496 .Bl -tag -width indent -compact
 497 .It Va pl_lwpid
 498 LWP id of the thread
 499 .It Va pl_event
 500 Event that caused the stop.
 501 Currently defined events are:
 502 .Bl -tag -width "Dv PL_EVENT_SIGNAL" -compact
 503 .It Dv PL_EVENT_NONE
 504 No reason given
 505 .It Dv PL_EVENT_SIGNAL
 506 Thread stopped due to the pending signal
 507 .El
 508 .It Va pl_flags
 509 Flags that specify additional details about observed stop.
 510 Currently defined flags are:
 511 .Bl -tag -width indent -compact
 512 .It Dv PL_FLAG_SCE
 513 The thread stopped due to system call entry, right after the kernel is entered.
 514 The debugger may examine syscall arguments that are stored in memory and
 515 registers according to the ABI of the current process, and modify them,
 516 if needed.
 517 .It Dv PL_FLAG_SCX
 518 The thread is stopped immediately before syscall is returning to the usermode.
 519 The debugger may examine system call return values in the ABI-defined registers
 520 and/or memory.
 521 .It Dv PL_FLAG_EXEC
 522 When
 523 .Dv PL_FLAG_SCX
 524 is set, this flag may be additionally specified to inform that the
 525 program being executed by debuggee process has been changed by successful
 526 execution of a system call from the
 527 .Fn execve 2
 528 family.
 529 .It Dv PL_FLAG_SI
 530 Indicates that
 531 .Va pl_siginfo
 532 member of
 533 .Vt "struct ptrace_lwpinfo"
 534 contains valid information.
 535 .It Dv PL_FLAG_FORKED
 536 Indicates that the process is returning from a call to
 537 .Fn fork 2
 538 that created a new child process.
 539 The process identifier of the new process is available in the
 540 .Va pl_child_pid
 541 member of
 542 .Vt "struct ptrace_lwpinfo" .
 543 .It Dv PL_FLAG_CHILD
 544 The flag is set for first event reported from a new child which is
 545 automatically attached when
 546 .Dv PTRACE_FORK
 547 is enabled.
 548 .It Dv PL_FLAG_BORN
 549 This flag is set for the first event reported from a new LWP when
 550 .Dv PTRACE_LWP
 551 is enabled.
 552 It is reported along with
 553 .Dv PL_FLAG_SCX .
 554 .It Dv PL_FLAG_EXITED
 555 This flag is set for the last event reported by an exiting LWP when
 556 .Dv PTRACE_LWP
 557 is enabled.
 558 Note that this event is not reported when the last LWP in a process exits.
 559 The termination of the last thread is reported via a normal process exit
 560 event.
 561 .It Dv PL_FLAG_VFORKED
 562 Indicates that the thread is returning from a call to
 563 .Xr vfork 2
 564 that created a new child process.
 565 This flag is set in addition to
 566 .Dv PL_FLAG_FORKED .
 567 .It Dv PL_FLAG_VFORK_DONE
 568 Indicates that the thread has resumed after a child process created via
 569 .Xr vfork 2
 570 has stopped sharing its address space with the traced process.
 571 .El
 572 .It Va pl_sigmask
 573 The current signal mask of the LWP
 574 .It Va pl_siglist
 575 The current pending set of signals for the LWP.
 576 Note that signals that are delivered to the process would not appear
 577 on an LWP siglist until the thread is selected for delivery.
 578 .It Va pl_siginfo
 579 The siginfo that accompanies the signal pending.
 580 Only valid for
 581 .Dv PL_EVENT_SIGNAL
 582 stop when
 583 .Dv PL_FLAG_SI
 584 is set in
 585 .Va pl_flags .
 586 .It Va pl_tdname
 587 The name of the thread.
 588 .It Va pl_child_pid
 589 The process identifier of the new child process.
 590 Only valid for a
 591 .Dv PL_EVENT_SIGNAL
 592 stop when
 593 .Dv PL_FLAG_FORKED
 594 is set in
 595 .Va pl_flags .
 596 .It Va pl_syscall_code
 597 The ABI-specific identifier of the current system call.
 598 Note that for indirect system calls this field reports the indirected
 599 system call.
 600 Only valid when
 601 .Dv PL_FLAG_SCE
 602 or
 603 .Dv PL_FLAG_SCX
 604 is set in
 605 .Va pl_flags .
 606 .It Va pl_syscall_narg
 607 The number of arguments passed to the current system call not counting
 608 the system call identifier.
 609 Note that for indirect system calls this field reports the arguments
 610 passed to the indirected system call.
 611 Only valid when
 612 .Dv PL_FLAG_SCE
 613 or
 614 .Dv PL_FLAG_SCX
 615 is set in
 616 .Va pl_flags .
 617 .El
 618 .It Dv PT_GETNUMLWPS
 619 This request returns the number of kernel threads associated with the
 620 traced process.
 621 .It Dv PT_GETLWPLIST
 622 This request can be used to get the current thread list.
 623 A pointer to an array of type
 624 .Vt lwpid_t
 625 should be passed in
 626 .Fa addr ,
 627 with the array size specified by
 628 .Fa data .
 629 The return value from
 630 .Fn ptrace
 631 is the count of array entries filled in.
 632 .It Dv PT_SETSTEP
 633 This request will turn on single stepping of the specified process.
 634 Stepping is automatically disabled when a single step trap is caught.
 635 .It Dv PT_CLEARSTEP
 636 This request will turn off single stepping of the specified process.
 637 .It Dv PT_SUSPEND
 638 This request will suspend the specified thread.
 639 .It Dv PT_RESUME
 640 This request will resume the specified thread.
 641 .It Dv PT_TO_SCE
 642 This request will set the
 643 .Dv PTRACE_SCE
 644 event flag to trace all future system call entries and continue the process.
 645 The
 646 .Fa addr
 647 and
 648 .Fa data
 649 arguments are used the same as for
 650 .Dv PT_CONTINUE .
 651 .It Dv PT_TO_SCX
 652 This request will set the
 653 .Dv PTRACE_SCX
 654 event flag to trace all future system call exits and continue the process.
 655 The
 656 .Fa addr
 657 and
 658 .Fa data
 659 arguments are used the same as for
 660 .Dv PT_CONTINUE .
 661 .It Dv PT_SYSCALL
 662 This request will set the
 663 .Dv PTRACE_SYSCALL
 664 event flag to trace all future system call entries and exits and continue
 665 the process.
 666 The
 667 .Fa addr
 668 and
 669 .Fa data
 670 arguments are used the same as for
 671 .Dv PT_CONTINUE .
 672 .It Dv PT_GET_SC_ARGS
 673 For the thread which is stopped in either
 674 .Dv PL_FLAG_SCE
 675 or
 676 .Dv PL_FLAG_SCX
 677 state, that is, on entry or exit to a syscall,
 678 this request fetches the syscall arguments.
 679 .Pp
 680 The arguments are copied out into the buffer pointed to by the
 681 .Fa addr
 682 pointer, sequentially.
 683 Each syscall argument is stored as the machine word.
 684 Kernel copies out as many arguments as the syscall accepts,
 685 see the
 686 .Va pl_syscall_narg
 687 member of the
 688 .Vt struct ptrace_lwpinfo ,
 689 but not more than the
 690 .Fa data
 691 bytes in total are copied.
 692 .It Dv PT_GET_SC_RET
 693 Fetch the system call return values on exit from a syscall.
 694 This request is only valid for threads stopped in a syscall
 695 exit (the
 696 .Dv PL_FLAG_SCX
 697 state).
 698 The
 699 .Fa addr
 700 argument specifies a pointer to a
 701 .Vt "struct ptrace_sc_ret" ,
 702 which is defined as follows:
 703 .Bd -literal
 704 struct ptrace_sc_ret {
 705         register_t      sr_retval[2];
 706         int             sr_error;
 707 };
 708 .Ed
 709 .Pp
 710 The
 711 .Fa data
 712 argument is set to the size of the structure.
 713 .Pp
 714 If the system call completed successfully,
 715 .Va sr_error
 716 is set to zero and the return values of the system call are saved in
 717 .Va sr_retval .
 718 If the system call failed to execute,
 719 .Va sr_error
 720 field is set to a positive
 721 .Xr errno 2
 722 value.
 723 If the system call completed in an unusual fashion,
 724 .Va sr_error
 725 is set to a negative value:
 726 .Bl -tag -width Dv EJUSTRETURN -compact
 727 .It Dv ERESTART
 728 System call will be restarted.
 729 .It Dv EJUSTRETURN
 730 System call completed sucessfully but did not set a return value
 731 .Po for example,
 732 .Xr setcontext 2
 733 and
 734 .Xr sigreturn 2
 735 .Pc .
 736 .El
 737 .It Dv PT_FOLLOW_FORK
 738 This request controls tracing for new child processes of a traced process.
 739 If
 740 .Fa data
 741 is non-zero,
 742 .Dv PTRACE_FORK
 743 is set in the traced process's event tracing mask.
 744 If
 745 .Fa data
 746 is zero,
 747 .Dv PTRACE_FORK
 748 is cleared from the traced process's event tracing mask.
 749 .It Dv PT_LWP_EVENTS
 750 This request controls tracing of LWP creation and destruction.
 751 If
 752 .Fa data
 753 is non-zero,
 754 .Dv PTRACE_LWP
 755 is set in the traced process's event tracing mask.
 756 If
 757 .Fa data
 758 is zero,
 759 .Dv PTRACE_LWP
 760 is cleared from the traced process's event tracing mask.
 761 .It Dv PT_GET_EVENT_MASK
 762 This request reads the traced process's event tracing mask into the
 763 integer pointed to by
 764 .Fa addr .
 765 The size of the integer must be passed in
 766 .Fa data .
 767 .It Dv PT_SET_EVENT_MASK
 768 This request sets the traced process's event tracing mask from the
 769 integer pointed to by
 770 .Fa addr .
 771 The size of the integer must be passed in
 772 .Fa data .
 773 .It Dv PT_VM_TIMESTAMP
 774 This request returns the generation number or timestamp of the memory map of
 775 the traced process as the return value from
 776 .Fn ptrace .
 777 This provides a low-cost way for the tracing process to determine if the
 778 VM map changed since the last time this request was made.
 779 .It Dv PT_VM_ENTRY
 780 This request is used to iterate over the entries of the VM map of the traced
 781 process.
 782 The
 783 .Fa addr
 784 argument specifies a pointer to a
 785 .Vt "struct ptrace_vm_entry" ,
 786 which is defined as follows:
 787 .Bd -literal
 788 struct ptrace_vm_entry {
 789         int             pve_entry;
 790         int             pve_timestamp;
 791         u_long          pve_start;
 792         u_long          pve_end;
 793         u_long          pve_offset;
 794         u_int           pve_prot;
 795         u_int           pve_pathlen;
 796         long            pve_fileid;
 797         uint32_t        pve_fsid;
 798         char            *pve_path;
 799 };
 800 .Ed
 801 .Pp
 802 The first entry is returned by setting
 803 .Va pve_entry
 804 to zero.
 805 Subsequent entries are returned by leaving
 806 .Va pve_entry
 807 unmodified from the value returned by previous requests.
 808 The
 809 .Va pve_timestamp
 810 field can be used to detect changes to the VM map while iterating over the
 811 entries.
 812 The tracing process can then take appropriate action, such as restarting.
 813 By setting
 814 .Va pve_pathlen
 815 to a non-zero value on entry, the pathname of the backing object is returned
 816 in the buffer pointed to by
 817 .Va pve_path ,
 818 provided the entry is backed by a vnode.
 819 The
 820 .Va pve_pathlen
 821 field is updated with the actual length of the pathname (including the
 822 terminating null character).
 823 The
 824 .Va pve_offset
 825 field is the offset within the backing object at which the range starts.
 826 The range is located in the VM space at
 827 .Va pve_start
 828 and extends up to
 829 .Va pve_end
 830 (inclusive).
 831 .Pp
 832 The
 833 .Fa data
 834 argument is ignored.
 835 .It Dv PT_COREDUMP
 836 This request creates a coredump for the stopped program.
 837 The
 838 .Fa addr
 839 argument specifies a pointer to a
 840 .Vt "struct ptrace_coredump" ,
 841 which is defined as follows:
 842 .Bd -literal
 843 struct ptrace_coredump {
 844         int             pc_fd;
 845         uint32_t        pc_flags;
 846         off_t           pc_limit;
 847 };
 848 .Ed
 849 The fields of the structure are:
 850 .Bl -tag -width pc_flags
 851 .It Dv pc_fd
 852 File descriptor to write the dump to.
 853 It must refer to a regular file, opened for writing.
 854 .It Dv pc_flags
 855 Flags.
 856 The following flags are defined:
 857 .Bl -tag -width PC_COMPRESS
 858 .It Dv PC_COMPRESS
 859 Request compression of the dump.
 860 .It Dv PC_ALL
 861 Include non-dumpable entries into the dump.
 862 The dumper ignores
 863 .Dv MAP_NOCORE
 864 flag of the process map entry, but device mappings are not dumped even with
 865 .Dv PC_ALL
 866 set.
 867 .El
 868 .It Dv pc_limit
 869 Maximum size of the coredump.
 870 Specify zero for no limit.
 871 .El
 872 .Pp
 873 The size of
 874 .Vt "struct ptrace_coredump"
 875 must be passed in
 876 .Fa data .
 877 .Pp
 878 The process must be stopped before dumping core.
 879 A single thread in the target process is temporarily unsuspended
 880 in kernel to write the dump.
 881 If the
 882 .Nm
 883 call fails before a thread is unsuspended, there is no event to
 884 .Xr waitpid 2
 885 for.
 886 If a thread was unsuspended, it will stop again before the
 887 .Nm
 888 call returns, and the process must be waited upon using
 889 .Xr waitpid 2
 890 to consume the new stop event.
 891 Since it is hard to deduce whether a thread was unsuspended before
 892 an error occurred, it is recommended to unconditionally perform
 893 .Xr waitpid 2
 894 with
 895 .Dv WNOHANG
 896 flag after
 897 .Dv PT_COREDUMP ,
 898 and silently accept zero result from it.
 899 .El
 900 .Sh ARM MACHINE-SPECIFIC REQUESTS
 901 .Bl -tag -width "Dv PT_SETVFPREGS"
 902 .It Dv PT_GETVFPREGS
 903 Return the thread's
 904 .Dv VFP
 905 machine state in the buffer pointed to by
 906 .Fa addr .
 907 .Pp
 908 The
 909 .Fa data
 910 argument is ignored.
 911 .It Dv PT_SETVFPREGS
 912 Set the thread's
 913 .Dv VFP
 914 machine state from the buffer pointed to by
 915 .Fa addr .
 916 .Pp
 917 The
 918 .Fa data
 919 argument is ignored.
 920 .El
 921 .Sh x86 MACHINE-SPECIFIC REQUESTS
 922 .Bl -tag -width "Dv PT_GETXSTATE_INFO"
 923 .It Dv PT_GETXMMREGS
 924 Copy the XMM FPU state into the buffer pointed to by the
 925 argument
 926 .Fa addr .
 927 The buffer has the same layout as the 32-bit save buffer for the
 928 machine instruction
 929 .Dv FXSAVE .
 930 .Pp
 931 This request is only valid for i386 programs, both on native 32-bit
 932 systems and on amd64 kernels.
 933 For 64-bit amd64 programs, the XMM state is reported as part of
 934 the FPU state returned by the
 935 .Dv PT_GETFPREGS
 936 request.
 937 .Pp
 938 The
 939 .Fa data
 940 argument is ignored.
 941 .It Dv PT_SETXMMREGS
 942 Load the XMM FPU state for the thread from the buffer pointed to
 943 by the argument
 944 .Fa addr .
 945 The buffer has the same layout as the 32-bit load buffer for the
 946 machine instruction
 947 .Dv FXRSTOR .
 948 .Pp
 949 As with
 950 .Dv PT_GETXMMREGS ,
 951 this request is only valid for i386 programs.
 952 .Pp
 953 The
 954 .Fa data
 955 argument is ignored.
 956 .It Dv PT_GETXSTATE_INFO
 957 Report which XSAVE FPU extensions are supported by the CPU
 958 and allowed in userspace programs.
 959 The
 960 .Fa addr
 961 argument must point to a variable of type
 962 .Vt struct ptrace_xstate_info ,
 963 which contains the information on the request return.
 964 .Vt struct ptrace_xstate_info
 965 is defined as follows:
 966 .Bd -literal
 967 struct ptrace_xstate_info {
 968         uint64_t        xsave_mask;
 969         uint32_t        xsave_len;
 970 };
 971 .Ed
 972 The
 973 .Dv xsave_mask
 974 field is a bitmask of the currently enabled extensions.
 975 The meaning of the bits is defined in the Intel and AMD
 976 processor documentation.
 977 The
 978 .Dv xsave_len
 979 field reports the length of the XSAVE area for storing the hardware
 980 state for currently enabled extensions in the format defined by the x86
 981 .Dv XSAVE
 982 machine instruction.
 983 .Pp
 984 The
 985 .Fa data
 986 argument value must be equal to the size of the
 987 .Vt struct ptrace_xstate_info .
 988 .It Dv PT_GETXSTATE
 989 Return the content of the XSAVE area for the thread.
 990 The
 991 .Fa addr
 992 argument points to the buffer where the content is copied, and the
 993 .Fa data
 994 argument specifies the size of the buffer.
 995 The kernel copies out as much content as allowed by the buffer size.
 996 The buffer layout is specified by the layout of the save area for the
 997 .Dv XSAVE
 998 machine instruction.
 999 .It Dv PT_SETXSTATE
1000 Load the XSAVE state for the thread from the buffer specified by the
1001 .Fa addr
1002 pointer.
1003 The buffer size is passed in the
1004 .Fa data
1005 argument.
1006 The buffer must be at least as large as the
1007 .Vt struct savefpu
1008 (defined in
1009 .Pa x86/fpu.h )
1010 to allow the complete x87 FPU and XMM state load.
1011 It must not be larger than the XSAVE state length, as reported by the
1012 .Dv xsave_len
1013 field from the
1014 .Vt struct ptrace_xstate_info
1015 of the
1016 .Dv PT_GETXSTATE_INFO
1017 request.
1018 Layout of the buffer is identical to the layout of the load area for the
1019 .Dv XRSTOR
1020 machine instruction.
1021 .It Dv PT_GETFSBASE
1022 Return the value of the base used when doing segmented
1023 memory addressing using the %fs segment register.
1024 The
1025 .Fa addr
1026 argument points to an
1027 .Vt unsigned long
1028 variable where the base value is stored.
1029 .Pp
1030 The
1031 .Fa data
1032 argument is ignored.
1033 .It Dv PT_GETGSBASE
1034 Like the
1035 .Dv PT_GETFSBASE
1036 request, but returns the base for the %gs segment register.
1037 .It Dv PT_SETFSBASE
1038 Set the base for the %fs segment register to the value pointed to
1039 by the
1040 .Fa addr
1041 argument.
1042 .Fa addr
1043 must point to the
1044 .Vt unsigned long
1045 variable containing the new base.
1046 .Pp
1047 The
1048 .Fa data
1049 argument is ignored.
1050 .It Dv PT_SETGSBASE
1051 Like the
1052 .Dv PT_SETFSBASE
1053 request, but sets the base for the %gs segment register.
1054 .El
1055 .Sh PowerPC MACHINE-SPECIFIC REQUESTS
1056 .Bl -tag -width "Dv PT_SETVRREGS"
1057 .It Dv PT_GETVRREGS
1058 Return the thread's
1059 .Dv ALTIVEC
1060 machine state in the buffer pointed to by
1061 .Fa addr .
1062 .Pp
1063 The
1064 .Fa data
1065 argument is ignored.
1066 .It Dv PT_SETVRREGS
1067 Set the thread's
1068 .Dv ALTIVEC
1069 machine state from the buffer pointed to by
1070 .Fa addr .
1071 .Pp
1072 The
1073 .Fa data
1074 argument is ignored.
1075 .It Dv PT_GETVSRREGS
1076 Return doubleword 1 of the thread's
1077 .Dv VSX
1078 registers VSR0-VSR31 in the buffer pointed to by
1079 .Fa addr .
1080 .Pp
1081 The
1082 .Fa data
1083 argument is ignored.
1084 .It Dv PT_SETVSRREGS
1085 Set doubleword 1 of the thread's
1086 .Dv VSX
1087 registers VSR0-VSR31 from the buffer pointed to by
1088 .Fa addr .
1089 .Pp
1090 The
1091 .Fa data
1092 argument is ignored.
1093 .El
1094 .Pp
1095 Additionally, other machine-specific requests can exist.
1096 .Sh RETURN VALUES
1097 Most requests return 0 on success and \-1 on error.
1098 Some requests can cause
1099 .Fn ptrace
1100 to return
1101 \-1
1102 as a non-error value, among them are
1103 .Dv PT_READ_I
1104 and
1105 .Dv PT_READ_D ,
1106 which return the value read from the process memory on success.
1107 To disambiguate,
1108 .Va errno
1109 can be set to 0 before the call and checked afterwards.
1110 .Pp
1111 The current
1112 .Fn ptrace
1113 implementation always sets
1114 .Va errno
1115 to 0 before calling into the kernel, both for historic reasons and for
1116 consistency with other operating systems.
1117 It is recommended to assign zero to
1118 .Va errno
1119 explicitly for forward compatibility.
1120 .Sh ERRORS
1121 The
1122 .Fn ptrace
1123 system call may fail if:
1124 .Bl -tag -width Er
1125 .It Bq Er ESRCH
1126 .Bl -bullet -compact
1127 .It
1128 No process having the specified process ID exists.
1129 .El
1130 .It Bq Er EINVAL
1131 .Bl -bullet -compact
1132 .It
1133 A process attempted to use
1134 .Dv PT_ATTACH
1135 on itself.
1136 .It
1137 The
1138 .Fa request
1139 argument
1140 was not one of the legal requests.
1141 .It
1142 The signal number
1143 (in
1144 .Fa data )
1145 to
1146 .Dv PT_CONTINUE
1147 was neither 0 nor a legal signal number.
1148 .It
1149 .Dv PT_GETREGS ,
1150 .Dv PT_SETREGS ,
1151 .Dv PT_GETFPREGS ,
1152 .Dv PT_SETFPREGS ,
1153 .Dv PT_GETDBREGS ,
1154 or
1155 .Dv PT_SETDBREGS
1156 was attempted on a process with no valid register set.
1157 (This is normally true only of system processes.)
1158 .It
1159 .Dv PT_VM_ENTRY
1160 was given an invalid value for
1161 .Fa pve_entry .
1162 This can also be caused by changes to the VM map of the process.
1163 .It
1164 The size (in
1165 .Fa data )
1166 provided to
1167 .Dv PT_LWPINFO
1168 was less than or equal to zero, or larger than the
1169 .Vt ptrace_lwpinfo
1170 structure known to the kernel.
1171 .It
1172 The size (in
1173 .Fa data )
1174 provided to the x86-specific
1175 .Dv PT_GETXSTATE_INFO
1176 request was not equal to the size of the
1177 .Vt struct ptrace_xstate_info .
1178 .It
1179 The size (in
1180 .Fa data )
1181 provided to the x86-specific
1182 .Dv PT_SETXSTATE
1183 request was less than the size of the x87 plus the XMM save area.
1184 .It
1185 The size (in
1186 .Fa data )
1187 provided to the x86-specific
1188 .Dv PT_SETXSTATE
1189 request was larger than returned in the
1190 .Dv xsave_len
1191 member of the
1192 .Vt struct ptrace_xstate_info
1193 from the
1194 .Dv PT_GETXSTATE_INFO
1195 request.
1196 .It
1197 The base value, provided to the amd64-specific requests
1198 .Dv PT_SETFSBASE
1199 or
1200 .Dv PT_SETGSBASE ,
1201 pointed outside of the valid user address space.
1202 This error will not occur in 32-bit programs.
1203 .El
1204 .It Bq Er EBUSY
1205 .Bl -bullet -compact
1206 .It
1207 .Dv PT_ATTACH
1208 was attempted on a process that was already being traced.
1209 .It
1210 A request attempted to manipulate a process that was being traced by
1211 some process other than the one making the request.
1212 .It
1213 A request
1214 (other than
1215 .Dv PT_ATTACH )
1216 specified a process that was not stopped.
1217 .El
1218 .It Bq Er EPERM
1219 .Bl -bullet -compact
1220 .It
1221 A request
1222 (other than
1223 .Dv PT_ATTACH )
1224 attempted to manipulate a process that was not being traced at all.
1225 .It
1226 An attempt was made to use
1227 .Dv PT_ATTACH
1228 on a process in violation of the requirements listed under
1229 .Dv PT_ATTACH
1230 above.
1231 .El
1232 .It Bq Er ENOENT
1233 .Bl -bullet -compact
1234 .It
1235 .Dv PT_VM_ENTRY
1236 previously returned the last entry of the memory map.
1237 No more entries exist.
1238 .El
1239 .It Bq Er ENOMEM
1240 .Bl -bullet -compact
1241 .It
1242 A
1243 .Dv PT_READ_I,
1244 .Dv PT_READ_D,
1245 .Dv PT_WRITE_I, or
1246 .Dv PT_WRITE_D
1247 request attempted to access an invalid address, or a memory allocation failure
1248 occurred when accessing process memory.
1249 .El
1250 .It Bq Er ENAMETOOLONG
1251 .Bl -bullet -compact
1252 .It
1253 .Dv PT_VM_ENTRY
1254 cannot return the pathname of the backing object because the buffer is not big
1255 enough.
1256 .Fa pve_pathlen
1257 holds the minimum buffer size required on return.
1258 .El
1259 .El
1260 .Sh SEE ALSO
1261 .Xr execve 2 ,
1262 .Xr sigaction 2 ,
1263 .Xr wait 2 ,
1264 .Xr execv 3 ,
1265 .Xr i386_clr_watch 3 ,
1266 .Xr i386_set_watch 3
1267 .Sh HISTORY
1268 The
1269 .Fn ptrace
1270 function appeared in
1271 .At v6 .