Differential D25117 Diff 72951 head/share/man/man3/pthread_set_name_np.3

Changeset View

Standalone View

head/share/man/man3/pthread_set_name_np.3

	Show All 18 Lines
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" 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			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd August 12, 2018			.Dd June 3, 2020
	.Dt PTHREAD_SET_NAME_NP 3			.Dt PTHREAD_SET_NAME_NP 3
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm pthread_get_name_np ,			.Nm pthread_get_name_np ,
				.Nm pthread_getname_np ,
	.Nm pthread_set_name_np			.Nm pthread_set_name_np
				.Nm pthread_setname_np
	.Nd set and retrieve the thread name			.Nd set and retrieve the thread name
	.Sh LIBRARY			.Sh LIBRARY
	.Lb libpthread			.Lb libpthread
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.In pthread_np.h			.In pthread_np.h
	.Ft void			.Ft void
	.Fn pthread_get_name_np "pthread_t thread" "char *name" "size_t len"			.Fn pthread_get_name_np "pthread_t thread" "char *name" "size_t len"
				.Ft int
				.Fn pthread_getname_np "pthread_t thread" "char *name" "size_t len"
	.Ft void			.Ft void
	.Fn pthread_set_name_np "pthread_t thread" "const char *name"			.Fn pthread_set_name_np "pthread_t thread" "const char *name"
				.Ft int
				.Fn pthread_setname_np "pthread_t thread" "const char *name"
	.Sh DESCRIPTION			.Sh DESCRIPTION
	The			The
	.Fn pthread_set_name_np			.Fn pthread_set_name_np
	function applies a copy of the given			and
				.Fn pthread_setname_np
				functions apply a copy of the given
	.Fa name			.Fa name
	to the given			to the given
	.Fa thread .			.Fa thread .
	.Pp			.Pp
	The			The
	.Fn pthread_get_name_np			.Fn pthread_get_name_np
	function retrieves the			and
				.Fn pthread_getname_np
				functions retrieve the
	.Fa name			.Fa name
	associated with			associated with
	.Fa thread .			.Fa thread .
	If			If
	.Fn pthread_set_name_np			.Fn pthread_set_name_np
	was not previously called for			was not previously called for
	.Fa thread ,			.Fa thread ,
	the buffer pointed to by			the buffer pointed to by
	.Fa name			.Fa name
	will be empty.			will be empty.
	.Sh ERRORS			.Sh ERRORS
	Because of the debugging nature of these functions, all errors that may			The
				.Nm pthread_getname_np
				and
				.Nm pthread_setname_np
				will fail if
				.Bl -tag -width Er
				.It Bq Er ESRCH
				No thread could be found in the current process corresponding to that
				specified by the given thread ID
				.Fa thread .
				.El
				.Pp
				Because of the debugging nature of
				.Nm pthread_get_name_np
				and
				.Nm pthread_set_name_np
				functions, all errors that may
	appear inside are silently ignored.			appear inside are silently ignored.
	.Sh SEE ALSO			.Sh SEE ALSO
	.Xr thr_set_name 2			.Xr thr_set_name 2
	.Sh STANDARDS			.Sh STANDARDS
	.Fn pthread_set_name_np			.Fn pthread_set_name_np
	and			and
	.Fn pthread_get_name_np			.Fn pthread_get_name_np
	are non-standard extensions.			are non-standard extensions.
				.Fn pthread_setname_np
				and
				.Fn pthread_getname_np
				are also non-standard, but are implemented by larger number of operating
				systems so they are in fact more portable.
	.Sh AUTHORS			.Sh AUTHORS
	This manual page was written by			This manual page was written by
	.An Alexey Zelkin Aq Mt phantom@FreeBSD.org			.An Alexey Zelkin Aq Mt phantom@FreeBSD.org
	and			and
	.An Yuri Pankov Aq Mt yuripv@yuripv.net .			.An Yuri Pankov Aq Mt yuripv@yuripv.net .