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