diff options
Diffstat (limited to 'usr/src/man/man3proc')
| -rw-r--r-- | usr/src/man/man3proc/Makefile | 15 | ||||
| -rw-r--r-- | usr/src/man/man3proc/Plwp_getname.3proc | 94 |
2 files changed, 102 insertions, 7 deletions
diff --git a/usr/src/man/man3proc/Makefile b/usr/src/man/man3proc/Makefile index 0984b6871f..e59e81fbf3 100644 --- a/usr/src/man/man3proc/Makefile +++ b/usr/src/man/man3proc/Makefile @@ -12,12 +12,12 @@ # # Copyright 2011, Richard Lowe # Copyright 2013 Nexenta Systems, Inc. All rights reserved. -# Copyright 2015 Joyent, Inc. +# Copyright 2018 Joyent, Inc. # include $(SRC)/Makefile.master -MANSECT= 3proc +MANSECT= 3proc MANFILES= \ Lctlfd.3proc \ @@ -64,6 +64,7 @@ MANFILES= \ Plookup_by_addr.3proc \ Plwp_getasrs.3proc \ Plwp_getgwindows.3proc \ + Plwp_getname.3proc \ Plwp_getpsinfo.3proc \ Plwp_getregs.3proc \ Plwp_getspymaster.3proc \ @@ -160,10 +161,10 @@ MANFILES= \ Pwrite.3proc \ Pxecbkpt.3proc \ Pzonename.3proc \ - ps_lgetregs.3proc \ - ps_pglobal_lookup.3proc \ - ps_pread.3proc \ - ps_pstop.3proc + ps_lgetregs.3proc \ + ps_pglobal_lookup.3proc \ + ps_pread.3proc \ + ps_pstop.3proc MANLINKS= \ @@ -265,7 +266,7 @@ MANLINKS= \ Pxlookup_by_name.3proc \ Pxsymbol_iter.3proc \ Pzonepath.3proc \ - Pzoneroot.3proc + Pzoneroot.3proc ps_lgetfpregs.3proc := LINKSRC = ps_lgetregs.3proc diff --git a/usr/src/man/man3proc/Plwp_getname.3proc b/usr/src/man/man3proc/Plwp_getname.3proc new file mode 100644 index 0000000000..57326f9333 --- /dev/null +++ b/usr/src/man/man3proc/Plwp_getname.3proc @@ -0,0 +1,94 @@ +.\" +.\" 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 2018 Joyent, Inc. +.\" +.Dd August 31, 2018 +.Dt PLWP_GETNAME 3PROC +.Os +.Sh NAME +.Nm Plwp_getname +.Nd get thread name +.Sh SYNOPSIS +.Lb libproc +.In libproc.h +.Ft int +.Fo Plwp_getname +.Fa "struct ps_prochandle *P" +.Fa "lwpid_t lwpid" +.Fa "char *buf" +.Fa "size_t bufsize" +.Fc +.Sh DESCRIPTION +The +.Fn Plwp_getname +function returns the thread name in the supplied buffer, from the +thread +.Fa lwpid +in the process handle +.Fa P . +.Pp +If no thread name is set, the buffer is set to the empty string. +The buffer should be at least +.Dv THREAD_NAME_MAX +in size. +.Pp +The +.Fn Plwp_getname +function only works on process handles that refer to active processes +and core files, it does not work on process handles that refer to +individual files. +.Sh RETURN VALUES +Upon successful completion, the +.Fn Plwp_getname +function returns 0. +Otherwise, +.Sy -1 +is returned, +.Sy errno +is set to indicate the error. +The buffer may be modified even if an error is returned. +.Sh ERRORS +For a full list of possible errors also see the +.Sy DIAGNOSTICS +section in +.Xr proc 4 . +.Pp +The +.Fn Plwp_getname +function will fail if: +.Bl -tag -width Er +.It Er ENODATA +.Fa P +refers to a file handle obtained through +.Xr Pgrab_file 3PROC . +.It Er EINVAL +The process handle +.Fa P +refers to a core file and the specified thread does not exist. +.It Er ENOENT +The process handle +.Fa P +refers to an active process and the specified thread does not exist. +.Fa P +.It Er ENAMETOOLONG +The buffer is not sufficient to hold the thread name. +.El +.Sh INTERFACE STABILITY +.Sy Uncommitted +.Sh MT-LEVEL +See +.Sy LOCKING +in +.Xr libproc 3LIB . +.Sh SEE ALSO +.Xr libproc 3LIB , +.Xr proc 4 |