From 931e967f3f80466af578de6895f7c94cb3ddd206 Mon Sep 17 00:00:00 2001 From: Samy Al Bahra Date: Thu, 16 May 2013 17:07:20 -0400 Subject: [PATCH] doc: Add ck_pr_fence_atomic manual page. --- doc/Makefile.in | 1 + doc/ck_pr_fence_atomic | 107 +++++++++++++++++++++++++++++++++++ doc/ck_pr_fence_load | 1 + doc/ck_pr_fence_load_depends | 1 + doc/ck_pr_fence_memory | 1 + doc/ck_pr_fence_store | 1 + 6 files changed, 112 insertions(+) create mode 100644 doc/ck_pr_fence_atomic diff --git a/doc/Makefile.in b/doc/Makefile.in index 397f883..498bb06 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -91,6 +91,7 @@ OBJECTS=ck_ht_count \ ck_pr \ ck_pr_barrier \ ck_pr_fas \ + ck_pr_fence_atomic \ ck_pr_fence_load \ ck_pr_fence_load_depends \ ck_pr_fence_memory \ diff --git a/doc/ck_pr_fence_atomic b/doc/ck_pr_fence_atomic new file mode 100644 index 0000000..4644828 --- /dev/null +++ b/doc/ck_pr_fence_atomic @@ -0,0 +1,107 @@ +.\" +.\" Copyright 2013 Samy Al Bahra. +.\" 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 REGENTS 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 REGENTS 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 May 16, 2013 +.Dt CK_PR_FENCE_ATOMIC 3 +.Sh NAME +.Nm ck_pr_fence_atomic +.Nd enforce partial ordering of atomic read-modify-write operations +.Sh LIBRARY +Concurrency Kit (libck, \-lck) +.Sh SYNOPSIS +.In ck_pr.h +.Ft void +.Fn ck_pr_fence_atomic void +.Ft void +.Fn ck_pr_fence_strict_atomic void +.Sh DESCRIPTION +The +.Fn ck_pr_fence_atomic +function enfores the ordering of any +atomic read-modify-write operations relative to +the invocation of the function. This function +always serve as an implicit compiler barrier. On +architectures implementing CK_MD_TSO, this operation +only serves as a compiler barrier and no fences +are emitted. On architectures implementing +CK_MD_PSO and CK_MD_RMO, a store fence is +emitted. To force the unconditional emission of +a fence, use +.Fn ck_pr_fence_strict_atomic . +.Sh EXAMPLE +.Bd -literal -offset indent + +#include + +static int a = 0; +static int b = 0; +static int c = 0; + +void +function(void) +{ + + ck_pr_fas_int(&a, 1); + + /* + * Guarantee that the update to a is completed + * with respect to the updates of b and c. + */ + ck_pr_fence_atomic(); + ck_pr_fas_int(&b, 2); + ck_pr_fas_int(&c, 2); + + return; +} +.Ed +.Sh RETURN VALUES +This function has no return value. +.Sh SEE ALSO +.Xr ck_pr_stall 3 , +.Xr ck_pr_fence_store 3 , +.Xr ck_pr_fence_load 3 , +.Xr ck_pr_fence_load_depends 3 , +.Xr ck_pr_fence_memory 3 , +.Xr ck_pr_barrier 3 , +.Xr ck_pr_fas 3 , +.Xr ck_pr_load 3 , +.Xr ck_pr_store 3 , +.Xr ck_pr_faa 3 , +.Xr ck_pr_inc 3 , +.Xr ck_pr_dec 3 , +.Xr ck_pr_neg 3 , +.Xr ck_pr_not 3 , +.Xr ck_pr_add 3 , +.Xr ck_pr_sub 3 , +.Xr ck_pr_and 3 , +.Xr ck_pr_or 3 , +.Xr ck_pr_xor 3 , +.Xr ck_pr_cas 3 , +.Xr ck_pr_btc 3 , +.Xr ck_pr_bts 3 , +.Xr ck_pr_btr 3 +.Pp +Additional information available at http://concurrencykit.org/ diff --git a/doc/ck_pr_fence_load b/doc/ck_pr_fence_load index 97cb848..d2dcd2b 100644 --- a/doc/ck_pr_fence_load +++ b/doc/ck_pr_fence_load @@ -83,6 +83,7 @@ function(void) This function has no return value. .Sh SEE ALSO .Xr ck_pr_stall 3 , +.Xr ck_pr_fence_atomic 3 , .Xr ck_pr_fence_load_depends 3 , .Xr ck_pr_fence_store 3 , .Xr ck_pr_fence_memory 3 , diff --git a/doc/ck_pr_fence_load_depends b/doc/ck_pr_fence_load_depends index 7a98389..d9d1e28 100644 --- a/doc/ck_pr_fence_load_depends +++ b/doc/ck_pr_fence_load_depends @@ -45,6 +45,7 @@ which re-orders data-dependent loads (such as the defunct Alpha), this function This function has no return value. .Sh SEE ALSO .Xr ck_pr_stall 3 , +.Xr ck_pr_fence_atomic 3 , .Xr ck_pr_fence_load 3 , .Xr ck_pr_fence_store 3 , .Xr ck_pr_fence_memory 3 , diff --git a/doc/ck_pr_fence_memory b/doc/ck_pr_fence_memory index 31eed57..116a180 100644 --- a/doc/ck_pr_fence_memory +++ b/doc/ck_pr_fence_memory @@ -85,6 +85,7 @@ function(void) This function has no return value. .Sh SEE ALSO .Xr ck_pr_stall 3 , +.Xr ck_pr_fence_atomic 3 , .Xr ck_pr_fence_load 3 , .Xr ck_pr_fence_load_depends 3 , .Xr ck_pr_fence_store 3 , diff --git a/doc/ck_pr_fence_store b/doc/ck_pr_fence_store index 0fa573d..0673d3b 100644 --- a/doc/ck_pr_fence_store +++ b/doc/ck_pr_fence_store @@ -82,6 +82,7 @@ function(void) This function has no return value. .Sh SEE ALSO .Xr ck_pr_stall 3 , +.Xr ck_pr_fence_atomic 3 , .Xr ck_pr_fence_load 3 , .Xr ck_pr_fence_load_depends 3 , .Xr ck_pr_fence_memory 3 ,