GitHub - bdwgc/libatomic_ops: The atomic_ops project (Atomic memory update operations portable implementation) (original) (raw)

The atomic_ops library (libatomic_ops)

IN NEW CODE, PLEASE USE C11 OR C++14 STANDARD ATOMICS INSTEAD OF THE CORE LIBRARY IN THIS PACKAGE.

This is version 7.11.0 (next release development) of libatomic_ops.

License: MIT for core library / GPL-2.0 for gpl extension.

Download

You might find a more recent/stable version on theDownload page, orBDWGC site.

Also, the latest bug fixes and new features are available in thedevelopment repository.

Overview

This package provides semi-portable access to hardware-provided atomic memory update operations on a number of architectures. These might allow you to write code:

• That does more interesting things in signal handlers.
• Makes more effective use of multiprocessors by allowing you to write clever lock-free code. Note that such code is very difficult to get right, and will unavoidably be less portable than lock-based code. It is also not always faster than lock-based code. But it may occasionally be a large performance win.
• To experiment with new and much better thread programming paradigms, etc.

Please see other README files for the details:

• README_details.txt - details about atomic_ops.h
• README_malloc.txt - a simple almost-lock-free malloc implementation (part of libatomic_ops_gpl)
• README_stack.txt - an almost lock-free LIFO linked lists (stack) implementation (part of libatomic_ops_gpl)

Installation and Usage

The configuration and build scripts for this package were generated by Automake/Autoconf. ./configure; make; sudo make install in this directory should work. For a more customized build, see the output of./configure --help. To build it from the development repository,./autogen.sh should be executed first.

Alternatively, CMake could be use to build this package, e.g.cmake . && cmake --build . in this directory should work.

Note that much of the content of this library is in the header files. However, two small libraries are built and installed:

• libatomic_ops.a is a support (core) library, which is not needed on some platforms. This is intended to be usable, under some mild restrictions, in free or proprietary code, as are all the header files. See LICENSE for more details about the licensing.
• libatomic_ops_gpl.a is a so called gpl extension library containing some higher level facilities. This code is covered by the GPL. The contents correspond to the headers atomic_ops_malloc.h and atomic_ops_stack.h. Not built and not installed if --disable-gpl option is passed toconfigure (or if -Denable_gpl=OFF option is passed to cmake if the latter is used to build the package). The licensing details are given inCOPYING and LICENSE files.

Platform Specific Notes

Win32/64: src/Makefile.msft contains a very simple Makefile for building and running tests and building the gpl library. The core libatomic_opsimplementation is entirely in header files (libatomic_ops.lib is built anyway to match that of the configure-based build process, but libatomic_ops.lib has only the implementation of the internal AO_pause() used by the gpl library). More information is provided in README_win32.txt file.

HP-UX/PA-RISC: aCC -Ae won't work as a C compiler, since it doesn't support inline assembly code. Use cc.

Feedback, Contribution, Questions and Notifications

Please address bug reports and new feature ideas toGitHub issues. Before the submission please check that it has not been done yet by someone else.

If you want to contribute, submit a pull request to GitHub.

If you need help, useStack Overflow. Older questions on the site can be found bythis query. Older technical discussions are also available in bdwgc mailing list archive - it can be downloaded as acompressed fileor browsed at Narkive (please search for atomic keyword).

To get new release announcements, subscribe toRSS feed. (To receive the notifications by email, a 3rd-party free service likeIFTTT RSS Feed can be setup.) To be notified on all issues, pleasewatch the project on GitHub.

Copyright & Warranty, Contributors

Please be aware of the dual nature of the license of libatomic_ops:

• the core part (implementing semi-portable access to hardware-provided atomic memory operations) is released under MIT license
• the gpl extension (almost lock-free malloc and stack implementations) and the tests are released under GPL-2.0 license

The exact licensing information is provided in LICENSE file.

The library contributors are listed in AUTHORS file.