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