svn commit: r320400 - head/lib/libprocstat

[Ngie Cooper]

Author: ngie
Date: Tue Jun 27 08:49:47 2017
New Revision: 320400
URL: https://svnweb.freebsd.org/changeset/base/320400

Log:
  Add initial documentation for procstat_freeptlwpinfo and procstat_getptlwpinfo
  
  MFC after:	1 month
  MFC with:	r316286

Modified:
  head/lib/libprocstat/libprocstat.3

Modified: head/lib/libprocstat/libprocstat.3
==============================================================================
--- head/lib/libprocstat/libprocstat.3	Tue Jun 27 08:18:08 2017	(r320399)
+++ head/lib/libprocstat/libprocstat.3	Tue Jun 27 08:49:47 2017	(r320400)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd May 18, 2015
+.Dd June 27, 2017
 .Dt LIBPROCSTAT 3
 .Os
 .Sh NAME
@@ -36,6 +36,7 @@
 .Nm procstat_freegroups ,
 .Nm procstat_freekstack ,
 .Nm procstat_freeprocs ,
+.Nm procstat_freeptlwpinfo ,
 .Nm procstat_freevmmap ,
 .Nm procstat_get_pipe_info ,
 .Nm procstat_get_pts_info ,
@@ -52,6 +53,7 @@
 .Nm procstat_getosrel ,
 .Nm procstat_getpathname ,
 .Nm procstat_getprocs ,
+.Nm procstat_getptlwpinfo ,
 .Nm procstat_getrlimit ,
 .Nm procstat_getumask ,
 .Nm procstat_getvmmap ,
@@ -102,6 +104,11 @@
 .Fa "struct procstat *procstat"
 .Fa "struct kinfo_vmentry *vmmap"
 .Fc
+.Ft void
+.Fo procstat_freeptlwpinfo
+.Fa "struct procstat *procstat"
+.Fa "struct ptrace_lwpinfo *pl"
+.Fc
 .Ft int
 .Fo procstat_get_pipe_info
 .Fa "struct procstat *procstat"
@@ -202,6 +209,11 @@
 .Fa "int arg"
 .Fa "unsigned int *count"
 .Fc
+.Ft "struct ptrace_lwpinfo *"
+.Fo procstat_getptlwpinfo
+.Fa "struct procstat *procstat"
+.Fa "unsigned int *count"
+.Fc
 .Ft "int"
 .Fo procstat_getrlimit
 .Fa "struct procstat *procstat"
@@ -309,6 +321,20 @@ The number of processes found is returned in the refer
 .Fa cnt .
 The caller is responsible to free the allocated memory with a subsequent
 .Fn procstat_freeprocs
+function call.
+.Pp
+The
+.Fn procstat_getptlwpinfo
+function gets a pointer to the
+.Vt procstat
+structure from the
+.Fn procstat_open_core
+function and returns a dynamically allocated set of signals intercepted by a
+process in the process's core file.
+The number of processes found is returned in the reference parameter
+.Fa cnt .
+The caller is responsible to free the allocated memory with a subsequent
+.Fn procstat_freeptlwpinfo
 function call.
 .Pp
 The