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 December 29, 2015
   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, system calls, or stepping by the tracing
  62 process.
  63 The tracing process may choose to intercept the signal, using it to
  64 observe process behavior (such as
  65 .Dv SIGTRAP ) ,
  66 or forward the signal to the process if appropriate.
  67 The
  68 .Fn ptrace
  69 system call
  70 is the mechanism by which all this happens.
  71 .Pp
  72 The
  73 .Fa request
  74 argument specifies what operation is being performed; the meaning of
  75 the rest of the arguments depends on the operation, but except for one
  76 special case noted below, all
  77 .Fn ptrace
  78 calls are made by the tracing process, and the
  79 .Fa pid
  80 argument specifies the process ID of the traced process
  81 or a corresponding thread ID.
  82 The
  83 .Fa request
  84 argument
  85 can be:
  86 .Bl -tag -width 12n
  87 .It Dv PT_TRACE_ME
  88 This request is the only one used by the traced process; it declares
  89 that the process expects to be traced by its parent.
  90 All the other arguments are ignored.
  91 (If the parent process does not expect to trace the child, it will
  92 probably be rather confused by the results; once the traced process
  93 stops, it cannot be made to continue except via
  94 .Fn ptrace . )
  95 When a process has used this request and calls
  96 .Xr execve 2
  97 or any of the routines built on it
  98 (such as
  99 .Xr execv 3 ) ,
 100 it will stop before executing the first instruction of the new image.
 101 Also, any setuid or setgid bits on the executable being executed will
 102 be ignored.
 103 If the child was created by
 104 .Xr vfork 2
 105 system call or
 106 .Xr rfork(2)
 107 call with the
 108 .Dv RFMEM
 109 flag specified, the debugging events are reported to the parent
 110 only after the
 111 .Xr execve 2
 112 is executed.
 113 .It Dv PT_READ_I , Dv PT_READ_D
 114 These requests read a single
 115 .Vt int
 116 of data from the traced process's address space.
 117 Traditionally,
 118 .Fn ptrace
 119 has allowed for machines with distinct address spaces for instruction
 120 and data, which is why there are two requests: conceptually,
 121 .Dv PT_READ_I
 122 reads from the instruction space and
 123 .Dv PT_READ_D
 124 reads from the data space.
 125 In the current
 126 .Fx
 127 implementation, these two requests are completely identical.
 128 The
 129 .Fa addr
 130 argument specifies the address
 131 (in the traced process's virtual address space)
 132 at which the read is to be done.
 133 This address does not have to meet any alignment constraints.
 134 The value read is returned as the return value from
 135 .Fn ptrace .
 136 .It Dv PT_WRITE_I , Dv PT_WRITE_D
 137 These requests parallel
 138 .Dv PT_READ_I
 139 and
 140 .Dv PT_READ_D ,
 141 except that they write rather than read.
 142 The
 143 .Fa data
 144 argument supplies the value to be written.
 145 .It Dv PT_IO
 146 This request allows reading and writing arbitrary amounts of data in
 147 the traced process's address space.
 148 The
 149 .Fa addr
 150 argument specifies a pointer to a
 151 .Vt "struct ptrace_io_desc" ,
 152 which is defined as follows:
 153 .Bd -literal
 154 struct ptrace_io_desc {
 155         int     piod_op;        /* I/O operation */
 156         void    *piod_offs;     /* child offset */
 157         void    *piod_addr;     /* parent offset */
 158         size_t  piod_len;       /* request length */
 159 };
 160
 161 /*
 162  * Operations in piod_op.
 163  */
 164 #define PIOD_READ_D     1       /* Read from D space */
 165 #define PIOD_WRITE_D    2       /* Write to D space */
 166 #define PIOD_READ_I     3       /* Read from I space */
 167 #define PIOD_WRITE_I    4       /* Write to I space */
 168 .Ed
 169 .Pp
 170 The
 171 .Fa data
 172 argument is ignored.
 173 The actual number of bytes read or written is stored in
 174 .Va piod_len
 175 upon return.
 176 .It Dv PT_CONTINUE
 177 The traced process continues execution.
 178 The
 179 .Fa addr
 180 argument
 181 is an address specifying the place where execution is to be resumed
 182 (a new value for the program counter),
 183 or
 184 .Po Vt caddr_t Pc Ns 1
 185 to indicate that execution is to pick up where it left off.
 186 The
 187 .Fa data
 188 argument
 189 provides a signal number to be delivered to the traced process as it
 190 resumes execution, or 0 if no signal is to be sent.
 191 .It Dv PT_STEP
 192 The traced process is single stepped one instruction.
 193 The
 194 .Fa addr
 195 argument
 196 should be passed
 197 .Po Vt caddr_t Pc Ns 1 .
 198 The
 199 .Fa data
 200 argument
 201 provides a signal number to be delivered to the traced process as it
 202 resumes execution, or 0 if no signal is to be sent.
 203 .It Dv PT_KILL
 204 The traced process terminates, as if
 205 .Dv PT_CONTINUE
 206 had been used with
 207 .Dv SIGKILL
 208 given as the signal to be delivered.
 209 .It Dv PT_ATTACH
 210 This request allows a process to gain control of an otherwise
 211 unrelated process and begin tracing it.
 212 It does not need any cooperation from the to-be-traced process.
 213 In
 214 this case,
 215 .Fa pid
 216 specifies the process ID of the to-be-traced process, and the other
 217 two arguments are ignored.
 218 This request requires that the target process must have the same real
 219 UID as the tracing process, and that it must not be executing a setuid
 220 or setgid executable.
 221 (If the tracing process is running as root, these restrictions do not
 222 apply.)
 223 The tracing process will see the newly-traced process stop and may
 224 then control it as if it had been traced all along.
 225 .It Dv PT_DETACH
 226 This request is like PT_CONTINUE, except that it does not allow
 227 specifying an alternate place to continue execution, and after it
 228 succeeds, the traced process is no longer traced and continues
 229 execution normally.
 230 .It Dv PT_GETREGS
 231 This request reads the traced process's machine registers into the
 232 .Do
 233 .Vt "struct reg"
 234 .Dc
 235 (defined in
 236 .In machine/reg.h )
 237 pointed to by
 238 .Fa addr .
 239 .It Dv PT_SETREGS
 240 This request is the converse of
 241 .Dv PT_GETREGS ;
 242 it loads the traced process's machine registers from the
 243 .Do
 244 .Vt "struct reg"
 245 .Dc
 246 (defined in
 247 .In machine/reg.h )
 248 pointed to by
 249 .Fa addr .
 250 .It Dv PT_GETFPREGS
 251 This request reads the traced process's floating-point registers into
 252 the
 253 .Do
 254 .Vt "struct fpreg"
 255 .Dc
 256 (defined in
 257 .In machine/reg.h )
 258 pointed to by
 259 .Fa addr .
 260 .It Dv PT_SETFPREGS
 261 This request is the converse of
 262 .Dv PT_GETFPREGS ;
 263 it loads the traced process's floating-point registers from the
 264 .Do
 265 .Vt "struct fpreg"
 266 .Dc
 267 (defined in
 268 .In machine/reg.h )
 269 pointed to by
 270 .Fa addr .
 271 .It Dv PT_GETDBREGS
 272 This request reads the traced process's debug registers into
 273 the
 274 .Do
 275 .Vt "struct dbreg"
 276 .Dc
 277 (defined in
 278 .In machine/reg.h )
 279 pointed to by
 280 .Fa addr .
 281 .It Dv PT_SETDBREGS
 282 This request is the converse of
 283 .Dv PT_GETDBREGS ;
 284 it loads the traced process's debug registers from the
 285 .Do
 286 .Vt "struct dbreg"
 287 .Dc
 288 (defined in
 289 .In machine/reg.h )
 290 pointed to by
 291 .Fa addr .
 292 .It Dv PT_LWPINFO
 293 This request can be used to obtain information about the kernel thread,
 294 also known as light-weight process, that caused the traced process to stop.
 295 The
 296 .Fa addr
 297 argument specifies a pointer to a
 298 .Vt "struct ptrace_lwpinfo" ,
 299 which is defined as follows:
 300 .Bd -literal
 301 struct ptrace_lwpinfo {
 302         lwpid_t pl_lwpid;
 303         int     pl_event;
 304         int     pl_flags;
 305         sigset_t pl_sigmask;
 306         sigset_t pl_siglist;
 307         siginfo_t pl_siginfo;
 308         char    pl_tdname[MAXCOMLEN + 1];
 309         pid_t   pl_child_pid;
 310         u_int   pl_syscall_code;
 311         u_int   pl_syscall_narg;
 312 };
 313 .Ed
 314 .Pp
 315 The
 316 .Fa data
 317 argument is to be set to the size of the structure known to the caller.
 318 This allows the structure to grow without affecting older programs.
 319 .Pp
 320 The fields in the
 321 .Vt "struct ptrace_lwpinfo"
 322 have the following meaning:
 323 .Bl -tag -width indent -compact
 324 .It pl_lwpid
 325 LWP id of the thread
 326 .It pl_event
 327 Event that caused the stop.
 328 Currently defined events are
 329 .Bl -tag -width indent -compact
 330 .It PL_EVENT_NONE
 331 No reason given
 332 .It PL_EVENT_SIGNAL
 333 Thread stopped due to the pending signal
 334 .El
 335 .It pl_flags
 336 Flags that specify additional details about observed stop.
 337 Currently defined flags are:
 338 .Bl -tag -width indent -compact
 339 .It PL_FLAG_SCE
 340 The thread stopped due to system call entry, right after the kernel is entered.
 341 The debugger may examine syscall arguments that are stored in memory and
 342 registers according to the ABI of the current process, and modify them,
 343 if needed.
 344 .It PL_FLAG_SCX
 345 The thread is stopped immediately before syscall is returning to the usermode.
 346 The debugger may examine system call return values in the ABI-defined registers
 347 and/or memory.
 348 .It PL_FLAG_EXEC
 349 When
 350 .Dv PL_FLAG_SCX
 351 is set, this flag may be additionally specified to inform that the
 352 program being executed by debuggee process has been changed by successful
 353 execution of a system call from the
 354 .Fn execve 2
 355 family.
 356 .It PL_FLAG_SI
 357 Indicates that
 358 .Va pl_siginfo
 359 member of
 360 .Vt "struct ptrace_lwpinfo"
 361 contains valid information.
 362 .It PL_FLAG_FORKED
 363 Indicates that the process is returning from a call to
 364 .Fn fork 2
 365 that created a new child process.
 366 The process identifier of the new process is available in the
 367 .Va pl_child_pid
 368 member of
 369 .Vt "struct ptrace_lwpinfo" .
 370 .It PL_FLAG_CHILD
 371 The flag is set for first event reported from a new child, which is
 372 automatically attached due to
 373 .Dv PT_FOLLOW_FORK
 374 enabled.
 375 .It PL_FLAG_BORN
 376 This flag is set for the first event reported from a new LWP when LWP
 377 events are enabled via
 378 .Dv PT_LWP_EVENTS .
 379 It is reported along with
 380 .Dv PL_FLAG_SCX
 381 and is always reported if LWP events are enabled.
 382 .It PL_FLAG_EXITED
 383 This flag is set for the last event reported by an exiting LWP when
 384 LWP events are enabled via
 385 .Dv PT_LWP_EVENTS .
 386 Note that this event is not reported when the last LWP in a process exits.
 387 The termination of the last thread is reported via a normal process exit
 388 event.
 389 .El
 390 .It pl_sigmask
 391 The current signal mask of the LWP
 392 .It pl_siglist
 393 The current pending set of signals for the LWP.
 394 Note that signals that are delivered to the process would not appear
 395 on an LWP siglist until the thread is selected for delivery.
 396 .It pl_siginfo
 397 The siginfo that accompanies the signal pending.
 398 Only valid for
 399 .Dv PL_EVENT_SIGNAL
 400 stop when
 401 .Dv PL_FLAG_SI
 402 is set in
 403 .Va pl_flags .
 404 .It pl_tdname
 405 The name of the thread.
 406 .It pl_child_pid
 407 The process identifier of the new child process.
 408 Only valid for a
 409 .Dv PL_EVENT_SIGNAL
 410 stop when
 411 .Dv PL_FLAG_FORKED
 412 is set in
 413 .Va pl_flags .
 414 .It pl_syscall_code
 415 The ABI-specific identifier of the current system call.
 416 Note that for indirect system calls this field reports the indirected
 417 system call.
 418 Only valid when
 419 .Dv PL_FLAG_SCE
 420 or
 421 .Dv PL_FLAG_SCX
 422 is set in
 423 .Va pl_flags.
 424 .It pl_syscall_narg
 425 The number of arguments passed to the current system call not counting
 426 the system call identifier.
 427 Note that for indirect system calls this field reports the arguments
 428 passed to the indirected system call.
 429 Only valid when
 430 .Dv PL_FLAG_SCE
 431 or
 432 .Dv PL_FLAG_SCX
 433 is set in
 434 .Va pl_flags.
 435 .El
 436 .It PT_GETNUMLWPS
 437 This request returns the number of kernel threads associated with the
 438 traced process.
 439 .It PT_GETLWPLIST
 440 This request can be used to get the current thread list.
 441 A pointer to an array of type
 442 .Vt lwpid_t
 443 should be passed in
 444 .Fa addr ,
 445 with the array size specified by
 446 .Fa data .
 447 The return value from
 448 .Fn ptrace
 449 is the count of array entries filled in.
 450 .It PT_SETSTEP
 451 This request will turn on single stepping of the specified process.
 452 .It PT_CLEARSTEP
 453 This request will turn off single stepping of the specified process.
 454 .It PT_SUSPEND
 455 This request will suspend the specified thread.
 456 .It PT_RESUME
 457 This request will resume the specified thread.
 458 .It PT_TO_SCE
 459 This request will trace the specified process on each system call entry.
 460 .It PT_TO_SCX
 461 This request will trace the specified process on each system call exit.
 462 .It PT_SYSCALL
 463 This request will trace the specified process
 464 on each system call entry and exit.
 465 .It PT_FOLLOW_FORK
 466 This request controls tracing for new child processes of a traced process.
 467 If
 468 .Fa data
 469 is non-zero,
 470 then new child processes will enable tracing and stop before executing their
 471 first instruction.
 472 If
 473 .Fa data
 474 is zero, then new child processes will execute without tracing enabled.
 475 By default, tracing is not enabled for new child processes.
 476 Child processes do not inherit this property.
 477 The traced process will set the
 478 .Dv PL_FLAG_FORKED
 479 flag upon exit from a system call that creates a new process.
 480 .It PT_LWP_EVENTS
 481 This request controls tracing of LWP creation and destruction.
 482 If
 483 .Fa data
 484 is non-zero,
 485 then LWPs will stop to report creation and destruction events.
 486 If
 487 .Fa data
 488 is zero,
 489 then LWP creation and destruction events will not be reported.
 490 By default, tracing is not enabled for LWP events.
 491 Child processes do not inherit this property.
 492 New LWPs will stop to report an event with
 493 .Dv PL_FLAG_BORN
 494 set before executing their first instruction.
 495 Exiting LWPs will stop to report an event with
 496 .Dv PL_FLAG_EXITED
 497 set before completing their termination.
 498 .Pp
 499 Note that new processes do not report an event for the creation of their
 500 initial thread,
 501 and exiting processes do not report an event for the termination of the
 502 last thread.
 503 .It PT_VM_TIMESTAMP
 504 This request returns the generation number or timestamp of the memory map of
 505 the traced process as the return value from
 506 .Fn ptrace .
 507 This provides a low-cost way for the tracing process to determine if the
 508 VM map changed since the last time this request was made.
 509 .It PT_VM_ENTRY
 510 This request is used to iterate over the entries of the VM map of the traced
 511 process.
 512 The
 513 .Fa addr
 514 argument specifies a pointer to a
 515 .Vt "struct ptrace_vm_entry" ,
 516 which is defined as follows:
 517 .Bd -literal
 518 struct ptrace_vm_entry {
 519         int             pve_entry;
 520         int             pve_timestamp;
 521         u_long          pve_start;
 522         u_long          pve_end;
 523         u_long          pve_offset;
 524         u_int           pve_prot;
 525         u_int           pve_pathlen;
 526         long            pve_fileid;
 527         uint32_t        pve_fsid;
 528         char            *pve_path;
 529 };
 530 .Ed
 531 .Pp
 532 The first entry is returned by setting
 533 .Va pve_entry
 534 to zero.
 535 Subsequent entries are returned by leaving
 536 .Va pve_entry
 537 unmodified from the value returned by previous requests.
 538 The
 539 .Va pve_timestamp
 540 field can be used to detect changes to the VM map while iterating over the
 541 entries.
 542 The tracing process can then take appropriate action, such as restarting.
 543 By setting
 544 .Va pve_pathlen
 545 to a non-zero value on entry, the pathname of the backing object is returned
 546 in the buffer pointed to by
 547 .Va pve_path ,
 548 provided the entry is backed by a vnode.
 549 The
 550 .Va pve_pathlen
 551 field is updated with the actual length of the pathname (including the
 552 terminating null character).
 553 The
 554 .Va pve_offset
 555 field is the offset within the backing object at which the range starts.
 556 The range is located in the VM space at
 557 .Va pve_start
 558 and extends up to
 559 .Va pve_end
 560 (inclusive).
 561 .Pp
 562 The
 563 .Fa data
 564 argument is ignored.
 565 .El
 566 .Sh x86 MACHINE-SPECIFIC REQUESTS
 567 .Bl -tag -width "Dv PT_GETXSTATE_INFO"
 568 .It Dv PT_GETXMMREGS
 569 Copy the XMM FPU state into the buffer pointed to by the
 570 argument
 571 .Fa addr .
 572 The buffer has the same layout as the 32-bit save buffer for the
 573 machine instruction
 574 .Dv FXSAVE .
 575 .Pp
 576 This request is only valid for i386 programs, both on native 32-bit
 577 systems and on amd64 kernels.
 578 For 64-bit amd64 programs, the XMM state is reported as part of
 579 the FPU state returned by the
 580 .Dv PT_GETFPREGS
 581 request.
 582 .Pp
 583 The
 584 .Fa data
 585 argument is ignored.
 586 .It Dv PT_SETXMMREGS
 587 Load the XMM FPU state for the thread from the buffer pointed to
 588 by the argument
 589 .Fa addr .
 590 The buffer has the same layout as the 32-bit load buffer for the
 591 machine instruction
 592 .Dv FXRSTOR .
 593 .Pp
 594 As with
 595 .Dv PT_GETXMMREGS,
 596 this request is only valid for i386 programs.
 597 .Pp
 598 The
 599 .Fa data
 600 argument is ignored.
 601 .It Dv PT_GETXSTATE_INFO
 602 Report which XSAVE FPU extensions are supported by the CPU
 603 and allowed in userspace programs.
 604 The
 605 .Fa addr
 606 argument must point to a variable of type
 607 .Vt struct ptrace_xstate_info ,
 608 which contains the information on the request return.
 609 .Vt struct ptrace_xstate_info
 610 is defined as follows:
 611 .Bd -literal
 612 struct ptrace_xstate_info {
 613         uint64_t        xsave_mask;
 614         uint32_t        xsave_len;
 615 };
 616 .Ed
 617 The
 618 .Dv xsave_mask
 619 field is a bitmask of the currently enabled extensions.
 620 The meaning of the bits is defined in the Intel and AMD
 621 processor documentation.
 622 The
 623 .Dv xsave_len
 624 field reports the length of the XSAVE area for storing the hardware
 625 state for currently enabled extensions in the format defined by the x86
 626 .Dv XSAVE
 627 machine instruction.
 628 .Pp
 629 The
 630 .Fa data
 631 argument value must be equal to the size of the
 632 .Vt struct ptrace_xstate_info .
 633 .It Dv PT_GETXSTATE
 634 Return the content of the XSAVE area for the thread.
 635 The
 636 .Fa addr
 637 argument points to the buffer where the content is copied, and the
 638 .Fa data
 639 argument specifies the size of the buffer.
 640 The kernel copies out as much content as allowed by the buffer size.
 641 The buffer layout is specified by the layout of the save area for the
 642 .Dv XSAVE
 643 machine instruction.
 644 .It Dv PT_SETXSTATE
 645 Load the XSAVE state for the thread from the buffer specified by the
 646 .Fa addr
 647 pointer.
 648 The buffer size is passed in the
 649 .Fa data
 650 argument.
 651 The buffer must be at least as large as the
 652 .Vt struct savefpu
 653 (defined in
 654 .Pa x86/fpu.h )
 655 to allow the complete x87 FPU and XMM state load.
 656 It must not be larger than the XSAVE state length, as reported by the
 657 .Dv xsave_len
 658 field from the
 659 .Vt struct ptrace_xstate_info
 660 of the
 661 .Dv PT_GETXSTATE_INFO
 662 request.
 663 Layout of the buffer is identical to the layout of the load area for the
 664 .Dv XRSTOR
 665 machine instruction.
 666 .It Dv PT_GETFSBASE
 667 Return the value of the base used when doing segmented
 668 memory addressing using the %fs segment register.
 669 The
 670 .Fa addr
 671 argument points to an
 672 .Vt unsigned long
 673 variable where the base value is stored.
 674 .Pp
 675 The
 676 .Fa data
 677 argument is ignored.
 678 .It Dv PT_GETGSBASE
 679 Like the
 680 .Dv PT_GETFSBASE
 681 request, but returns the base for the %gs segment register.
 682 .It Dv PT_SETFSBASE
 683 Set the base for the %fs segment register to the value pointed to
 684 by the
 685 .Fa addr
 686 argument.
 687 .Fa addr
 688 must point to the
 689 .Vt unsigned long
 690 variable containing the new base.
 691 .Pp
 692 The
 693 .Fa data
 694 argument is ignored.
 695 .It Dv PT_SETGSBASE
 696 Like the
 697 .Dv PT_SETFSBASE
 698 request, but sets the base for the %gs segment register.
 699 .El
 700 .Sh PowerPC MACHINE-SPECIFIC REQUESTS
 701 .Bl -tag -width "Dv PT_SETVRREGS"
 702 .It Dv PT_GETVRREGS
 703 Return the thread's
 704 .Dv ALTIVEC
 705 machine state in the buffer pointed to by
 706 .Fa addr .
 707 .Pp
 708 The
 709 .Fa data
 710 argument is ignored.
 711 .It Dv PT_SETVRREGS
 712 Set the thread's
 713 .Dv ALTIVEC
 714 machine state from the buffer pointed to by
 715 .Fa addr .
 716 .Pp
 717 The
 718 .Fa data
 719 argument is ignored.
 720 .El
 721 .Pp
 722 Additionally, other machine-specific requests can exist.
 723 .Sh RETURN VALUES
 724 Some requests can cause
 725 .Fn ptrace
 726 to return
 727 \-1
 728 as a non-error value; to disambiguate,
 729 .Va errno
 730 can be set to 0 before the call and checked afterwards.
 731 .Sh ERRORS
 732 The
 733 .Fn ptrace
 734 system call may fail if:
 735 .Bl -tag -width Er
 736 .It Bq Er ESRCH
 737 .Bl -bullet -compact
 738 .It
 739 No process having the specified process ID exists.
 740 .El
 741 .It Bq Er EINVAL
 742 .Bl -bullet -compact
 743 .It
 744 A process attempted to use
 745 .Dv PT_ATTACH
 746 on itself.
 747 .It
 748 The
 749 .Fa request
 750 argument
 751 was not one of the legal requests.
 752 .It
 753 The signal number
 754 (in
 755 .Fa data )
 756 to
 757 .Dv PT_CONTINUE
 758 was neither 0 nor a legal signal number.
 759 .It
 760 .Dv PT_GETREGS ,
 761 .Dv PT_SETREGS ,
 762 .Dv PT_GETFPREGS ,
 763 .Dv PT_SETFPREGS ,
 764 .Dv PT_GETDBREGS ,
 765 or
 766 .Dv PT_SETDBREGS
 767 was attempted on a process with no valid register set.
 768 (This is normally true only of system processes.)
 769 .It
 770 .Dv PT_VM_ENTRY
 771 was given an invalid value for
 772 .Fa pve_entry .
 773 This can also be caused by changes to the VM map of the process.
 774 .It
 775 The size (in
 776 .Fa data )
 777 provided to
 778 .Dv PT_LWPINFO
 779 was less than or equal to zero, or larger than the
 780 .Vt ptrace_lwpinfo
 781 structure known to the kernel.
 782 .It
 783 The size (in
 784 .Fa data )
 785 provided to the x86-specific
 786 .Dv PT_GETXSTATE_INFO
 787 request was not equal to the size of the
 788 .Vt struct ptrace_xstate_info .
 789 .It
 790 The size (in
 791 .Fa data )
 792 provided to the x86-specific
 793 .Dv PT_SETXSTATE
 794 request was less than the size of the x87 plus the XMM save area.
 795 .It
 796 The size (in
 797 .Fa data )
 798 provided to the x86-specific
 799 .Dv PT_SETXSTATE
 800 request was larger than returned in the
 801 .Dv xsave_len
 802 member of the
 803 .Vt struct ptrace_xstate_info
 804 from the
 805 .Dv PT_GETXSTATE_INFO
 806 request.
 807 .It
 808 The base value, provided to the amd64-specific requests
 809 .Dv PT_SETFSBASE
 810 or
 811 .Dv PT_SETGSBASE ,
 812 pointed outside of the valid user address space.
 813 This error will not occur in 32-bit programs.
 814 .El
 815 .It Bq Er EBUSY
 816 .Bl -bullet -compact
 817 .It
 818 .Dv PT_ATTACH
 819 was attempted on a process that was already being traced.
 820 .It
 821 A request attempted to manipulate a process that was being traced by
 822 some process other than the one making the request.
 823 .It
 824 A request
 825 (other than
 826 .Dv PT_ATTACH )
 827 specified a process that was not stopped.
 828 .El
 829 .It Bq Er EPERM
 830 .Bl -bullet -compact
 831 .It
 832 A request
 833 (other than
 834 .Dv PT_ATTACH )
 835 attempted to manipulate a process that was not being traced at all.
 836 .It
 837 An attempt was made to use
 838 .Dv PT_ATTACH
 839 on a process in violation of the requirements listed under
 840 .Dv PT_ATTACH
 841 above.
 842 .El
 843 .It Bq Er ENOENT
 844 .Bl -bullet -compact
 845 .It
 846 .Dv PT_VM_ENTRY
 847 previously returned the last entry of the memory map.
 848 No more entries exist.
 849 .El
 850 .It Bq Er ENAMETOOLONG
 851 .Bl -bullet -compact
 852 .It
 853 .Dv PT_VM_ENTRY
 854 cannot return the pathname of the backing object because the buffer is not big
 855 enough.
 856 .Fa pve_pathlen
 857 holds the minimum buffer size required on return.
 858 .El
 859 .El
 860 .Sh SEE ALSO
 861 .Xr execve 2 ,
 862 .Xr sigaction 2 ,
 863 .Xr wait 2 ,
 864 .Xr execv 3 ,
 865 .Xr i386_clr_watch 3 ,
 866 .Xr i386_set_watch 3
 867 .Sh HISTORY
 868 The
 869 .Fn ptrace
 870 function appeared in
 871 .At v7 .