Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src document pthread_curcpu_np
details: https://anonhg.NetBSD.org/src/rev/463290c4b146
branches: trunk
changeset: 771122:463290c4b146
user: yamt <yamt%NetBSD.org@localhost>
date: Thu Nov 10 14:01:11 2011 +0000
description:
document pthread_curcpu_np
diffstat:
distrib/sets/lists/comp/mi | 5 ++-
lib/libpthread/Makefile | 3 +-
lib/libpthread/pthread_curcpu_np.3 | 66 ++++++++++++++++++++++++++++++++++++++
3 files changed, 72 insertions(+), 2 deletions(-)
diffs (120 lines):
diff -r bcd0b3a8ee7d -r 463290c4b146 distrib/sets/lists/comp/mi
--- a/distrib/sets/lists/comp/mi Thu Nov 10 13:41:00 2011 +0000
+++ b/distrib/sets/lists/comp/mi Thu Nov 10 14:01:11 2011 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1705 2011/11/08 10:49:41 njoly Exp $
+# $NetBSD: mi,v 1.1706 2011/11/10 14:03:02 yamt Exp $
#
# Note: don't delete entries from here - mark them as "obsolete" instead.
#
@@ -8395,6 +8395,7 @@
./usr/share/man/cat3/pthread_condattr_destroy.0 comp-c-catman .cat
./usr/share/man/cat3/pthread_condattr_init.0 comp-c-catman .cat
./usr/share/man/cat3/pthread_create.0 comp-c-catman .cat
+./usr/share/man/cat3/pthread_curcpu_np.0 comp-c-catman .cat
./usr/share/man/cat3/pthread_detach.0 comp-c-catman .cat
./usr/share/man/cat3/pthread_equal.0 comp-c-catman .cat
./usr/share/man/cat3/pthread_exit.0 comp-c-catman .cat
@@ -14580,6 +14581,7 @@
./usr/share/man/html3/pthread_condattr_destroy.html comp-c-htmlman html
./usr/share/man/html3/pthread_condattr_init.html comp-c-htmlman html
./usr/share/man/html3/pthread_create.html comp-c-htmlman html
+./usr/share/man/html3/pthread_curcpu_np.html comp-c-htmlman html
./usr/share/man/html3/pthread_detach.html comp-c-htmlman html
./usr/share/man/html3/pthread_equal.html comp-c-htmlman html
./usr/share/man/html3/pthread_exit.html comp-c-htmlman html
@@ -20761,6 +20763,7 @@
./usr/share/man/man3/pthread_condattr_destroy.3 comp-c-man .man
./usr/share/man/man3/pthread_condattr_init.3 comp-c-man .man
./usr/share/man/man3/pthread_create.3 comp-c-man .man
+./usr/share/man/man3/pthread_curcpu_np.3 comp-c-man .man
./usr/share/man/man3/pthread_detach.3 comp-c-man .man
./usr/share/man/man3/pthread_equal.3 comp-c-man .man
./usr/share/man/man3/pthread_exit.3 comp-c-man .man
diff -r bcd0b3a8ee7d -r 463290c4b146 lib/libpthread/Makefile
--- a/lib/libpthread/Makefile Thu Nov 10 13:41:00 2011 +0000
+++ b/lib/libpthread/Makefile Thu Nov 10 14:01:11 2011 +0000
@@ -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 @@
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 \
diff -r bcd0b3a8ee7d -r 463290c4b146 lib/libpthread/pthread_curcpu_np.3
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libpthread/pthread_curcpu_np.3 Thu Nov 10 14:01:11 2011 +0000
@@ -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
Home |
Main Index |
Thread Index |
Old Index