.\"
.\" This file and its contents are supplied under the terms of the
.\" Common Development and Distribution License ("CDDL"), version 1.0.
.\" You may only use this file in accordance with the terms of version
.\" 1.0 of the CDDL.
.\"
.\" A full copy of the text of the CDDL should have accompanied this
.\" source.  A copy of the CDDL is also available via the Internet at
.\" http://www.illumos.org/license/CDDL.
.\"
.\"
.\" Copyright 2023 Oxide Computer Company
.\"
.Dd November 27, 2023
.Dt PROC_GET_LWPSINFO 3PROC
.Os
.Sh NAME
.Nm proc_get_lwpsinfo ,
.Nm proc_get_lwpstatus
.Nd get thread ps and status information
.Sh LIBRARY
.Lb libproc
.Sh SYNOPSIS
.In libproc.h
.Ft int
.Fo proc_get_lwpsinfo
.Fa "pid_t pid"
.Fa "uint_t thr"
.Fa "lwpsinfo_t *lwpps"
.Fc
.Ft int
.Fo proc_get_lwpstatus
.Fa "pid_t pid"
.Fa "uint_t thr"
.Fa "lwpstatus_t *lwpst"
.Fc
.Sh DESCRIPTION
The
.Fn proc_get_lwpsinfo
function is a convenient way to read the /proc lwpsinfo for the specific
thread,
.Fa thr ,
found in the process
.Fa pid .
The information from the
.Pa lwpsinfo
file will be placed in
.Fa lwpps .
The definition of the
.Vt lwpsinfo_t
structure may be found in
.Xr proc 5 .
.Pp
The
.Fn proc_get_lwpstatus
function is a convenient way to read the /proc lwpstatus for the specific
thread,
.Fa thr ,
found in the process
.Fa pid .
The information from the
.Pa lwpstatus
file will be placed in
.Fa lwpst .
The definition of the
.Vt lwpstatus_t
structure may be found in
.Xr proc 5 .
.Pp
The thread identifier for a thread is the same between POSIX pthreads,
C11 threads, and the native threads API.
It is safe to pass one of those identifiers in as
.Fa thr
or to use a specific number.
.Sh RETURN VALUES
Upon successful completion, the
.Fn proc_get_lwpsinfo
and
.Fn proc_get_lwpstatus
functions return
.Sy 0 .
Otherwise,
.Sy -1
is returned to indicate an error occurred.
.Sh INTERFACE STABILITY
.Sy Uncommitted
.Sh MT-LEVEL
.Sy MT-Safe
.Sh SEE ALSO
.Xr libproc 3LIB ,
.Xr proc 5