lib/libc/sys/thr_set_name.2

   1 .\" Copyright (c) 2016 The FreeBSD Foundation, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" This documentation was written by
   5 .\" Konstantin Belousov <kib@FreeBSD.org> under sponsorship
   6 .\" from the FreeBSD Foundation.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd May 5, 2020
  32 .Dt THR_SET_NAME 2
  33 .Os
  34 .Sh NAME
  35 .Nm thr_set_name
  36 .Nd set user-visible thread name
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/thr.h
  41 .Ft int
  42 .Fn thr_set_name "long id" "const char *name"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn thr_set_name
  46 system call sets the user-visible name for the thread with the identifier
  47 .Va id
  48 in the current process to the NUL-terminated string
  49 .Va name .
  50 The name will be silently truncated to fit into a buffer of
  51 .Dv MAXCOMLEN + 1
  52 bytes.
  53 The thread name can be seen in the output of the
  54 .Xr ps 1
  55 and
  56 .Xr top 1
  57 commands, in the kernel debuggers and kernel tracing facility outputs,
  58 and in userland debuggers and program core files, as notes.
  59 .Sh RETURN VALUES
  60 If successful,
  61 .Fn thr_set_name
  62 returns zero; otherwise, \-1 is returned, and
  63 .Va errno
  64 is set to indicate the error.
  65 .Sh ERRORS
  66 The
  67 .Fn thr_set_name
  68 system call may return the following errors:
  69 .Bl -tag -width Er
  70 .It Bq Er EFAULT
  71 The memory pointed to by the
  72 .Fa name
  73 argument is not valid.
  74 .It Bq Er ESRCH
  75 The thread with the identifier
  76 .Fa id
  77 does not exist in the current process.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr ps 1 ,
  81 .Xr _umtx_op 2 ,
  82 .Xr thr_exit 2 ,
  83 .Xr thr_kill 2 ,
  84 .Xr thr_kill2 2 ,
  85 .Xr thr_new 2 ,
  86 .Xr thr_self 2 ,
  87 .Xr pthread_set_name_np 3 ,
  88 .Xr ddb 4 ,
  89 .Xr ktr 9
  90 .Sh STANDARDS
  91 The
  92 .Fn thr_set_name
  93 system call is non-standard and is used by the
  94 .Lb libthr .
  95 .Sh HISTORY
  96 The
  97 .Fn thr_set_name
  98 system call first appeared in
  99 .Fx 5.2 .