xref: /titanic_41/usr/src/man/man3c/smt_pause.3c (revision e39f53ae5e95d7409c90966e3110e6df2a7f7f2a)
1*e39f53aeSRobert Mustacchi.\"
2*e39f53aeSRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3*e39f53aeSRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*e39f53aeSRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5*e39f53aeSRobert Mustacchi.\" 1.0 of the CDDL.
6*e39f53aeSRobert Mustacchi.\"
7*e39f53aeSRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8*e39f53aeSRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9*e39f53aeSRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10*e39f53aeSRobert Mustacchi.\"
11*e39f53aeSRobert Mustacchi.\"
12*e39f53aeSRobert Mustacchi.\" Copyright (c) 2014, Joyent, Inc.
13*e39f53aeSRobert Mustacchi.\"
14*e39f53aeSRobert Mustacchi.Dd "Dec 22, 2014"
15*e39f53aeSRobert Mustacchi.Dt SMT_PAUSE 3C
16*e39f53aeSRobert Mustacchi.Os
17*e39f53aeSRobert Mustacchi.Sh NAME
18*e39f53aeSRobert Mustacchi.Nm smt_pause
19*e39f53aeSRobert Mustacchi.Nd hardware-aware busy wait
20*e39f53aeSRobert Mustacchi.Sh SYNOPSIS
21*e39f53aeSRobert Mustacchi.In synch.h
22*e39f53aeSRobert Mustacchi.Ft void
23*e39f53aeSRobert Mustacchi.Fo smt_pause
24*e39f53aeSRobert Mustacchi.Fa void
25*e39f53aeSRobert Mustacchi.Fc
26*e39f53aeSRobert Mustacchi.Sh DESCRIPTION
27*e39f53aeSRobert MustacchiThe
28*e39f53aeSRobert Mustacchi.Fn smt_pause
29*e39f53aeSRobert Mustacchifunction performs a busy-wait for an implementation defined period of
30*e39f53aeSRobert Mustacchitime. On hardware platforms that support it, it notifies the hardware
31*e39f53aeSRobert Mustacchithat this is occurring in an effort to minimize resource usage. This is
32*e39f53aeSRobert Mustacchicommonly used in the implementation of spin loops.
33*e39f53aeSRobert Mustacchi.Sh INTERFACE STABILITY
34*e39f53aeSRobert Mustacchi.Sy Committed
35*e39f53aeSRobert Mustacchi.Sh MT-LEVEL
36*e39f53aeSRobert Mustacchi.Sy MT-Safe
37*e39f53aeSRobert Mustacchi.Sh SEE ALSO
38*e39f53aeSRobert Mustacchi.Xr attributes 5
39