mdbx 0.2.0 → 0.3.3

data/ext/mdbx_ext/mdbx_ext.c

@@ -6,6 +6,60 @@ VALUE rmdbx_mMDBX;
 VALUE rmdbx_eDatabaseError;
 VALUE rmdbx_eRollback;
 
+/*
+ * Log a message to the given +context+ object's logger.
+ */
+void
+#ifdef HAVE_STDARG_PROTOTYPES
+rmdbx_log_obj( VALUE context, const char *level, const char *fmt, ... )
+#else
+rmdbx_log_obj( VALUE context, const char *level, const char *fmt, va_dcl )
+#endif
+{
+	char buf[BUFSIZ];
+	va_list	args;
+	VALUE logger = Qnil;
+	VALUE message = Qnil;
+
+	va_init_list( args, fmt );
+	vsnprintf( buf, BUFSIZ, fmt, args );
+	message = rb_str_new2( buf );
+
+	logger = rb_funcall( context, rb_intern("log"), 0 );
+	rb_funcall( logger, rb_intern(level), 1, message );
+
+	va_end( args );
+}
+
+
+/*
+ * Log a message to the global logger.
+ */
+void
+#ifdef HAVE_STDARG_PROTOTYPES
+rmdbx_log( const char *level, const char *fmt, ... )
+#else
+rmdbx_log( const char *level, const char *fmt, va_dcl )
+#endif
+{
+	char buf[BUFSIZ];
+	va_list	args;
+	VALUE logger = Qnil;
+	VALUE message = Qnil;
+
+	va_init_list( args, fmt );
+	vsnprintf( buf, BUFSIZ, fmt, args );
+	message = rb_str_new2( buf );
+
+	logger = rb_funcall( rmdbx_mMDBX, rb_intern("logger"), 0 );
+	rb_funcall( logger, rb_intern(level), 1, message );
+
+	va_end( args );
+}
+
+
+
+
 /*
  * MDBX initialization
  */

data/ext/mdbx_ext/mdbx_ext.h

@@ -4,12 +4,23 @@
 
 #include "mdbx.h"
 
-#ifndef MDBX_EXT_0_9_3
-#define MDBX_EXT_0_9_3
+#ifndef RBMDBX_EXT
+#define RBMDBX_EXT
 
 #define RMDBX_TXN_ROLLBACK 0
 #define RMDBX_TXN_COMMIT 1
 
+/* Shortcut for fetching wrapped data structure.
+ */
+#define UNWRAP_DB( self, db ) \
+	rmdbx_db_t *db; \
+	TypedData_Get_Struct( self, rmdbx_db_t, &rmdbx_db_data, db )
+
+/* Raise if current DB is not open. */
+#define CHECK_HANDLE() \
+	if ( ! db->state.open ) rb_raise( rmdbx_eDatabaseError, "Closed database." )
+
+
 /*
  * A struct encapsulating an instance's DB
  * state and settings.
@@ -21,7 +32,8 @@ struct rmdbx_db {
 	MDBX_cursor *cursor;
 
     struct {
-       int env_flags;
+       unsigned int env_flags;
+       unsigned int db_flags;
        int mode;
        int open;
        int max_collections;
@@ -40,12 +52,27 @@ struct rmdbx_db {
 typedef struct rmdbx_db rmdbx_db_t;
 
 static const rb_data_type_t rmdbx_db_data;
-extern void rmdbx_free( void *db ); /* forward declaration for the allocator */
+
 
 /* ------------------------------------------------------------
- * Globals
+ * Logging
  * ------------------------------------------------------------ */
+#ifdef HAVE_STDARG_PROTOTYPES
+#include <stdarg.h>
+#define va_init_list(a,b) va_start(a,b)
+void rmdbx_log_obj( VALUE, const char *, const char *, ... );
+void rmdbx_log( const char *, const char *, ... );
+#else
+#include <varargs.h>
+#define va_init_list(a,b) va_start(a)
+void rmdbx_log_obj( VALUE, const char *, const char *, va_dcl );
+void rmdbx_log( const char *, const char *, va_dcl );
+#endif
 
