Module Name: src
Committed By: yamt
Date: Thu Nov 10 14:01:11 UTC 2011
Modified Files:
src/lib/libpthread: Makefile
Added Files:
src/lib/libpthread: pthread_curcpu_np.3
Log Message:
document pthread_curcpu_np
To generate a diff of this commit:
cvs rdiff -u -r1.72 -r1.73 src/lib/libpthread/Makefile
cvs rdiff -u -r0 -r1.1 src/lib/libpthread/pthread_curcpu_np.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libpthread/Makefile
diff -u src/lib/libpthread/Makefile:1.72 src/lib/libpthread/Makefile:1.73
--- src/lib/libpthread/Makefile:1.72 Tue Aug 16 10:36:30 2011
+++ src/lib/libpthread/Makefile Thu Nov 10 14:01:11 2011
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.72 2011/08/16 10:36:30 christos Exp $
+# $NetBSD: Makefile,v 1.73 2011/11/10 14:01:11 yamt Exp $
#
WARNS= 4
@@ -105,6 +105,7 @@ MAN+= affinity.3 pthread.3 \
pthread_cancel.3 pthread_cleanup_push.3 \
pthread_cond.3 pthread_condattr.3 \
pthread_create.3 pthread_detach.3 pthread_equal.3 \
+ pthread_curcpu_np.3 \
pthread_exit.3 \
pthread_getname_np.3 \
pthread_getspecific.3 pthread_join.3 \
Added files:
Index: src/lib/libpthread/pthread_curcpu_np.3
diff -u /dev/null src/lib/libpthread/pthread_curcpu_np.3:1.1
--- /dev/null Thu Nov 10 14:01:11 2011
+++ src/lib/libpthread/pthread_curcpu_np.3 Thu Nov 10 14:01:11 2011
@@ -0,0 +1,66 @@
+.\" $NetBSD: pthread_curcpu_np.3,v 1.1 2011/11/10 14:01:11 yamt Exp $
+.\"
+.\" Copyright (c)2011 YAMAMOTO Takashi,
+.\" All rights reserved.
+.\"
+.\" 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 AUTHOR 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 AUTHOR 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.
+.\"
+.\" ------------------------------------------------------------
+.Dd November 10, 2011
+.Dt PTHREAD_CURCPU_NP 3
+.Os
+.\" ------------------------------------------------------------
+.Sh NAME
+.Nm pthread_curcpu_np
+.Nd get current CPU identifier
+.\" ------------------------------------------------------------
+.Sh SYNOPSIS
+.In pthread.h
+.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+.Ft unsigned int
+.Fn pthread_curcpu_np \
+"void"
+.\" ------------------------------------------------------------
+.Sh DESCRIPTION
+The
+.Fn pthread_curcpu_np
+function provides a way for a thread to know which CPU it's currently running
+on.
+.Pp
+Note that, unless the thread is bound to a specific CPU, the result might be
+already stale when the function returns.
+However, it still can be useful as a hint to achieve better CPU locality.
+.\" ------------------------------------------------------------
+.Sh RETURN VALUES
+The
+.Fn pthread_curcpu_np
+function returns the integer identifier of the CPU which is currently
+running the calling thread.
+.\" ------------------------------------------------------------
+.Sh COMPATIBILITY
+The
+.Fn pthread_curcpu_np
+function is a non-standard extention.
+.\" ------------------------------------------------------------
+.Sh SEE ALSO
+.Xr affinity 3 ,
+.Xr pthread 3
