Merge pull request #19 from Halbaroth/prepare-release-2.2

Prepare release 2.2.0

Author: Halbaroth

CHANGES.md

@@ -0,0 +1,10 @@
+## 2.2.0
+
+### Build
+- Install the dynamic library (PR #12)
+- Build the library with Dune (PR #13)
+- Prevent installation of the opam package on Windows (PR #13, #15)
+- Add ocaml-option-nnp as dependency (PR #16)
+
+### Features
+- Support for OCaml 5 (PR #7, #10)

README.txt README.mdREADME.txt renamed to README.md

@@ -1,8 +1,6 @@
-'Ancient' module for OCaml
-----------------------------------------------------------------------
+# Ancient library for OCaml
 
-What does this module do?
-----------------------------------------------------------------------
+## What does this module do?
 
 This module allows you to use in-memory data structures which are
 larger than available memory and so are kept in swap.  If you try this
@@ -36,8 +34,8 @@ the ancient heap may need to be manually deallocated.  The ancient
 heap may either exist as ordinary memory, or may be backed by a file,
 which is how shared structures are possible.
 
-Structures which are moved into ancient must be treated as STRICTLY
-NON-MUTABLE.  If an ancient structure is changed in any way then it
+Structures which are moved into ancient must be treated as **STRICTLY
+NON-MUTABLE**. If an ancient structure is changed in any way then it
 may cause a crash.
 
 There are some limitations which apply to ancient data structures.
@@ -47,57 +45,56 @@ This module is most useful on 64 bit architectures where large address
 spaces are the norm.  We have successfully used it with a 38 GB
 address space backed by a file and shared between processes.
 
-API
-----------------------------------------------------------------------
+## API
 
-Please see file ancient.mli .
+Please see file `ancient.mli`.
 
-Compiling
-----------------------------------------------------------------------
+## Compiling
 
-  make
+```console
+make
+```
 
 Make sure you run this command before running any program which
 uses the Ancient module:
 
-  ulimit -s unlimited
-
-Example
-----------------------------------------------------------------------
+```console
+ulimit -s unlimited
+```
 
-XXX Note the example code is really stupid, and fails for large
-dictionaries.  See bug (10) below.
+## Example
 
-Run:
-
-  ulimit -s unlimited
-  wordsfile=/usr/share/dict/words
-  baseaddr=0x440000000000               # System specific - see below.
-  ./test_ancient_dict_write.opt $wordsfile dictionary.data $baseaddr
-  ./test_ancient_dict_verify.opt $wordsfile dictionary.data
-  ./test_ancient_dict_read.opt dictionary.data
+Note the example code is really stupid, and fails for large
+dictionaries.  See bug (10) below. Run:
+```console
+ulimit -s unlimited
+wordsfile=/usr/share/dict/words
+baseaddr=0x440000000000               # System specific - see below.
+./test_ancient_dict_write.opt $wordsfile dictionary.data $baseaddr
+./test_ancient_dict_verify.opt $wordsfile dictionary.data
+./test_ancient_dict_read.opt dictionary.data
+```
 
 (You can run several instances of test_ancient_dict_read.opt on the
 same machine to demonstrate sharing).
 
-Shortcomings & bugs
-----------------------------------------------------------------------
+## Shortcomings & bugs
 
-(0) Stack overflows are common when marking/sharing large structures
+1. Stack overflows are common when marking/sharing large structures
 because we use a recursive algorithm to visit the structures.  If you
 get random segfaults during marking/sharing, then try this before
 running your program:
-
+```console
   ulimit -s unlimited
+```
 
-(1) Ad-hoc polymorphic primitives (structural equality, marshalling
+2. Ad-hoc polymorphic primitives (structural equality, marshalling
 and hashing) do not work on ancient data structures, meaning that you
 will need to provide your own comparison and hashing functions.  For
 more details see Xavier Leroy's response here:
-
 http://caml.inria.fr/pub/ml-archives/caml-list/2006/09/977818689f4ceb2178c592453df7a343.en.html
 
-(2) Ancient.attach suggests setting a baseaddr parameter for newly
+3. Ancient.attach suggests setting a baseaddr parameter for newly
 created files (it has no effect when attaching existing files).  We
 strongly recommend this because in our tests we found that mmap would
 locate the memory segment inappropriately -- the basic problem is that
@@ -110,19 +107,17 @@ programmers to guess at a good base address which will be valid in the
 future.  There are no other good solutions we have found --
 preallocating the file is tricky with the current mmalloc code.
 
-(3) The current code requires you to first of all create the large
+4. The current code requires you to first of all create the large
 data structures on the regular OCaml heap, then mark them as ancient,
 effectively copying them out of the OCaml heap, then garbage collect
 the (hopefully unreferenced) structures on the OCaml heap.  In other
 words, you need to have all the memory available as physical memory.
 The way to avoid this is to mark structures as ancient incrementally
 as they are created, or in chunks, whatever works for you.
-
 We typically use Ancient to deal with web server logfiles, and in this
 case loading one file of data into memory and marking it as ancient
 before moving on to the next file works for us.
-
-(4) Why do ancient structures need to be read-only / not mutated?  The
+5. Why do ancient structures need to be read-only / not mutated?  The
 reason is that you might create a new OCaml heap structure and point
 the ancient structure at this heap structure.  The heap structure has
 no apparent incoming pointers (the GC will not by its very nature
@@ -134,14 +129,12 @@ data to OCaml heap data.  In theory it should be possible to modify
 ancient data to point to other ancient data, but we have not tried
 this.
 
-(5) [Limit on number of keys -- issue fixed]
-
-(6) [Advanced topic] The _mark function in ancient_c.c makes no
+6. **Advanced topic:** the `_mark` function in `ancient_c.c` makes no
 attempt to arrange the data structures in memory / on disk in a way
 which optimises them for access.  The worst example is when you have
 an array of large structures, where only a few fields in the structure
 will be accessed.  Typically these will end up on disk as:
-
+```
   array of N pointers
   structure 1
   field A
@@ -166,10 +159,10 @@ will be accessed.  Typically these will end up on disk as:
   field B
     ...
   field Z
-
+```
 If you then iterate accessing only fields A, you end up swapping the
 whole lot back into memory.  A better arrangement would have been:
-
+```
   array of N pointers
   structure 1
   structure 2
@@ -184,23 +177,21 @@ whole lot back into memory.  A better arrangement would have been:
   field B from structure 1
   field B from structure 2
     etc.
-
-which avoids loading unused fields at all.  In some circumstances we
+```
+which avoids loading unused fields at all. In some circumstances we
 have shown that this could make a huge difference to performance, but
 we are not sure how to implement this cleanly in the current library.
-
 [Update: I have fixed issue 6 manually for my Weblogs example and
 confirmed that it does make a huge difference to performance, although
 at considerable extra code complexity.  Interested people can see the
 weblogs library, file import_weblogs_ancient.ml.in].
 
-(7) [Advanced topic] Certain techniques such as Address Space
+7. **Advanced topic:** certain techniques such as Address Space
 Randomisation (http://lwn.net/Articles/121845/) are probably not
 compatible with the Ancient module and shared files.  Because the
 ancient data structures contain real pointers, these pointers would be
 invalidated if the shared file was not mapped in at precisely the same
 base address in all processes which are sharing the file.
-
 One solution might be to use private mappings and a list of fixups.
 In fact, the code actually builds a list of fixups currently while
 marking, because it needs to deal with precisely this issue (during
@@ -210,7 +201,6 @@ to be fixed up afterwards).  The list of fixups would need to be
 stored alongside the memory segment (currently it is discarded after
 marking), and the file would need to be mapped in using MAP_PRIVATE
 (see below).
-
 A possible problem with this is that because OCaml objects tend to be
 small and contain a lot of pointers, it is likely that fixing up the
 pointers would result in every page in the memory segment becoming
@@ -219,34 +209,30 @@ mappings in the first place.  However it is likely that some users of
 this module have large amounts of opaque data and few pointers, and
 for them this would be worthwhile.
 
-(8) Currently mmalloc is implemented so that the file is mapped in
+8. Currently mmalloc is implemented so that the file is mapped in
 PROT_READ|PROT_WRITE and MAP_SHARED.  Ancient data structures are
 supposed to be immutable so strictly speaking write access shouldn't
 be required.  It may be worthwhile modifying mmalloc to allow
 read-only mappings, and private mappings.
 
-(9) The library assumes that every OCaml object is at least one word
+9. The library assumes that every OCaml object is at least one word
 long.  This seemed like a good assumption up until I found that
 zero-length arrays are valid zero word objects.  At the moment you
 cannot mark structures which contain zero-length arrays -- you will
 get an assert-failure in the _mark function.
-
 Possibly there are other types of OCaml structure which are zero word
 objects and also cannot be marked.  I'm not sure what these will be:
 for example empty strings are stored as one word OCaml objects, so
-they are OK.
-
-The solution to this bug is non-trivial.
+they are OK. The solution to this bug is non-trivial.
 
-(10) Example code is very stupid.  It fails with large dictionaries,
+11. Example code is very stupid.  It fails with large dictionaries,
 eg. the one with nearly 500,000 words found in Fedora.
 
-(11) In function 'mark', the "// Ran out of memory.  Recover and throw
+12. In function 'mark', the "// Ran out of memory.  Recover and throw
 an exception." codepath actually fails if you use it - segfaulting
 inside do_restore.
 
-Authors
-----------------------------------------------------------------------
+## Authors
 
 Primary code was written by Richard W.M. Jones <rich at annexia.org>
 with help from Markus Mottl, Martin Jambon, and invaluable advice from
@@ -257,16 +243,9 @@ mmalloc was written by Mike Haertel and Fred Fish.
 Port to no-naked-pointers and OCaml 5+ by Fabrice Le Fessant at
 OCamlPro.
 
-License
-----------------------------------------------------------------------
+## License
 
 The module is licensed under the LGPL + OCaml linking exception.  This
 module includes mmalloc which was originally distributed with gdb
 (although it has since been removed), and that code was distributed
 under the plain LGPL.
-
-Latest version
-----------------------------------------------------------------------
-
-The latest version can be found on the website:
-http://merjis.com/developers/ancient

ancient.opam

@@ -16,7 +16,7 @@ Secondly, this module allows you to share those structures between
 processes.  In this mode, the structures are backed by a disk file,
 and any process that has read/write access that disk file can map that
 file in and see the structures."""
-maintainer: ["Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>"]
+maintainer: ["Pierre Villemot <pierre.villemot@ocamlpro.com>"]
 authors: ["Richard Jones et.al."]
 license: "LGPL-2.1-or-later WITH OCaml-LGPL-linking-exception"
 homepage: "https://github.com/OCamlPro/ocaml-ancient"

dune-project

@@ -3,7 +3,7 @@
 
 (name ancient)
 (authors "Richard Jones et.al.")
-(maintainers "Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>")
+(maintainers "Pierre Villemot <pierre.villemot@ocamlpro.com>")
 (homepage "https://github.com/OCamlPro/ocaml-ancient")
 (bug_reports "https://github.com/OCamlPro/ocaml-ancient/issues")
 

flake.nix

@@ -33,6 +33,7 @@
             odoc
             ocaml-lsp
             patdiff
+            dune-release
           ];
 
           inputsFrom = [ ancient ];