lmdb 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec26115e9cc3611f3305c308a5a26959e0f2ff6438c191968a562c85808fb6ed
-  data.tar.gz: 866b32d018335fa61dbefdc30234c976573a307ad11ae31c260a902cba6812e8
+  metadata.gz: 0bdc2e97f5353c0b63346ff01f45bbdefbecdc9846528a14c787c62155a7ad34
+  data.tar.gz: da28bdf61332f08e234d6562999f4dcbba5c35b02b5af33e21dc87e8238598df
 SHA512:
-  metadata.gz: '0356608ed8065cb4065a752fff8e4aa657fc29c38630e45d278c7edcad4fd211f8129e87eba2e323f2f72a8751b6a43ead97501ece2c8a504cfc9eb0e3b0174c'
-  data.tar.gz: 7f1e02c62e406c108bd7db8875cf528c2ec43cca0beb2ab1ae6380a71b3054b74b66beddd98404e3de93de0928d9221aca9e73c6b309caa5734a0ef78d2d1313
+  metadata.gz: e3ffb3eba78a9c59b5e7dd357492a837c73e6cadd0d09da00399ffc7f1bf470056fed6b280ae326712b59c47ce032c890ff73a33c25a697668432cf1cb162e13
+  data.tar.gz: 96521beef4abb44b5ee3abea5c7a2d79dafa4b49a9a88d9d2fe77d0584b8a62fee9140431cbcc51ca17d9c5a92d70e9281d42fb9cad2cbb6c14cb8802bc3c865

data/README.md

@@ -1,13 +1,21 @@
 # LMDB
 
