Differential D6335 Diff 16291 lib/libc/sys/thr_set_name.2

Changeset View

Standalone View

lib/libc/sys/thr_set_name.2

This file was added.

				.\" Copyright (c) 2016 The FreeBSD Foundation, Inc.
				.\" All rights reserved.
				.\"
				.\" This documentation was written by
				.\" Konstantin Belousov <kib@FreeBSD.org> under sponsorship
				.\" from the FreeBSD Foundation.
				.\"
				.\" Redistribution and use in source and binary forms, with or without
				.\" modification, are permitted provided that the following conditions
				.\" are met:
				.\" 1. Redistributions of source code must retain the above copyright
				.\" notice, this list of conditions and the following disclaimer.
				.\" 2. Redistributions in binary form must reproduce the above copyright
				.\" notice, this list of conditions and the following disclaimer in the
				.\" documentation and/or other materials provided with the distribution.
				.\"
				.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
				.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
				.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
				.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
				.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
				.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
				.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
				.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
				.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
				.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
				.\" SUCH DAMAGE.
				.\"
				.\" $FreeBSD$
				.\"
				.Dd May 5, 2016
				.Dt THR_SET_NAME 2
				.Os
				.Sh NAME
				.Nm thr_set_name
				.Nd set user-visible thread name
				.Sh LIBRARY
				.Lb libc
				.Sh SYNOPSIS
				.In sys/thr.h
				.Ft int
				.Fn thr_set_name "long id" "const char *name"
				.Sh DESCRIPTION
				The
				.Fn thr_set_name
				sets the user-visible name for the kernel thread with the identifier
				.Va id
				in the current process, to the NULL-terminated string
				.Va name .
				The thread name can be seen in the output of the
				.Xr ps 1
				emasteUnsubmitted Done Inline Actions The thread name can emaste: The thread name can
				and
				emasteUnsubmitted Done Inline Actions the .Xr ps 1 and .Xr top 1 commands in H mode top shows e.g. firefox{SoftwareVsyncThr} emaste: the .Xr ps 1 and .Xr top 1 commands in H mode top shows e.g. firefox{SoftwareVsyncThr}
				.Xr top 1
				emasteUnsubmitted Done Inline Actions also userland debuggers and userland core files emaste: also userland debuggers and userland core files
				commands, in the kernel debuggers and kernel tracing facility outputs,
				also in userland debuggers and program core files, as notes.
				.Sh RETURN VALUES
				If successful,
				emasteUnsubmitted Done Inline Actions and emaste: and
				.Fn thr_set_name
				will return zero, otherwise \-1 is returned, and
				.Va errno
				is set to indicate the error.
				.Sh ERRORS
				The
				emasteUnsubmitted Done Inline Actions operation (no s) also perhaps "may return the following errors"? emaste: operation (no s) also perhaps "may return the following errors"?
				.Fn thr_set_name
				operation may return the following errors:
				.Bl -tag -width Er
				.It Bq Er EFAULT
				The memory pointed to by the
				.Fa name
				argument is not valid.
				.It Bq Er ENAMETOOLONG
				The string pointed to by the
				.Fa name
				argument exceeds
				.Dv MAXCOMLEN + 1
				bytes in length.
				.It Bq Er ESRCH
				The thread with the identifier
				.Fa id
				does not exist in the current process.
				.El
				.Sh SEE ALSO
				.Xr ps 1 ,
				.Xr thr_exit 2 ,
				.Xr thr_kill 2 ,
				.Xr thr_kill2 2 ,
				.Xr thr_new 2 ,
				.Xr thr_self 2 ,
				.Xr _umtx_op 2 ,
				.Xr ddb 4 ,
				.Xr ktr 9
				.Sh STANDARDS
				The
				.Fn thr_new
				system call is non-standard and is used by the
				.Lb libthr .