share/man/man3c/getcpuid.3c

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GETCPUID 3C "Apr 16, 2003"
   7 .SH NAME
   8 getcpuid, gethomelgroup \- obtain information on scheduling decisions
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/processor.h>
  13
  14 \fBprocessorid_t\fR \fBgetcpuid\fR(\fBvoid\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBushort_t\fR \fBgethomelgroup\fR(\fBvoid\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBgetcpuid()\fR function returns the processor ID on which the calling
  26 thread is currently executing.
  27 .sp
  28 .LP
  29 The \fBgethomelgroup()\fR function returns the home locality group ID of the
  30 calling thread.
  31 .SH RETURN VALUES
  32 .sp
  33 .LP
  34 See \fBDESCRIPTION\fR.
  35 .SH ERRORS
  36 .sp
  37 .LP
  38 No errors are defined.
  39 .SH USAGE
  40 .sp
  41 .LP
  42 Both the current CPU and the home locality group can change at any time.
  43 .SH ATTRIBUTES
  44 .sp
  45 .LP
  46 See \fBattributes\fR(5) for descriptions of the following attributes:
  47 .sp
  48
  49 .sp
  50 .TS
  51 box;
  52 c | c
  53 l | l .
  54 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  55 _
  56 Interface Stability     T{
  57 \fBgetcpuid()\fR is Stable; \fBgethomelgroup()\fR is Obsolete.
  58 T}
  59 _
  60 MT-Level        MT-Safe
  61 .TE
  62
  63 .SH SEE ALSO
  64 .sp
  65 .LP
  66 \fBpsradm\fR(8), \fBpsrinfo\fR(8), \fBpsrset\fR(8), \fBp_online\fR(2),
  67 \fBprocessor_bind\fR(2), \fBprocessor_info\fR(2), \fBpset_assign\fR(2),
  68 \fBpset_bind\fR(2), \fBpset_info\fR(2), \fBmeminfo\fR(2),
  69 \fBlgrp_home\fR(3LGRP), \fBsysconf\fR(3C), \fBattributes\fR(5)
  70 .SH NOTES
  71 .sp
  72 .LP
  73 The \fBgethomelgroup()\fR function is obsolete and might be removed in a future
  74 release. It has been replaced by \fBlgrp_home\fR(3LGRP).