1.\" $NetBSD: pthread_curcpu_np.3,v 1.2 2011/11/10 16:44:47 wiz Exp $ 2.\" 3.\" Copyright (c)2011 YAMAMOTO Takashi, 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" ------------------------------------------------------------ 28.Dd November 10, 2011 29.Dt PTHREAD_CURCPU_NP 3 30.Os 31.\" ------------------------------------------------------------ 32.Sh NAME 33.Nm pthread_curcpu_np 34.Nd get current CPU identifier 35.\" ------------------------------------------------------------ 36.Sh SYNOPSIS 37.In pthread.h 38.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 39.Ft unsigned int 40.Fn pthread_curcpu_np \ 41"void" 42.\" ------------------------------------------------------------ 43.Sh DESCRIPTION 44The 45.Fn pthread_curcpu_np 46function provides a way for a thread to know which CPU it's currently running 47on. 48.Pp 49Note that, unless the thread is bound to a specific CPU, the result might be 50already stale when the function returns. 51However, it still can be useful as a hint to achieve better CPU locality. 52.\" ------------------------------------------------------------ 53.Sh RETURN VALUES 54The 55.Fn pthread_curcpu_np 56function returns the integer identifier of the CPU which is currently 57running the calling thread. 58.\" ------------------------------------------------------------ 59.Sh COMPATIBILITY 60The 61.Fn pthread_curcpu_np 62function is a non-standard extension. 63.\" ------------------------------------------------------------ 64.Sh SEE ALSO 65.Xr affinity 3 , 66.Xr pthread 3 67