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