pd.if.org Git - liblfds/blob - liblfds/liblfds6.0.1/liblfds601/readme.txt

   1 introduction\r
   2 ============\r
   3 Welcome to liblfds, a portable, license-free, lock-free data structure\r
   4 library written in C.\r
   5 \r
   6 platforms\r
   7 =========\r
   8 Currently liblfds out-of-the-box supports;\r
   9 \r
  10 Operating System  CPU         Toolset\r
  11 ================  ==========  =======\r
  12 Windows 64-bit    IA64 & x64  1. Microsoft Visual Studio 2008\r
  13                               2. Microsoft Windows SDK and GNUmake >= 3.8.1\r
  14 \r
  15 Windows 32-bit    x64 & x86   1. Microsoft Visual Studio 2008\r
  16                               2. Visual C++ 2008 Express Edition\r
  17                               3. Microsoft Windows SDK and GNUmake >= 3.8.1\r
  18 \r
  19 Windows Kernel    IA64, x64,  1. Windows Driver Kit >= 7.0.0\r
  20                   x86\r
  21 \r
  22 Linux 64-bit      x64         1. GCC >= 4.1.0 and GNUmake >= 3.8.1\r
  23 \r
  24 Linux 32-bit      x64, x86,   1. GCC >= 4.1.0 and GNUmake >= 3.8.1 \r
  25                   ARM\r
  26 \r
  27 data structures\r
  28 ===============\r
  29 Currently liblfds provides the following;\r
  30 \r
  31 * Freelist\r
  32 * Queue\r
  33 * Ringbuffer\r
  34 * Singly linked list (logical delete only)\r
  35 * Stack\r
  36 \r
  37 liblfds on-line\r
  38 ===============\r
  39 On the liblfds home page, you will find the blog, a bugzilla, a forum, a\r
  40 wikipedia and the current and all historical source releases.\r
  41 \r
  42 The wikipedia contains comprehensive documentation for development,\r
  43 building, testing and porting.\r
  44 \r
  45 http://www.liblfds.org\r
  46 \r
  47 license\r
  48 =======\r
  49 There is no license.  You are free to use this code in any way.\r
  50 \r
  51 building\r
  52 ========\r
  53 On Windows, depending on your target platform, one of the following toolchains\r
  54 is required;\r
  55 \r
  56     * Microsoft Visual Studio 2008 (expensive)\r
  57     * Visual C++ 2008 Express Edition (free, but no 64 bit support)\r
  58     * Microsoft Windows SDK (free, no GUI, has 64 bit support) and GNUmake 3.81 \r
  59 \r
  60 On Windows (kernel-mode), the following toolchain is required; \r
  61 \r
  62     * Windows Driver Kit 7.0.0 or later\r
  63 \r
  64 On Linux, the following toolchain is required;\r
  65 \r
  66     * gcc 4.1.0 or later and GNUmake 3.81 \r
  67 \r
  68 For documentation, see the building guide in the wikipedia.\r
  69 \r
  70 using\r
  71 =====\r
  72 Once built, there is a single header file, /inc/liblfds.h, which you must include\r
  73 in your source code, and a single library file /bin/liblfds.*, where the suffix\r
  74 depends on your platform and your build choice (static or dynamic), to which,\r
  75 if statically built, you must link directly or, if dynamically built, you must\r
  76 arrange your system such that the library can be found by the loader at run-time. \r
  77 \r
  78 testing\r
  79 =======\r
  80 The library comes with a command line test and benchmark program.  This\r
  81 program requires threads.  As such, it is only suitable for platforms providing\r
  82 thread support and which can execute a command line binary.  Currently this\r
  83 means the test and benchmark program works for all platforms except the Windows\r
  84 Kernel.\r
  85 \r
  86 For documentation, see the testing and benchmarking guide in the wikipedia.\r
  87 \r
  88 porting\r
  89 =======\r
  90 Both the test program and liblfds provide an abstraction layer which acts to\r
  91 mask platform differences. Porting is the act of implementing on your platform\r
  92 the functions which make up the abstraction layers.  You do not need to port\r
  93 the test program to port liblfds, but obviously it is recommended, so you can\r
  94 test your port.\r
  95 \r
  96 To support liblfds, your platform must support either contigious double-word\r
  97 compare-and-swap (e.g. x86/x64) or contigious double-word load-link/conditional-store\r
  98 where normal loads cannot occur inside the LL/CS pair (e.g. ARM) or single word\r
  99 load-link/conditional-store where normal loads can occur inside the LL/CS pair.\r
 100 \r
 101 For documentation, see the porting guide in the wikipedia.\r
 102 \r
 103 release history\r
 104 ===============\r
 105 release 1, 25th September 2009, svn revision 1574.\r
 106   - initial release\r
 107 \r
 108 release 2, 5th October 2009, svn revision 1599.\r
 109   - added abstraction layer for Windows kernel\r
 110   - minor code tidyups/fixes\r
 111 \r
 112 release 3, 25th October 2009, svn revision 1652.\r
 113   - added singly linked list (logical delete only)\r
 114   - minor code tidyups/fixes\r
 115 \r
 116 release 4, 7th December 2009, svn revision 1716.\r
 117   - added ARM support\r
 118   - added benchmarking functionality to the test program\r
 119   - fixed a profound and pervasive pointer\r
 120     decleration bug; earlier releases of liblfds\r
 121     *should not be used*\r
 122 \r
 123 release 5, 19th December 2009, svn revision 1738.\r
 124   - fixed subtle queue bug, which also affected ringbuffer\r
 125     and caused data re-ordering under high load\r
 126   - added benchmarks for freelist, ringbuffer and stack\r
 127 \r
 128 release 6, 29th December 2009, svn revision 1746.\r
 129   - fixed two implementation errors, which reduced performance,\r
 130     spotted by Codeplug from "http://cboard.cprogramming.com".\r
 131 \r
 132 release 6.0.0, 18th December 2012, svn revision 2537\r
 133   - introduction of namespaces, e.g. the "lfds601_" prefix\r
 134     code otherwise COMPLETE AND WHOLLY UNCHANGED\r
 135     this release is a stepping-stone to 6.1.0\r
 136 \r
 137 release 6.0.1, 2nd January 2013, svn revision 3296\r
 138   - bug fix where an enum wasn't moved into the new namespacing policy\r
 139 \r