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