1.\" Copyright (c) 2016 The FreeBSD Foundation, Inc. 2.\" All rights reserved. 3.\" 4.\" This documentation was written by 5.\" Konstantin Belousov <[email protected]> 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 June 1, 2016 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 44The 45.Fn thr_set_name 46sets the user-visible name for the kernel thread with the identifier 47.Va id 48in the current process, to the NUL-terminated string 49.Va name . 50The thread name can be seen in the output of the 51.Xr ps 1 52and 53.Xr top 1 54commands, in the kernel debuggers and kernel tracing facility outputs, 55also in userland debuggers and program core files, as notes. 56.Sh RETURN VALUES 57If successful, 58.Fn thr_set_name 59will return zero, otherwise \-1 is returned, and 60.Va errno 61is set to indicate the error. 62.Sh ERRORS 63The 64.Fn thr_set_name 65operation may return the following errors: 66.Bl -tag -width Er 67.It Bq Er EFAULT 68The memory pointed to by the 69.Fa name 70argument is not valid. 71.It Bq Er ENAMETOOLONG 72The string pointed to by the 73.Fa name 74argument exceeds 75.Dv MAXCOMLEN + 1 76bytes in length. 77.It Bq Er ESRCH 78The thread with the identifier 79.Fa id 80does not exist in the current process. 81.El 82.Sh SEE ALSO 83.Xr ps 1 , 84.Xr thr_exit 2 , 85.Xr thr_kill 2 , 86.Xr thr_kill2 2 , 87.Xr thr_new 2 , 88.Xr thr_self 2 , 89.Xr _umtx_op 2 , 90.Xr pthread_set_name_np 3 , 91.Xr ddb 4 , 92.Xr ktr 9 93.Sh STANDARDS 94The 95.Fn thr_new 96system call is non-standard and is used by 97.Lb libthr . 98