-Ruby bindings for the amazing [OpenLDAP's Lightning Memory-Mapped Database (LMDB)](https://www.symas.com/lmdb/).
+These are Ruby bindings [OpenLDAP's excellent Lightning Memory-Mapped
+Database (LMDB)](https://www.symas.com/lmdb/).
 
 ## Installation
 
-Install via rubygems:
+Install via [RubyGems](https://rubygems.org/gems/lmdb/):
 
-```ruby
-gem install lmdb
+```bash
+$ gem install lmdb
+```
+
+If you want to force the bundled LMDB over your system version
+(assuming one is present, along with headers):
+
+```bash
+$ gem install lmdb -- --vendor-lmdb
 ```
 
 ## Links

data/Rakefile

@@ -76,3 +76,51 @@ namespace :release do
     abort "#{tag} exists; update version!" unless `git tag -l #{tag}`.empty?
   end
 end
+
+# all this business is to download actual releases of lmdb instead of using
+# git submodules
+
+require 'open-uri'
+require 'json'
+require 'fileutils'
+require 'rubygems/package'
+require 'zlib'
+
+LMDB_VENDOR_DIR = File.expand_path('vendor/liblmdb', __dir__)
+LMDB_NEEDED     = %w[mdb.c midl.c lmdb.h midl.h].freeze
+
+namespace :lmdb do
+  desc 'Fetch the latest LMDB C source into vendor/liblmdb'
+  task :fetch do
+    tags_url = 'https://api.github.com/repos/LMDB/lmdb/tags?per_page=20'
+    headers  = { 'User-Agent' => 'rb-lmdb-gem-fetch' }
+
+    tags = JSON.parse(URI.open(tags_url, headers).read)
+    # warn tags.inspect
+    # Tags are like "LMDB_0_9_32" — pick the highest numeric one
+    tag  = tags
+      .map { |t| t['name'] }
+      .select { |n| n.match?(/\ALMDB_\d+[_.]\d+[_.]\d+\z/) }
+      .max_by { |n| n.scan(/\d+/).map(&:to_i) }
+
+    abort 'Could not determine latest LMDB tag' unless tag
+    puts "Fetching LMDB #{tag}..."
+
+    tarball_url = "https://github.com/LMDB/lmdb/archive/refs/tags/#{tag}.tar.gz"
+    FileUtils.mkdir_p(LMDB_VENDOR_DIR)
+
+    # Stream the tarball, extract only the liblmdb source files we need
+    URI.open(tarball_url, headers) do |gz|
+      Gem::Package::TarReader.new(Zlib::GzipReader.new(gz)).each do |entry|
+        base = File.basename(entry.full_name)
+        next unless entry.file? && LMDB_NEEDED.include?(base)
+        dest = File.join(LMDB_VENDOR_DIR, base)
+        File.write(dest, entry.read)
+        puts "  -> #{dest}"
+      end
+    end
+
+    File.write(File.join(LMDB_VENDOR_DIR, 'VERSION'), "#{tag}\n")
+    puts "Done. LMDB #{tag} vendored in #{LMDB_VENDOR_DIR}."
+  end
+end

data/ext/lmdb_ext/extconf.rb

@@ -3,18 +3,35 @@ require 'mkmf'
 $CFLAGS << ' -std=c99 -Wall -g '
 $CFLAGS << ' -fdeclspec' if /darwin/.match? RUBY_PLATFORM
 
-# Embed lmdb if we cannot find it
-if enable_config("bundled-lmdb", false) || !(find_header('lmdb.h') && have_library('lmdb', 'mdb_env_create'))
-  lmdbpath = "../../vendor/libraries/liblmdb"
-  $INCFLAGS << " -I$(srcdir)/#{lmdbpath}"
-  $VPATH ||= []
-  $VPATH << "$(srcdir)/#{lmdbpath}"
-  # XXX this is a sketchy, sketchy way to do this
-  $srcs = Dir.glob("#{$srcdir}/{#{lmdbpath}/{mdb,midl}.c,*.c}").map do |n|
-    File.basename(n)
-  end
+dir_config('lmdb')
+
+# --vendor flag: skip system lmdb and always build from vendored source
+vendor_forced = arg_config('--vendor-lmdb', false)
+
+have_system_lmdb = false
+
+unless vendor_forced
+  have_system_lmdb =
+    have_header('lmdb.h') && have_library('lmdb', 'mdb_env_create')
+end
+
+unless have_system_lmdb
+  vendor_dir = File.expand_path('../../vendor/liblmdb', __dir__)
+  abort <<~MSG unless File.exist?(File.join(vendor_dir, 'mdb.c'))
+    Could not find system lmdb and no vendored source found.
+    Run `rake lmdb:fetch` to download the LMDB C source, then retry.
+  MSG
+
+  warn "Building from vendored LMDB source in #{vendor_dir}"
+  $INCFLAGS << " -I#{vendor_dir}"
+  $srcs = Dir[File.join(__dir__, '*.c')] +
+          [File.join(vendor_dir, 'mdb.c'),
+           File.join(vendor_dir, 'midl.c')]
+  $VPATH << vendor_dir
 end
 
+
+
 have_header 'limits.h'
 have_header 'string.h'
 have_header 'stdlib.h'

data/ext/lmdb_ext/lmdb_ext.c

@@ -268,6 +268,11 @@ static void stop_txn_begin(void *arg)
         txn_args->stop = 1;
 }
 
+// adding the break so we can commit on break
+#ifndef TAG_BREAK
+#define TAG_BREAK 0x2
+#endif
+
 /**
  * This is the code that opens transactions. Read-write transactions
  * have to be called outside the GVL because they will block otherwise.
@@ -336,12 +341,13 @@ static VALUE with_transaction(VALUE venv, VALUE(*fn)(VALUE), VALUE arg, int flag
   if (tparent && flags & MDB_RDONLY) {
     // We are reusing the parent transaction.
 
-    int exception;
+    int exception = 0;
     VALUE ret = rb_protect(fn, NIL_P(arg) ? vparent : arg, &exception);
 
     if (exception) {
-      // this is a cargo cult; i just copied it from below
-      if (vparent == environment_active_txn(venv)) transaction_abort(vparent);
+      // we only abort if there is a bona fide exception, ie not an early break
+      if (vparent == environment_active_txn(venv) && exception != TAG_BREAK)
+        transaction_abort(vparent);
       rb_jump_tag(exception);
     }
     return ret;
@@ -414,17 +420,20 @@ static VALUE with_transaction(VALUE venv, VALUE(*fn)(VALUE), VALUE arg, int flag
     environment_set_active_txn(venv, transaction->thread, vtxn);
 
     // now we run the function in the transaction
-    int exception;
+    int exception = 0;
     VALUE ret = rb_protect(fn, NIL_P(arg) ? vtxn : arg, &exception);
 
     if (exception) {
       // rb_warn("lol got exception");
-      if (vtxn == environment_active_txn(venv))
-        transaction_abort(vtxn);
+      if (vtxn == environment_active_txn(venv)) {
+        exception == TAG_BREAK ?
+          transaction_commit(vtxn) : transaction_abort(vtxn);
+      }
       rb_jump_tag(exception);
     }
-    if (vtxn == environment_active_txn(venv))
-      transaction_commit(vtxn);
+
+    // no-exception behaviour is to commit the transaction
+    if (vtxn == environment_active_txn(venv)) transaction_commit(vtxn);
     return ret;
   }
 }
@@ -846,9 +855,14 @@ static MDB_txn* need_txn(VALUE self) {
  *   transaction.  A transaction commits when it exits the block successfully.
  *   A transaction aborts when it raises an exception or calls
  *   {Transaction#abort}.
+ *
  *   @param [Boolean] readonly This transaction will not perform any
  *      write operations
+ *
  *   @note Transactions can be nested.
+ *   @note do a `break txn.commit` if you want to exit from the block
+ *      early without aborting.
+ *
  *   @yield [txn] The block to be executed with the body of the transaction.
  *   @yieldparam txn [Transaction] An optional transaction argument
  *   @example

data/lib/lmdb/database.rb

@@ -126,7 +126,8 @@ module LMDB
 
       ret = false
       # read-only txn was having trouble being nested inside a read-write
-      maybe_txn(true) { cursor { |c| ret = !!c.set(key, value) } }
+      # maybe_txn(true) { cursor { |c| ret = !!c.set(key, value) } }
+      env.transaction(true) { cursor { |c| ret = !!c.set(key, value) } }
 
       ret
     end

data/lib/lmdb/version.rb

@@ -1,3 +1,3 @@
 module LMDB
-  VERSION = '0.7.3'.freeze
+  VERSION = '0.7.5'.freeze
 end

data/lmdb.gemspec

@@ -16,7 +16,10 @@ Gem::Specification.new do |s|
   s.authors     = ['Daniel Mendler', 'Dorian Taylor']
   s.extensions  = Dir['ext/**/extconf.rb']
 
-  s.files         = `git ls-files --recurse-submodules -- *`.split("\n")
+  #s.files         = `git ls-files --recurse-submodules -- *`.split("\n")
+  s.files = Dir[*%w[lib/**/*.rb ext/**/*.{c,h,rb}
+                    vendor/liblmdb/{mdb.c,midl.c,lmdb.h,midl.h,VERSION}
+                    README.md CHANGES LICENSE lmdb.gemspec Rakefile Gemfile]]
   s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
 

data/spec/lmdb_spec.rb

@@ -279,6 +279,15 @@ describe LMDB do
       end
     end
 
+    it 'should not complain when you break out of a transaction' do
+      env.transaction do |txn|
+        db.put 'key4', 'value4'
+        break
+      end
+
+      db.get('key4').should eq('value4')
+    end
+
     it 'should return stat' do
       db.stat.should be_instance_of(Hash)
     end

data/vendor/liblmdb/VERSION

@@ -0,0 +1 @@
+LMDB_0.9.35

data/vendor/{libraries/liblmdb → liblmdb}/lmdb.h

@@ -53,15 +53,14 @@
  *
  *	  Fix: Check for stale readers periodically, using the
  *	  #mdb_reader_check function or the \ref mdb_stat_1 "mdb_stat" tool.
- *	  Stale writers will be cleared automatically on most systems:
+ *	  Stale writers will be cleared automatically on some systems:
  *	  - Windows - automatic
- *	  - BSD, systems using SysV semaphores - automatic
  *	  - Linux, systems using POSIX mutexes with Robust option - automatic
+ *	  - not on BSD, systems using POSIX semaphores.
  *	  Otherwise just make all programs using the database close it;
  *	  the lockfile is always reset on first open of the environment.
  *
- *	- On BSD systems or others configured with MDB_USE_SYSV_SEM or
- *	  MDB_USE_POSIX_SEM,
+ *	- On BSD systems or others configured with MDB_USE_POSIX_SEM,
  *	  startup can fail due to semaphores owned by another userid.
  *
  *	  Fix: Open and close the database as the user which owns the
@@ -167,8 +166,6 @@
 #define _LMDB_H_
 
 #include <sys/types.h>
-#include <inttypes.h>
-#include <limits.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -181,32 +178,6 @@ typedef	int	mdb_mode_t;
 typedef	mode_t	mdb_mode_t;
 #endif
 
-#ifdef _WIN32
-# define MDB_FMT_Z	"I"
-#else
-# define MDB_FMT_Z	"z"			/**< printf/scanf format modifier for size_t */
-#endif
-
-#ifndef MDB_VL32
-/** Unsigned type used for mapsize, entry counts and page/transaction IDs.
- *
- *	It is normally size_t, hence the name. Defining MDB_VL32 makes it
- *	uint64_t, but do not try this unless you know what you are doing.
- */
-typedef size_t	mdb_size_t;
-# define MDB_SIZE_MAX	SIZE_MAX	/**< max #mdb_size_t */
-/** #mdb_size_t printf formats, \b t = one of [diouxX] without quotes */
-# define MDB_PRIy(t)	MDB_FMT_Z #t
-/** #mdb_size_t scanf formats, \b t = one of [dioux] without quotes */
-# define MDB_SCNy(t)	MDB_FMT_Z #t
-#else
-typedef uint64_t	mdb_size_t;
-# define MDB_SIZE_MAX	UINT64_MAX
-# define MDB_PRIy(t)	PRI##t##64
-# define MDB_SCNy(t)	SCN##t##64
-# define mdb_env_create	mdb_env_create_vl32	/**< Prevent mixing with non-VL32 builds */
-#endif
-
 /** An abstraction for a file handle.
  *	On POSIX systems file handles are small integers. On Windows
  *	they're opaque pointers.
@@ -229,7 +200,7 @@ typedef int mdb_filehandle_t;
 /** Library minor version */
 #define MDB_VERSION_MINOR	9
 /** Library patch version */
-#define MDB_VERSION_PATCH	70
+#define MDB_VERSION_PATCH	35
 
 /** Combine args a,b,c into a single integer for easy version comparisons */
 #define MDB_VERINT(a,b,c)	(((a) << 24) | ((b) << 16) | (c))
@@ -239,7 +210,7 @@ typedef int mdb_filehandle_t;
 	MDB_VERINT(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH)
 
 /** The release date of this library version */
-#define MDB_VERSION_DATE	"December 19, 2015"
+#define MDB_VERSION_DATE	"Jan 27, 2026"
 
 /** A stringifier for the version info */
 #define MDB_VERSTR(a,b,c,d)	"LMDB " #a "." #b "." #c ": (" d ")"
@@ -332,8 +303,6 @@ typedef void (MDB_rel_func)(MDB_val *item, void *oldptr, void *newptr, void *rel
 #define MDB_NORDAHEAD	0x800000
 	/** don't initialize malloc'd memory before writing to datafile */
 #define MDB_NOMEMINIT	0x1000000
-	/** use the previous snapshot rather than the latest one */
-#define MDB_PREVSNAPSHOT	0x2000000
 /** @} */
 
 /**	@defgroup	mdb_dbi_open	Database Flags
@@ -343,8 +312,7 @@ typedef void (MDB_rel_func)(MDB_val *item, void *oldptr, void *newptr, void *rel
 #define MDB_REVERSEKEY	0x02
 	/** use sorted duplicates */
 #define MDB_DUPSORT		0x04
-	/** numeric keys in native byte order, either unsigned int or #mdb_size_t.
-	 *	(lmdb expects 32-bit int <= size_t <= 32/64-bit mdb_size_t.)
+	/** numeric keys in native byte order: either unsigned int or size_t.
 	 *  The keys must all be of the same size. */
 #define MDB_INTEGERKEY	0x08
 	/** with #MDB_DUPSORT, sorted dup items have fixed size */
@@ -480,10 +448,8 @@ typedef enum MDB_cursor_op {
 #define MDB_BAD_VALSIZE		(-30781)
 	/** The specified DBI was changed unexpectedly */
 #define MDB_BAD_DBI		(-30780)
-	/** Unexpected problem - txn should abort */
-#define MDB_PROBLEM		(-30779)
 	/** The last defined error code */
-#define MDB_LAST_ERRCODE	MDB_PROBLEM
+#define MDB_LAST_ERRCODE	MDB_BAD_DBI
 /** @} */
 
 /** @brief Statistics for a database in the environment */
@@ -491,18 +457,18 @@ typedef struct MDB_stat {
 	unsigned int	ms_psize;			/**< Size of a database page.
 											This is currently the same for all databases. */
 	unsigned int	ms_depth;			/**< Depth (height) of the B-tree */
-	mdb_size_t		ms_branch_pages;	/**< Number of internal (non-leaf) pages */
-	mdb_size_t		ms_leaf_pages;		/**< Number of leaf pages */
-	mdb_size_t		ms_overflow_pages;	/**< Number of overflow pages */
-	mdb_size_t		ms_entries;			/**< Number of data items */
+	size_t		ms_branch_pages;	/**< Number of internal (non-leaf) pages */
+	size_t		ms_leaf_pages;		/**< Number of leaf pages */
+	size_t		ms_overflow_pages;	/**< Number of overflow pages */
+	size_t		ms_entries;			/**< Number of data items */
 } MDB_stat;
 
 /** @brief Information about the environment */
 typedef struct MDB_envinfo {
 	void	*me_mapaddr;			/**< Address of map, if fixed */
-	mdb_size_t	me_mapsize;				/**< Size of the data memory map */
-	mdb_size_t	me_last_pgno;			/**< ID of the last used page */
-	mdb_size_t	me_last_txnid;			/**< ID of the last committed transaction */
+	size_t	me_mapsize;				/**< Size of the data memory map */
+	size_t	me_last_pgno;			/**< ID of the last used page */
+	size_t	me_last_txnid;			/**< ID of the last committed transaction */
 	unsigned int me_maxreaders;		/**< max reader slots in the environment */
 	unsigned int me_numreaders;		/**< max reader slots used in the environment */
 } MDB_envinfo;
@@ -648,12 +614,6 @@ int  mdb_env_create(MDB_env **env);
 	 *		caller is expected to overwrite all of the memory that was
 	 *		reserved in that case.
 	 *		This flag may be changed at any time using #mdb_env_set_flags().
-	 *	<li>#MDB_PREVSNAPSHOT
-	 *		Open the environment with the previous snapshot rather than the latest
-	 *		one. This loses the latest transaction, but may help work around some
-	 *		types of corruption. If opened with write access, this must be the
-	 *		only process using the environment. This flag is automatically reset
-	 *		after a write transaction is successfully committed.
 	 * </ul>
 	 * @param[in] mode The UNIX permissions to set on created files and semaphores.
 	 * This parameter is ignored on Windows.
@@ -882,7 +842,7 @@ int  mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *fd);
 	 *   	an active write transaction.
 	 * </ul>
 	 */
-int  mdb_env_set_mapsize(MDB_env *env, mdb_size_t size);
+int  mdb_env_set_mapsize(MDB_env *env, size_t size);
 
 	/** @brief Set the maximum number of threads/reader slots for the environment.
 	 *
@@ -995,10 +955,6 @@ int  mdb_env_set_assert(MDB_env *env, MDB_assert_func *func);
 	 * <ul>
 	 *	<li>#MDB_RDONLY
 	 *		This transaction will not perform any write operations.
-	 *	<li>#MDB_NOSYNC
-	 *		Don't flush system buffers to disk when committing this transaction.
-	 *	<li>#MDB_NOMETASYNC
-	 *		Flush system buffers but omit metadata flush when committing this transaction.
 	 * </ul>
 	 * @param[out] txn Address where the new #MDB_txn handle will be stored
 	 * @return A non-zero error value on failure and 0 on success. Some possible
@@ -1031,7 +987,7 @@ MDB_env *mdb_txn_env(MDB_txn *txn);
 	 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
 	 * @return A transaction ID, valid if input is an active transaction.
 	 */
-mdb_size_t mdb_txn_id(MDB_txn *txn);
+size_t mdb_txn_id(MDB_txn *txn);
 
 	/** @brief Commit all the operations of a transaction into the database.
 	 *
@@ -1141,8 +1097,7 @@ int  mdb_txn_renew(MDB_txn *txn);
 	 *		keys must be unique and may have only a single data item.
 	 *	<li>#MDB_INTEGERKEY
 	 *		Keys are binary integers in native byte order, either unsigned int
-	 *		or #mdb_size_t, and will be sorted as such.
-	 *		(lmdb expects 32-bit int <= size_t <= 32/64-bit mdb_size_t.)
+	 *		or size_t, and will be sorted as such.
 	 *		The keys must all be of the same size.
 	 *	<li>#MDB_DUPFIXED
 	 *		This flag may only be used in combination with #MDB_DUPSORT. This option
@@ -1587,7 +1542,7 @@ int  mdb_cursor_del(MDB_cursor *cursor, unsigned int flags);
 	 *	<li>EINVAL - cursor is not initialized, or an invalid parameter was specified.
 	 * </ul>
 	 */
-int  mdb_cursor_count(MDB_cursor *cursor, mdb_size_t *countp);
+int  mdb_cursor_count(MDB_cursor *cursor, size_t *countp);
 
 	/** @brief Compare two data items according to a particular database.
 	 *