+
+/* ------------------------------------------------------------
+ * Globals
+ * ------------------------------------------------------------ */
 extern VALUE rmdbx_mMDBX;
 extern VALUE rmdbx_cDatabase;
 extern VALUE rmdbx_eDatabaseError;
@@ -55,13 +82,15 @@ extern VALUE rmdbx_eRollback;
 /* ------------------------------------------------------------
  * Functions
  * ------------------------------------------------------------ */
+extern void rmdbx_free( void *db ); /* forward declaration for the allocator */
 extern void Init_rmdbx ( void );
 extern void rmdbx_init_database ( void );
+extern void rmdbx_close_all( rmdbx_db_t* );
 extern void rmdbx_open_txn( rmdbx_db_t*, int );
 extern void rmdbx_close_txn( rmdbx_db_t*, int );
-
+extern void rmdbx_open_cursor( rmdbx_db_t* );
 extern VALUE rmdbx_gather_stats( rmdbx_db_t* );
 
 
-#endif /* define MDBX_EXT_0_9_3 */
+#endif /* define RBMDBX_EXT */
 

data/ext/mdbx_ext/stats.c

@@ -3,8 +3,6 @@
  * Expose a bunch of mdbx internals to ruby.
  * This is all largely stolen from mdbx_stat.c.
  *
- * Entry point is rmdbx_stats() in database.c.
- *
  */
 
 #include "mdbx_ext.h"
@@ -28,6 +26,32 @@ rmdbx_gather_build_stats( VALUE stat )
 }
 
 
+/*
+ * Grab current memory usage.  (Available since MDBX 0.10.0).
+ */
+void
+rmdbx_gather_memory_stats( VALUE stat )
+{
+	if (! ( MDBX_VERSION_MAJOR >= 0 && MDBX_VERSION_MINOR >= 10 ) )
+		return;
+
+	VALUE mem = rb_hash_new();
+	rb_hash_aset( stat, ID2SYM(rb_intern("system_memory")), mem );
+
+	intptr_t page_size;
+	intptr_t total_pages;
+	intptr_t avail_pages;
+
+	mdbx_get_sysraminfo( &page_size, &total_pages, &avail_pages );
+
+	rb_hash_aset( mem, ID2SYM(rb_intern("pagesize")),    LONG2FIX( page_size ) );
+	rb_hash_aset( mem, ID2SYM(rb_intern("total_pages")), LONG2FIX( total_pages ) );
+	rb_hash_aset( mem, ID2SYM(rb_intern("avail_pages")), LONG2FIX( avail_pages ) );
+
+	return;
+}
+
+
 /*
  * Metadata for the database file.
  */
