git: 4c6c49af2dee - stable/15 - ptrace.2: document PT_GET_CHILDREN

Konstantin Belousov <[email protected]>
Newsgroups gmane.os.freebsd.devel.cvs.src,gmane.os.freebsd.devel.stable.scm
Message-ID <[email protected]>
The branch stable/15 has been updated by kib:

URL: https://cgit.FreeBSD.org/src/commit/?id=4c6c49af2deef5befcb71bc77a4f4e9ed2fac55a

commit 4c6c49af2deef5befcb71bc77a4f4e9ed2fac55a
Author:     Konstantin Belousov <[email protected]>
AuthorDate: 2026-07-17 20:12:13 +0000
Commit:     Konstantin Belousov <[email protected]>
CommitDate: 2026-07-27 00:28:42 +0000

    ptrace.2: document PT_GET_CHILDREN
    
    (cherry picked from commit 6dbeaf1afaba52ba224f24773cbaac6317e11ff2)
---
 lib/libsys/ptrace.2 | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/lib/libsys/ptrace.2 b/lib/libsys/ptrace.2
index e1739a56e115..cedcf92cbef1 100644
--- a/lib/libsys/ptrace.2
+++ b/lib/libsys/ptrace.2
@@ -1044,6 +1044,61 @@ Result of the execution is returned in the
 member.
 Note that the request and its result do not affect the returned value from
 the currently executed syscall, if any.
+.It Dv PT_GET_CHILDREN
+Returns a report describing the children of the process specified by
+.Fa pid .
+Only children visible to the current thread are reported.
+.Pp
+If the
+.Fa addr
+argument is
+.Dv NULL ,
+the instantaneous number of children is returned as
+the result of the request.
+.Pp
+If the
+.Fa addr
+argument is not
+.Dv NULL ,
+it must point to the array of
+.Bd -literal
+struct ptrace_child {
+	pid_t	pid;
+	int	flags;
+};
+.Ed
+elements.
+The size of the array in bytes must be passed in
+.Fa data .
+The
+.Dv PT_GET_CHILDREN
+implementation fills the array and returns the number of elements filled.
+.Pp
+For each element, the
+.Va pid
+member contains the PID of the corresponding child.
+The
+.Va flags
+member may have the following flags set:
+.Bl -tag -width PTCHLD_TRACED_BY_ME
+.It Dv PTCHLD_TRACED
+The child specified by the
+.Va pid
+member is traced.
+.It Dv PTCHLD_TRACED_BY_ME
+The child specified by the
+.Va pid
+member is traced
+by the caller (not the
+process specified by the
+.Fa pid
+argument to the function).
+.It Dv PTCHLD_EXITED
+The child process is exiting or is a zombie.
+.It Dv PTCHLD_ORPHAN
+The child process is currently being debugged by a process other
+than its parent process.
+.El
 .El
 .Sh PT_COREDUMP and PT_SC_REMOTE usage
 The process must be stopped before dumping or initiating a remote system call.
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.