README.md

   1 # The atomic_ops library (libatomic_ops)
   2
   3 IN NEW CODE, PLEASE USE C11 OR C++14 STANDARD ATOMICS INSTEAD OF THIS PACKAGE.
   4
   5 This is version 7.4.4 of libatomic_ops.
   6
   7
   8 ## Download
   9
  10 You might find a more recent/stable version on the
  11 [Download](https://github.com/ivmai/libatomic_ops/wiki/Download) page, or
  12 [BDWGC site](http://www.hboehm.info/gc/).
  13
  14 Also, the latest bug fixes and new features are available in the
  15 [development repository](https://github.com/ivmai/libatomic_ops).
  16
  17
  18 ## Overview
  19
  20 This package provides semi-portable access to hardware-provided
  21 atomic memory update operations on a number architectures.  These might
  22 allow you to write code:
  23
  24 * That does more interesting things in signal handlers.
  25
  26 * Makes more effective use of multiprocessors by allowing you to write
  27   clever lock-free code.  Note that such code is very difficult to get
  28   right, and will unavoidably be less portable than lock-based code.  It
  29   is also not always faster than lock-based code.  But it may occasionally
  30   be a large performance win.
  31
  32 * To experiment with new and much better thread programming paradigms, etc.
  33
  34 For details and licensing restrictions see the files in the "doc"
  35 subdirectory.
  36
  37 Please address bug reports to [mailing list](mailto:bdwgc@lists.opendylan.org).
  38
  39
  40 ## Installation and Usage
  41
  42 The configuration and build scripts for this package were generated by
  43 Automake/Autoconf.  "./configure; make; sudo make install" in this
  44 directory should work.  For a more customized build, see the output of
  45 "./configure --help".
  46
  47 Note that much of the content of this library is in the header files.
  48 However, two small libraries are built and installed:
  49
  50 * libatomic_ops.a is a support library, which is not needed on some platforms.
  51   This is intended to be usable, under some mild restrictions, in free or
  52   proprietary code, as are all the header files.  See doc/LICENSING.txt.
  53
  54 * libatomic_ops_gpl.a contains some higher level facilities.  This code is
  55   currently covered by the GPL.  The contents currently correspond to
  56   the headers atomic_ops_stack.h and atomic_ops_malloc.h.
  57
  58
  59 ## Platform Specific Notes
  60
  61 Win32/64: src/Makefile.msft contains a very simple Makefile for building
  62 and running tests and building the gpl library.  The core atomic_ops
  63 implementation is entirely in header files.
  64
  65 HP-UX/PA-RISC: aCC -Ae won't work as a C compiler, since it doesn't support
  66 inline assembly code.  Use cc.
  67
  68
  69 ## Copyright & Warranty
  70
  71 See doc/LICENSING.txt file.