@@ -80,6 +104,16 @@ rmdbx_gather_environment_stats(
 
 	rb_hash_aset( environ, ID2SYM(rb_intern("pagesize")),
 			INT2NUM(mstat.ms_psize) );
+	rb_hash_aset( environ, ID2SYM(rb_intern("branch_pages")),
+			LONG2NUM(mstat.ms_branch_pages) );
+	rb_hash_aset( environ, ID2SYM(rb_intern("leaf_pages")),
+			LONG2NUM(mstat.ms_leaf_pages) );
+	rb_hash_aset( environ, ID2SYM(rb_intern("overflow_pages")),
+			LONG2NUM(mstat.ms_overflow_pages) );
+	rb_hash_aset( environ, ID2SYM(rb_intern("btree_depth")),
+			INT2NUM(mstat.ms_depth) );
+	rb_hash_aset( environ, ID2SYM(rb_intern("entries")),
+			LONG2NUM(mstat.ms_entries) );
 	rb_hash_aset( environ, ID2SYM(rb_intern("last_txnid")),
 			INT2NUM(menvinfo.mi_recent_txnid) );
 	rb_hash_aset( environ, ID2SYM(rb_intern("last_reader_txnid")),
@@ -101,7 +135,7 @@ rmdbx_gather_environment_stats(
  *
  */
 int
-reader_list_callback(
+rmdbx_reader_list_cb(
 	void *ctx,
 	int num,
 	int slot,
@@ -148,7 +182,7 @@ rmdbx_gather_reader_stats(
 {
 	VALUE readers = rb_ary_new();
 
-	mdbx_reader_list( db->env, reader_list_callback, (void*)readers );
+	mdbx_reader_list( db->env, rmdbx_reader_list_cb, (void*)readers );
 	rb_hash_aset( stat, ID2SYM(rb_intern("readers")), readers );
 
 	return;
@@ -168,6 +202,7 @@ rmdbx_gather_stats( rmdbx_db_t *db )
 	MDBX_stat mstat;
 	MDBX_envinfo menvinfo;
 
+	rmdbx_gather_memory_stats( stat );
 	rmdbx_gather_build_stats( stat );
 
 	rmdbx_open_txn( db, MDBX_TXN_RDONLY );
@@ -183,9 +218,6 @@ rmdbx_gather_stats( rmdbx_db_t *db )
 	rmdbx_gather_environment_stats( stat, mstat, menvinfo );
 	rmdbx_gather_reader_stats( db, stat, mstat, menvinfo );
 
-	/* TODO: database and subdatabase stats */
-
 	return stat;
 }
 
-

data/lib/mdbx/database.rb

@@ -8,6 +8,9 @@ require 'mdbx' unless defined?( MDBX )
 # The primary class for interacting with an MDBX database.
 #
 class MDBX::Database
+	extend Loggability
+
+	log_to :mdbx
 
 	### call-seq:
 	###    MDBX::Database.open( path ) => db
@@ -29,10 +32,23 @@ class MDBX::Database
 	### Unless otherwise mentioned, option keys are symbols, and values
 	### are boolean.
 	###
-	### [:mode]
-	###   Whe creating a new database, set permissions to this 4 digit
-	###   octal number.  Defaults to `0644`.  Set to `0` to never automatically
-	###   create a new file, only opening existing databases.
+	### [:coalesce]
+	###   Attempt to coalesce items for the garbage collector,
+	###   potentialy increasing the chance of unallocating storage
+	###   earlier.
+	###
+	### [:compatible]
+	###   Skip compatibility checks when opening an in-use database with
+	###   unknown or mismatched flag values.
+	###
+	### [:exclusive]
+	###   Access is restricted to the first opening process. Other attempts
+	###   to use this database (even in readonly mode) are denied.
+	###
+	### [:lifo_reclaim]
+	###   Recycle garbage collected items via LIFO, instead of FIFO.
+	###   Depending on underlying hardware (disk write-back cache), this
+	###   could increase write performance.
 	###
 	### [:max_collections]
 	###   Set the maximum number of "subdatabase" collections allowed. By
@@ -45,51 +61,38 @@ class MDBX::Database
 	###   Set an upper boundary (in bytes) for the database map size.
 	###   The default is 10485760 bytes.
 	###
-	### [:nosubdir]
-	###   When creating a new database, don't put the data and lock file
-	###   under a dedicated subdirectory.
-	###
-	### [:readonly]
-	###   Reject any write attempts while using this database handle.
-	###
-	### [:exclusive]
-	###   Access is restricted to the first opening process. Other attempts
-	###   to use this database (even in readonly mode) are denied.
+	### [:mode]
+	###   Whe creating a new database, set permissions to this 4 digit
+	###   octal number.  Defaults to `0644`.  Set to `0` to never automatically
+	###   create a new file, only opening existing databases.
 	###
-	### [:compat]
-	###   Skip compatibility checks when opening an in-use database with
-	###   unknown or mismatched flag values.
+	### [:no_memory_init]
+	###   Skip initializing malloc'ed memory to zeroes before writing.
 	###
-	### [:writemap]
-	###   Trade safety for speed for databases that fit within available
-	###   memory. (See MDBX documentation for details.)
+	### [:no_metasync]
+	###   A system crash may sacrifice the last commit for a potentially
+	###   large write performance increase.  Database integrity is
+	###   maintained.
 	###
-	### [:no_threadlocal]
-	###   Parallelize read-only transactions across threads.  Writes are
-	###   always thread local. (See MDBX documentatoin for details.)
+	### [:no_subdir]
+	###   When creating a new database, don't put the data and lock file
+	###   under a dedicated subdirectory.
 	###
 	### [:no_readahead]
 	###   Disable all use of OS readahead.  Potentially useful for
 	###   random reads wunder low memory conditions.  Default behavior
 	###   is to dynamically choose when to use or omit readahead.
 	###
-	### [:no_memory_init]
-	###   Skip initializing malloc'ed memory to zeroes before writing.
-	###
-	### [:coalesce]
-	###   Attempt to coalesce items for the garbage collector,
-	###   potentialy increasing the chance of unallocating storage
-	###   earlier.
+	### [:no_threadlocal]
+	###   Parallelize read-only transactions across threads.  Writes are
+	###   always thread local. (See MDBX documentatoin for details.)
 	###
-	### [:lifo_reclaim]
-	###   Recycle garbage collected items via LIFO, instead of FIFO.
-	###   Depending on underlying hardware (disk write-back cache), this
-	###   could increase write performance.
+	### [:readonly]
+	###   Reject any write attempts while using this database handle.
 	###
-	### [:no_metasync]
-	###   A system crash may sacrifice the last commit for a potentially
-	###   large write performance increase.  Database integrity is
-	###   maintained.
+	### [:writemap]
+	###   Trade safety for speed for databases that fit within available
+	###   memory. (See MDBX documentation for details.)
 	###
 	def self::open( *args, &block )
 		db = new( *args )
@@ -128,16 +131,43 @@ class MDBX::Database
 	attr_accessor :deserializer
 
 
+	alias_method :size, :length
+	alias_method :each, :each_pair
+	alias_method :has_key?, :include?
+
+
+	### Gets or sets the sub-database "collection" that read/write
+	### operations apply to. If a block is passed, the collection
+	### automatically reverts to the prior collection when it exits.
+	###
+	###  db.collection #=> (collection name, or nil if in main)
+	###  db.collection( 'collection_name' ) #=> db
+	###
+	###  db.collection( 'collection_name' ) do
+	###      [ ... ]
+	###  end # reverts to the previous collection name
+	###
+	def collection( name=nil )
+		current = self.get_subdb
+		return current unless name
+
+		self.set_subdb( name.to_s )
+		yield( self ) if block_given?
+
+		return self
+
+	ensure
+		self.set_subdb( current ) if name && block_given?
+	end
+	alias_method :namespace, :collection
+
+
 	### Switch to the top-level collection.
 	###
 	def main
-		return self.collection( nil )
+		return self.set_subdb( nil )
 	end
 
-	alias_method :namespace, :collection
-	alias_method :size, :length
-	alias_method :each, :each_pair
-
 
 	#
 	# Transaction methods
@@ -334,6 +364,34 @@ class MDBX::Database
 	protected
 	#########
 
+
+	### Safely serialize a value, closing any open transaction and re-raising
+	### if necessary.
+	###
+	def serialize( val )
+		return val unless self.serializer
+		return self.serializer.call( val )
+
+	rescue => err
+		self.close_transaction( false )
+		raise err
+	end
+
+
+	### Safely deserialize a value, closing any open transaction and re-raising
+	### if necessary.
+	###
+	def deserialize( val )
+		return val unless self.deserializer
+		return self.deserializer.call( val )
+
+	rescue => err
+		self.close_transaction( false )
+		raise err
+	end
+
+
+
 	### Yield and return the block, opening a snapshot first if
 	### there isn't already a transaction in progress.  Closes
 	### the snapshot if this method opened it.

data/lib/mdbx.rb

@@ -2,15 +2,22 @@
 # vim: set nosta noet ts=4 sw=4 ft=ruby:
 # encoding: utf-8
 
+require 'loggability'
+
 require 'mdbx_ext'
 
 
 # Top level namespace for MDBX.
 #
 module MDBX
+	extend Loggability
 
 	# The version of this gem.
-	VERSION = '0.2.0'
+	VERSION = '0.3.3'
+
+
+	log_as :mdbx
+
 
 end # module MDBX
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdbx
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Mahlon E. Smith
@@ -34,8 +34,22 @@ cert_chain:
   49pOzX5KHZLTS9DKeaP/xcGPz6C8MiwQdYrZarr2SHRASX1zFa79rkItO8kE6RDr
   b6WDF79UvZ55ajtE00TiwqjQL/ZPEtbd
   -----END CERTIFICATE-----
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: loggability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement