From 473c26ce077fa4c4015234ea439f64f1a0fa1ea3 Mon Sep 17 00:00:00 2001 From: Ivan Maidanski Date: Mon, 25 Jul 2011 13:44:49 +0400 Subject: [PATCH] ao-0.3 tarball import --- Makefile | 153 +++++++++++++++++ ao_sysdeps/gcc/hppa.h | 2 +- doc/COPYING | 340 ++++++++++++++++++++++++++++++++++++++ doc/LICENSING.txt | 55 ++++++ doc/README_atomic_ops.txt | 140 ++++++++++++++++ list_atomic.template | 71 ++++++++ test_atomic.c | 212 ++++++++++++++++++++++++ test_atomic.template | 80 +++++++++ 8 files changed, 1052 insertions(+), 1 deletion(-) create mode 100644 Makefile create mode 100644 doc/COPYING create mode 100644 doc/LICENSING.txt create mode 100644 doc/README_atomic_ops.txt create mode 100644 list_atomic.template create mode 100644 test_atomic.c create mode 100644 test_atomic.template diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d2ebb04 --- /dev/null +++ b/Makefile @@ -0,0 +1,153 @@ +# +# Copyright (c) 2003 by Hewlett-Packard Company. All rights reserved. +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. +# + +# PREFIX should usually be set to the intended install directory, e.g. /usr/local +# It defaults to the installed subdirectory of the build directory. This allows +# (somewhat inconvenient) use of the profiler without setting up or accessing +# a separate installation directory. +PREFIX=XXPWDXX/installed +CC= gcc +#Add -DHW_EVENT_SUPPORT if you have Itanium perfmon installed +CFLAGS= -g -O2 +RANLIB=ranlib + +VERSION=0.3 +LIBDIR=$(PREFIX)/lib/ao-$(VERSION) +DOCDIR=$(PREFIX)/doc/ao-$(VERSION) +INCDIR=$(PREFIX)/include/ao-$(VERSION) + +C_SOURCES= test_atomic.c atomic_ops.c +TOP_LEVEL_HEADERS= atomic_ops.h atomic_ops_generalize.h +DERIVED_HEADERS= test_atomic_include.h +DOC= doc/COPYING doc/LICENSING.txt doc/README_atomic_ops.txt +SYSDEP_GCC_HEADERS= ao_sysdeps/gcc/x86.h ao_sysdeps/gcc/ia64.h \ + ao_sysdeps/gcc/alpha.h ao_sysdeps/gcc/arm.h \ + ao_sysdeps/gcc/powerpc.h ao_sysdeps/gcc/sparc.h \ + ao_sysdeps/gcc/hppa.h ao_sysdeps/gcc/m68k.h ao_sysdeps/gcc/s390.h +SYSDEP_ECC_HEADERS= ao_sysdeps/ecc/ia64.h +SYSDEP_VENDORC_HEADERS= ao_sysdeps/vendorc/none_yet +SYSDEP_HEADERS= ao_sysdeps/generic_pthread.h ao_sysdeps/atomic_load_store.h \ + ao_sysdeps/aligned_atomic_load_store.h ao_sysdeps/ordered_except_wr.h \ + ao_sysdeps/acquire_release_volatile.h ao_sysdeps/ordered.h \ + ao_sysdeps/emul_cas.h +ALL_SYSDEP_HEADERS= $(SYSDEP_GCC_HEADERS) $(SYSDEP_ECC_HEADERS) \ +$(SYSDEP_VENDORC_HEADERS) $(SYSDEP_HEADERS) +ATOMIC_OPS_HEADERS= atomic_ops.h atomic_ops_generalize.h $(ALL_SYSDEP_HEADERS) +HEADERS= $(TOP_LEVEL_HEADERS) $(SYSDEP_GCC_HEADERS) $(SYSDEP_HEADERS) +OTHER_FILES=Makefile README test_atomic.template list_atomic.template +ALL_DIST_FILES= $(DOC) $(C_SOURCES) $(HEADERS) $(OTHER_FILES) + +all: atomic_ops.a Makefile.expanded + +Makefile.expanded: Makefile + sed -e s:XXPWDXX:`pwd`: Makefile > Makefile.expanded + +atomic_ops.o: atomic_ops.c $(ATOMIC_OPS_HEADERS) + $(CC) $(CFLAGS) -c -fPIC atomic_ops.c + +atomic_ops.a: atomic_ops.o + $(AR) ruc atomic_ops.a atomic_ops.o + $(RANLIB) atomic_ops.a + +test_atomic: test_atomic.c test_atomic_include.h $(ATOMIC_OPS_HEADERS) + $(CC) $(CFLAGS) test_atomic.c -o test_atomic -lpthread + +test_atomic_pthreads: test_atomic.c test_atomic_include.h $(ATOMIC_OPS_HEADERS) + $(CC) $(CFLAGS) -DAO_USE_PTHREAD_DEFS test_atomic.c -o test_atomic_pthreads -lpthread + +test_atomic_include.h: test_atomic.template + sed -e s/XX// test_atomic.template > test_atomic_include.h + sed -e s/XX/_release/ test_atomic.template >> test_atomic_include.h + sed -e s/XX/_acquire/ test_atomic.template >> test_atomic_include.h + sed -e s/XX/_read/ test_atomic.template >> test_atomic_include.h + sed -e s/XX/_write/ test_atomic.template >> test_atomic_include.h + sed -e s/XX/_full/ test_atomic.template >> test_atomic_include.h + sed -e s/XX/_release_write/ test_atomic.template \ + >> test_atomic_include.h + sed -e s/XX/_acquire_read/ test_atomic.template \ + >> test_atomic_include.h + +list_atomic.c: list_atomic.template + echo "#include \"atomic_ops.h\" " > list_atomic.c + sed -e s/XX// list_atomic.template >> list_atomic.c + sed -e s/XX/_release/ list_atomic.template >> list_atomic.c + sed -e s/XX/_acquire/ list_atomic.template >> list_atomic.c + sed -e s/XX/_read/ list_atomic.template >> list_atomic.c + sed -e s/XX/_write/ list_atomic.template >> list_atomic.c + sed -e s/XX/_full/ list_atomic.template >> list_atomic.c + sed -e s/XX/_release_write/ list_atomic.template \ + >> list_atomic.c + sed -e s/XX/_acquire_read/ list_atomic.template \ + >> list_atomic.c + +list_atomic.i: list_atomic.c atomic_ops.h atomic_ops_generalize.h \ + $(SYSDEP_HEADERS) $(SYSDEP_GCC_HEADERS) + cc -E list_atomic.c > list_atomic.i + +check: test_atomic_pthreads test_atomic + echo The following will usually print some \"Missing ...\" messages. + ./test_atomic_pthreads + ./test_atomic + +clean: + rm -f *.so *.o *.a core test_atomic test_atomic_pthreads \ + list_atomic.c list_atomic.i \ + test_atomic_include.h Makefile.expanded + rm -rf installed + + +dist: $(ALL_DIST_FILES) + # The same thing again for the ao distribution. + mkdir ao-$(VERSION) + ln atomic_ops.h atomic_ops_generalize.h atomic_ops.c ao-$(VERSION) + mkdir ao-$(VERSION)/ao_sysdeps + ln $(SYSDEP_HEADERS) ao-$(VERSION)/ao_sysdeps + mkdir ao-$(VERSION)/ao_sysdeps/gcc + ln $(SYSDEP_GCC_HEADERS) ao-$(VERSION)/ao_sysdeps/gcc + mkdir ao-$(VERSION)/ao_sysdeps/ecc + ln $(SYSDEP_ECC_HEADERS) ao-$(VERSION)/ao_sysdeps/ecc + mkdir ao-$(VERSION)/ao_sysdeps/vendorc + ln $(SYSDEP_VENDORC_HEADERS) ao-$(VERSION)/ao_sysdeps/vendorc + mkdir ao-$(VERSION)/doc + ln doc/README_atomic_ops.txt doc/LICENSING.txt ao-$(VERSION)/doc + tar cvfzh ao-$(VERSION).tar.gz ao-$(VERSION) + rm -rf ao-$(VERSION) + +install: all + make -f Makefile.expanded real_install + +# The following target should only be used in the derived +# Makefile.expanded, since they must see the correct default value +# of PREFIX. + +real_install: + install -d $(LIBDIR) + install -d $(INCDIR) + install -d $(DOCDIR) + ln -s -f $(LIBDIR) $(PREFIX)/lib/ao + ln -s -f $(DOCDIR) $(PREFIX)/doc/ao + ln -s -f $(INCDIR) $(PREFIX)/include/ao + /usr/bin/install -c -m 644 $(DOC) $(DOCDIR) + /usr/bin/install -c -m 644 atomic_ops.a $(LIBDIR) + /usr/bin/install -c -m 644 $(TOP_LEVEL_HEADERS) $(INCDIR) + cp -r ao_sysdeps $(INCDIR) + diff --git a/ao_sysdeps/gcc/hppa.h b/ao_sysdeps/gcc/hppa.h index 93ba815..b63f637 100644 --- a/ao_sysdeps/gcc/hppa.h +++ b/ao_sysdeps/gcc/hppa.h @@ -49,7 +49,7 @@ typedef enum {AO_PA_TS_set = 0, AO_PA_TS_clear = 1} AO_PA_TS_val; #define AO_TS_CLEAR AO_PA_TS_clear #define AO_TS_SET AO_PA_TS_set -static AO_TS_VAL +AO_INLINE AO_TS_VAL AO_test_and_set_full(volatile AO_TS_T * addr) { int result; diff --git a/doc/COPYING b/doc/COPYING new file mode 100644 index 0000000..d60c31a --- /dev/null +++ b/doc/COPYING @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/doc/LICENSING.txt b/doc/LICENSING.txt new file mode 100644 index 0000000..58b0563 --- /dev/null +++ b/doc/LICENSING.txt @@ -0,0 +1,55 @@ +Our intent is to make it easy to use all "library" pieces of the code, in +both free and proprietary software. Hence most code that we expect to be +linked into a client application is covered by an MIT-style license: + +---------------------------------------- + +Copyright (c) ... + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +-------------------------------- + +A few files in the ao_sysdeps directory were inherited in part from the +Boehm-Demers-Weiser conservative garbage collector, and are covered by +its license, which is similar in spirit: + +-------------------------------- + +Copyright (c) ... + +THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED +OR IMPLIED. ANY USE IS AT YOUR OWN RISK. + +Permission is hereby granted to use or copy this program +for any purpose, provided the above notices are retained on all copies. +Permission to modify the code and to distribute modified code is granted, +provided the above notices are retained, and a notice that the code was +modified is included with the above copyright notice. + +---------------------------------- + +A few files are covered by the GNU General Public License. (See file +"COPYING".) Currently this applies only to test code and sample applications. +This should have no effect on linking "library" routines into proprietary +applications. + +In the future, legal considerations may make it desirable to also cover some +newly added library routines under the GPL. If so, these will be clearly +separated, and not implicitly linked into existing libraries. diff --git a/doc/README_atomic_ops.txt b/doc/README_atomic_ops.txt new file mode 100644 index 0000000..5e7a3ea --- /dev/null +++ b/doc/README_atomic_ops.txt @@ -0,0 +1,140 @@ +Usage: +1) type make check; make install in the directory containing unpacked +source. The install directory defaults to the "installed" subdirectory +of the build directory. The can be adjusted with the definition of PREFIX +in Makefile. + +2) Applications should include atomic_ops.h. Nearly all operations +are implemented by header files included from it. It is sometimes +necessary, and always recommended to also link against atomic_ops.a. + +Description: +Atomic_ops.h defines a large collection of operations, each one of which is a +combination of an (optional) atomic memory operation, and a memory barrier. +Also defines associated feature-test macros to determine whether a particular +operation is available on the current target hardware (either directly or +by synthesis). This is an attempt to replace various existing files with +similar goals, since they usually do not handle differences in memory +barrier styles with sufficient generality. + +If this is included after defining AO_REQUIRE_CAS, then the package +will make an attempt to emulate compare-and-swap in a way that (at least +on Linux) should still be async-signal-safe. As a result, most other +atomic operations will then be defined using the compare-and-swap +emulation. This emulation is slow, since it needs to disable signals. +And it needs to block in case of contention. If you care about performance on +a platform that can't directly provide compare-and-swap, there are +probably better alternatives. But this allows easy ports to some such +platforms (e.g. PA_RISC). The option is ignored if compare-and-swap +can be implemented directly. + +If atomic_ops.h is included after defining AO_USE_PTHREAD_DEFS, then all +atomic operations will be emulated with pthread locking. This is NOT +async-signal-safe. And it is slow. It is intended primarily for debugging +of the atomic_ops package itself. + +Note that the implementation reflects our understanding of real processor +behavior. This occasionally diverges from the documented behavior. (E.g. +the documented X86 behavior seems to be weak enough that it is impractical +to use. Current real implementations appear to be much better behaved.) +We of course are in no position to guarantee that future processors +(even HPs) will continue to behave this way, though we hope they will. + +This is a work in progress. Corrections/additions for other platforms are +greatly appreciated. It passes rudimentary tests on X86, Itanium, and +Alpha. + +The defined operations are all of the form AO_(). +Most operations operate on values of type AO_T, which are unsigned integers +whose size matches that of pointers on the given architecture. We may +provide more flexibility in operand types in the future, but this seems +to cover 90+% of common usage. + +The component specifies an atomic memory operation. It may be +one of the following, where the corresponding argument and result types +are also specified: + +void nop() + No atomic operation. The barrier may still be useful. +AO_T load(volatile AO_T * addr) + Atomic load of *addr. +void store(volatile AO_T * addr, AO_T new_val) + Atomically store new_val to *addr. +void fetch_and_add(volatile AO_T *addr, incr) + Atomically add incr to *addr, and return the original value of *addr. +void fetch_and_add1(volatile AO_T *addr) + Equivalent to AO_fetch_and_add(addr, 1). +void fetch_and_sub1(volatile AO_T *addr) + Equivalent to AO_fetch_and_add(addr, (AO_T)(-1)). +int compare_and_swap(volatile AO_T * addr, AO_T old_val, AO_T new_val) + Atomically compare *addr to old_val, and replace *addr by new_val + if the first comparison succeeds. Returns nonzero if the comparison + succeeded and *addr was updated. +AO_TS_VAL test_and_set(volatile AO_TS_T * addr) + Atomically read the binary value at *addr, and set it. AO_TS_VAL + is an enumeration type which includes the two values AO_TS_SET and + and AO_TS_CLEAR. An AO_TS_T location is capable of holding an + AO_TS_VAL, but may be much larger, as dictated by hardware + constraints. Test_and_set logically sets the value to AO_TS_SET. + It may be reset to AO_TS_CLEAR with the AO_CLEAR(AO_TS_T *) macro. + AO_TS_T locations should be initialized to AO_TS_INITIALZER. + The values of AO_TS_SET and AO_TS_CLEAR are hardware dependent. + (On PA-RISC, AO_TS_SET is zero!) + +Test_and_set is a more limited version of compare_and_swap. Its only +advantage is that it is more easily implementable on some hardware. It +should thus be used if only binary test-and-set functionality is needed. + +Each operation name also includes a suffix that specifies the associated +memory barrier. It is one of the following: + +: No memory barrier. A plain AO_nop() really does nothing. +_release: Earlier operations must become visible to other threads + before the atomic operation. +_acquire: Later operations must become visible after this operation. +_read: Subsequent reads must become visible after reads included in + the atomic operation or preceding it. +_write: Earlier writes become visible before writes during or after + the atomic operation. +_full: Ordered with respect to both earlier and later memops. +_release_write: Ordered with respect to earlier writes. This is + normally implemented as either a _write or _release + barrier. +_acquire_read: Ordered with respect to later reads. Usually implemented + as either a _read or _acquire barrier. + +It is possible to test whether AO_ is available on the +current platform by checking whether AO_HAVE__ is defined +as a macro. + +Note that we generally don't implement operations that are either +meaningless (e.g. AO_nop_acquire, AO_nop_release) or which appear to +have no clear use (e.g. AO_load_release, AO_store_acquire, AO_load_write, +AO_store_read). On some platforms (e.g. PA-RISC) many operations +will remain undefined unless AO_REQUIRE_CAS is defined before including +the package. + +When typed in the package build directory, the following command +will print operations that are unimplemented on the platform: + +make test_atomic; ./test_atomic + +The following command generates a file "list_atomic.i" containing the +macro expansions of all implemented operations on the platform: + +make list_atomic.i + +Future directions: + +We expect the list of memory barrier types to remain more or less fixed. +However, it is likely that the list of underlying atomic operations will +grow. AO_fetch_and_or is a very likely candidate. It would also be +useful to support double-wide operations when available. + +Example: + +If you want to initialize an object, and then "publish" a pointer to it +in a global location p, such that other threads reading the new value of +p are guaranteed to see an initialized object, it suffices to use +AO_release_write(p, ...) to write the pointer to the object, and to +retrieve it in other threads with AO_acquire_read(p). diff --git a/list_atomic.template b/list_atomic.template new file mode 100644 index 0000000..a3d36e3 --- /dev/null +++ b/list_atomic.template @@ -0,0 +1,71 @@ +/* + * Copyright (c) 2003 by Hewlett-Packard Company. All rights reserved. + * + * This file is covered by the GNU general public license, version 2. + * see doc/COPYING for details. + */ + +/* This generates a compilable program. But it is really meant to be */ +/* be used only with cc -E, to inspect the expensions generated by */ +/* primitives. */ + +/* The result will not link or run. */ + +void list_atomicXX(void) +{ + AO_T *addr, val, newval, oldval; + AO_TS_T tsaddr; + long incr; + +# if defined(AO_HAVE_nopXX) + "AO_nopXX(): "; + AO_nopXX(); +# else + "No AO_nopXX"; +# endif +# if defined(AO_HAVE_loadXX) + "AO_loadXX(addr):"; + AO_loadXX(addr); +# else + "No AO_loadXX"; +# endif +# if defined(AO_HAVE_storeXX) + "AO_storeXX(addr, val):"; + AO_storeXX(addr, val); +# else + "No AO_storeXX"; +# endif +# if defined(AO_HAVE_test_and_setXX) + "AO_test_and_setXX(tsaddr):"; + AO_test_and_setXX(tsaddr); +# else + "No AO_test_and_setXX"; +# endif +# if defined(AO_HAVE_fetch_and_add1XX) + "AO_fetch_and_add1XX(addr):"; + AO_fetch_and_add1XX(addr); +# else + "No AO_fetch_and_add1XX"; +# endif +# if defined(AO_HAVE_fetch_and_sub1XX) + "AO_fetch_and_sub1XX(addr):"; + AO_fetch_and_sub1XX(addr); +# else + "No AO_fetch_and_sub1XX"; +# endif +# if defined(AO_HAVE_fetch_and_addXX) + "AO_fetch_and_addXX(addr, incr):"; + AO_fetch_and_addXX(addr, incr); +# else + "No AO_fetch_and_addXX"; +# endif +# if defined(AO_HAVE_compare_and_swapXX) + "AO_compare_and_swapXX(addr, oldval, newval):"; + AO_compare_and_swapXX(addr, oldval, newval); +# else + "No AO_compare_and_swapXX"; +# endif +} + + + diff --git a/test_atomic.c b/test_atomic.c new file mode 100644 index 0000000..5947d79 --- /dev/null +++ b/test_atomic.c @@ -0,0 +1,212 @@ +/* + * Copyright (c) 2003 by Hewlett-Packard Company. All rights reserved. + * + * This file is covered by the GNU general public license, version 2. + * see doc/COPYING for details. + */ + +#include +#include +#include + +#include "atomic_ops.h" + +#include "test_atomic_include.h" + +typedef void * (* thr_func)(void *); + +typedef int (* test_func)(void); /* Returns != 0 on success */ + +void * run_parallel(int nthreads, thr_func f1, test_func t, char *name) +{ + pthread_attr_t attr; + pthread_t thr[100]; + int i; + int code; + + fprintf(stderr, "Testing %s\n", name); + if (nthreads > 100) + { + fprintf(stderr, "run_parallel: requested too many threads\n"); + abort(); + } + + pthread_attr_init(&attr); + + for (i = 0; i < nthreads; ++i) + { + if ((code = pthread_create(thr + i, &attr, f1, (void *)(long)i)) != 0) + { + perror("Thread creation failed"); + fprintf(stderr, "Pthread_create returned %d, thread %d\n", code, i); + abort(); + } + } + for (i = 0; i < nthreads; ++i) + { + if ((code = pthread_join(thr[i], NULL)) != 0) + { + perror("Thread join failed"); + fprintf(stderr, "Pthread_join returned %d, thread %d\n", code, i); + abort(); + } + } + if (t()) + { + fprintf(stderr, "Succeeded\n"); + } + else + { + fprintf(stderr, "Failed\n"); + abort(); + } + return 0; +} + +#ifdef AO_USE_PTHREAD_DEFS +# define NITERS 100000 +#else +# define NITERS 1000000 +#endif + +#if defined(AO_HAVE_fetch_and_add1) && defined(AO_HAVE_fetch_and_sub1) + +AO_T counter = 0; + +void * add1sub1_thr(void * id) +{ + int me = (int)(long)id; + + int i; + + for (i = 0; i < NITERS; ++i) + if (me & 1) + AO_fetch_and_sub1(&counter); + else + AO_fetch_and_add1(&counter); + + return 0; +} + +int add1sub1_test(void) +{ + return counter == 0; +} + +#endif /* defined(AO_HAVE_fetch_and_add1) && defined(AO_HAVE_fetch_and_sub1) */ + +#if defined(AO_HAVE_store_release_write) && defined(AO_HAVE_load_acquire_read) + +/* Invariant: counter1 >= counter2 */ +AO_T counter1 = 0; +AO_T counter2 = 0; + +void * acqrel_thr(void *id) +{ + int me = (int)(long)id; + + int i; + + for (i = 0; i < NITERS; ++i) + if (me & 1) + { + AO_T my_counter1; + if (me != 1) + fprintf(stderr, "acqrel test: too many threads\n"); + my_counter1 = AO_load(&counter1); + AO_store(&counter1, my_counter1 + 1); + AO_store_release_write(&counter2, my_counter1 + 1); + } + else + { + AO_T my_counter2; + AO_T my_counter1; + my_counter2 = AO_load_acquire_read(&counter2); + my_counter1 = AO_load(&counter1); + if (my_counter1 < my_counter2) + { + fprintf(stderr, "Saw release store out of order: %d < %d\n", + my_counter1, my_counter2); + abort(); + } + } + + return 0; +} + +int acqrel_test(void) +{ + return counter1 == NITERS && counter2 == NITERS; +} + +#endif /* AO_HAVE_store_release_write && AO_HAVE_load_acquire_read */ + +#if defined(AO_HAVE_test_and_set_acquire) + +AO_TS_T lock = AO_TS_INITIALIZER; + +unsigned long locked_counter; +volatile unsigned long junk = 13; + +void * test_and_set_thr(void * id) +{ + unsigned long i; + + for (i = 0; i < NITERS/10; ++i) + { + while (AO_test_and_set_acquire(&lock) != AO_TS_CLEAR); + ++locked_counter; + if (locked_counter != 1) + { + fprintf(stderr, "Test and set failure 1, counter = %ld\n", + locked_counter); + abort(); + } + locked_counter *= 2; + locked_counter -= 1; + locked_counter *= 5; + locked_counter -= 4; + if (locked_counter != 1) + { + fprintf(stderr, "Test and set failure 2, counter = %ld\n", + locked_counter); + abort(); + } + --locked_counter; + AO_CLEAR(&lock); + /* Spend a bit of time outside the lock. */ + junk *= 17; + junk *= 17; + } +} + +int test_and_set_test(void) +{ + return locked_counter == 0; +} + +#endif /* defined(AO_HAVE_test_and_set_acquire) */ + +int main() +{ + test_atomic(); + test_atomic_acquire(); + test_atomic_release(); + test_atomic_read(); + test_atomic_write(); + test_atomic_full(); + test_atomic_release_write(); + test_atomic_acquire_read(); +# if defined(AO_HAVE_fetch_and_add1) && defined(AO_HAVE_fetch_and_sub1) + run_parallel(4, add1sub1_thr, add1sub1_test, "add1/sub1"); +# endif +# if defined(AO_HAVE_store_release_write) && defined(AO_HAVE_load_acquire_read) + run_parallel(3, acqrel_thr, acqrel_test, + "store_release_write/load_acquire_read"); +# endif +# if defined(AO_HAVE_test_and_set_acquire) + run_parallel(5, test_and_set_thr, test_and_set_test, + "test_and_set"); +# endif + return 0; +} diff --git a/test_atomic.template b/test_atomic.template new file mode 100644 index 0000000..35dd0a6 --- /dev/null +++ b/test_atomic.template @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2003 by Hewlett-Packard Company. All rights reserved. + * + * This file is covered by the GNU general public license, version 2. + * see doc/COPYING for details. + */ + +/* Some basic sanity tests. These do not test the barrier semantics. */ + +#undef TA_assert +#define TA_assert(e) \ + if (!(e)) { fprintf(stderr, "Assertion failed %s:%d (barrier: XX)\n", \ + __FILE__, __LINE__), exit(1); } + +#undef MISSING +#define MISSING(name) \ + fprintf(stderr, "Missing: %s\n", #name "XX") + +void test_atomicXX(void) +{ + AO_T x, y; +# if defined(AO_HAVE_test_and_setXX) + AO_TS_T z = AO_TS_INITIALIZER; +# endif + +# if defined(AO_HAVE_nopXX) + AO_nopXX(); +# else + MISSING(AO_nop); +# endif +# if defined(AO_HAVE_storeXX) + AO_storeXX(&x, 13); + TA_assert (x == 13); +# else + MISSING(AO_store); + x = 13; +# endif +# if defined(AO_HAVE_loadXX) + TA_assert(AO_loadXX(&x) == 13); +# else + MISSING(AO_load); +# endif +# if defined(AO_HAVE_test_and_setXX) + assert(AO_test_and_setXX(&z) == AO_TS_CLEAR); + assert(AO_test_and_setXX(&z) == AO_TS_SET); + assert(AO_test_and_setXX(&z) == AO_TS_SET); + AO_CLEAR(&z); +# else + MISSING(AO_test_and_set); +# endif +# if defined(AO_HAVE_fetch_and_addXX) + TA_assert(AO_fetch_and_addXX(&x, 42) == 13); + TA_assert(AO_fetch_and_addXX(&x, -42) == 55); +# else + MISSING(AO_fetch_and_add); +# endif +# if defined(AO_HAVE_fetch_and_add1XX) + TA_assert(AO_fetch_and_add1(&x) == 13); +# else + MISSING(AO_fetch_and_add1); + ++x; +# endif +# if defined(AO_HAVE_fetch_and_sub1XX) + TA_assert(AO_fetch_and_sub1(&x) == 14); +# else + MISSING(AO_fetch_and_sub1); + --x; +# endif +# if defined(AO_HAVE_compare_and_swapXX) + TA_assert(!AO_compare_and_swap(&x, 14, 42)); + TA_assert(x == 13); + TA_assert(AO_compare_and_swap(&x, 13, 42)); + TA_assert(x == 42); +# else + MISSING(AO_compare_and_swap); +# endif +} + + + -- 2.40.0