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.14 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 of 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
  38 ## Installation and Usage
  39
  40 The configuration and build scripts for this package were generated by
  41 Automake/Autoconf.  `./configure; make; sudo make install` in this
  42 directory should work.  For a more customized build, see the output of
  43 `./configure --help`.
  44
  45 Note that much of the content of this library is in the header files.
  46 However, two small libraries are built and installed:
  47
  48 * `libatomic_ops.a` is a support library, which is not needed on some
  49   platforms. This is intended to be usable, under some mild restrictions,
  50   in free or proprietary code, as are all the header files.
  51   See doc/LICENSING.txt.
  52
  53 * `libatomic_ops_gpl.a` contains some higher level facilities.  This code is
  54   currently covered by the GPL.  The contents currently correspond to
  55   the headers `atomic_ops_stack.h` and `atomic_ops_malloc.h`.
  56
  57
  58 ## Platform Specific Notes
  59
  60 Win32/64: src/Makefile.msft contains a very simple Makefile for building
  61 and running tests and building the gpl library.  The core `libatomic_ops`
  62 implementation is entirely in header files.
  63
  64 HP-UX/PA-RISC: `aCC -Ae` won't work as a C compiler, since it doesn't support
  65 inline assembly code.  Use cc.
  66
  67
  68 ## Feedback, Contribution, Questions and Notifications
  69
  70 Please address bug reports and new feature ideas to
  71 [GitHub issues](https://github.com/ivmai/libatomic_ops/issues).  Before the
  72 submission please check that it has not been done yet by someone else.
  73
  74 If you want to contribute, submit
  75 a [pull request](https://github.com/ivmai/libatomic_ops/pulls) to GitHub.
  76
  77 If you need help, use
  78 [Stack Overflow](https://stackoverflow.com/questions/tagged/atomic-ops).
  79 Older questions on the site can be found by
  80 [this query](https://stackoverflow.com/search?q=atomic_ops).
  81 Older technical discussions are also available in `bdwgc` mailing list
  82 archive - it can be downloaded as a
  83 [compressed file](https://github.com/ivmai/bdwgc/files/1038163/bdwgc-mailing-list-archive-2017_04.tar.gz)
  84 or browsed at [Narkive](http://bdwgc.opendylan.narkive.com) (please search
  85 for _atomic_ keyword).
  86
  87 To get new release announcements, subscribe to
  88 [RSS feed](https://github.com/ivmai/libatomic_ops/releases.atom).
  89 (To receive the notifications by email, a 3rd-party free service like
  90 [IFTTT RSS Feed](https://ifttt.com/feed) can be setup.)
  91 To be notified on all issues, please
  92 [watch](https://github.com/ivmai/libatomic_ops/watchers) the project on
  93 GitHub.
  94
  95
  96 ## Copyright & Warranty
  97
  98 See doc/LICENSING.txt file.