isomorfeus-ferret 0.12.4 → 0.12.5

data/README.md

@@ -1,48 +1,80 @@
-<h1 align="center">
-  <img src="https://github.com/isomorfeus/isomorfeus-ferret/blob/master/Logo.png?raw=true" align="center" width="216" height="234" />
-  <br/>
-&nbsp;&nbsp;&nbsp;Isomorfeus Ferret<br/>
-</h1>
-
-Convenient and well performing document store, indexing and search.
-
-### Community and Support
-At the [Isomorfeus Framework Project](http://isomorfeus.com)
-
-## About this project
-
-Isomorfeus-Ferret is a revived version of the original ferret gem created by Dave Balmain.
-During revival many things havbe been fixed, now all tests pass, no crashes and it
-successfully compiles and runs with rubys >3. Its no longer a goal to have
-a c library available, but instead the usage is meant as ruby gem with a c extension only.
-
-It should work on *nixes and *nuxes and also works on Windows.
-
-However, the revival is still fresh and although it appears to be working, issues have to be expected.
-
-
-## Documentation
-
-The documentations is currently scattered throughout the repo.
-
-For a quick start its best to read:
-https://github.com/isomorfeus/isomorfeus-ferret/blob/master/TUTORIAL.md
-
-Further:
-https://github.com/isomorfeus/isomorfeus-ferret/blob/master/lib/isomorfeus/ferret/index/index.rb
-https://github.com/isomorfeus/isomorfeus-ferret/blob/master/lib/isomorfeus/ferret/document.rb
-
-The query language and parser are documented here:
-https://github.com/isomorfeus/isomorfeus-ferret/blob/master/ext/isomorfeus_ferret_ext/frb_qparser.c
-
-Examples can be found in the 'test' directory or in 'misc/ferret_vs_lucene'.
-## Future
-
-Lots of things to do:
-- Bring documentation in order in a docs directory
-- Review code (especially for memory/stack issues, typical c issues)
-- Take care of ruby GVL and threading
-- Check locking (thread and filesystem)
-- See todo directory: https://github.com/isomorfeus/isomorfeus-ferret/tree/master/misc/todo
-
-Any help, support much appreciated!
+<h1 align="center">
+  <img src="https://github.com/isomorfeus/isomorfeus-ferret/blob/master/Logo.png?raw=true" align="center" width="216" height="234" />
+  <br/>
+&nbsp;&nbsp;&nbsp;Isomorfeus Ferret<br/>
+</h1>
+
+Convenient and well performing document store, indexing and search.
+
+### Community and Support
+At the [Isomorfeus Framework Project](https://isomorfeus.com)
+
+## About this project
+
+Isomorfeus-Ferret is a revived version of the original ferret gem created by Dave Balmain.
+During revival many things havbe been fixed, now all tests pass, no crashes and it
+successfully compiles and runs with rubys >3. Its no longer a goal to have
+a c library available, but instead the usage is meant as ruby gem with a c extension only.
+
+It should work on *nixes and *nuxes and also works on Windows.
+
+However, the revival is still fresh and although it appears to be working, issues have to be expected.
+
+## Documentation
+
+The documentations is currently scattered throughout the repo.
+
+For a quick start its best to read:
+https://github.com/isomorfeus/isomorfeus-ferret/blob/master/TUTORIAL.md
+
+Further:
+https://github.com/isomorfeus/isomorfeus-ferret/blob/master/lib/isomorfeus/ferret/index/index.rb
+https://github.com/isomorfeus/isomorfeus-ferret/blob/master/lib/isomorfeus/ferret/document.rb
+
+The query language and parser are documented here:
+https://github.com/isomorfeus/isomorfeus-ferret/blob/master/ext/isomorfeus_ferret_ext/frb_qparser.c
+
+Examples can be found in the 'test' directory or in 'misc/ferret_vs_lucene'.
+
+## Running Specs
+
+- clone repo
+- bundle install
+- rake units
+- rake thread_safety
+
+Ensure your locale is set to C.UTF-8, because the internal c tests don't know how to handle localized output.
+
+## Benchmarks
+
+- clone repo
+- bundle install
+- rake ferret_vs_lucene
+
+A recent Java JDK must be installed to compile and run lucene benchmarks.
+
+Results on Linux:
+```
+Ferret:
+Indexing Secs: 7.36  Docs: 19043, 2587 docs/s
+Searching took: 0.3366296s for 8000 queries
+thats 23765 q/s
+
+Lucene:
+Indexing Secs: 4.22  Docs: 19043, 4516 docs/s
+Searching took: 1.48s for 8000 queries
+thats 5420 q/s
+---------------------------------------------------
+Lucene 9.0.0 0b18b3b965cedaf5eb129aa41243a44c83ca826d - jpountz - 2021-12-01 14:23:49
+JVM 17.0.1 (Private Build)
+```
+
+## Future
+
+Lots of things to do:
+- Bring documentation in order in a docs directory
+- Review code (especially for memory/stack issues, typical c issues)
+- Take care of ruby GVL and threading
+- See todo directory: https://github.com/isomorfeus/isomorfeus-ferret/tree/master/misc/todo
+
+Any help, support much appreciated!

data/ext/isomorfeus_ferret_ext/bm_hash.c

@@ -7,20 +7,21 @@
 static void ferret_hash()
 {
     int i;
+    void *res = NULL;
     for (i = 0; i < N; i++) {
         FrtHash *h = frt_h_new_str(NULL, NULL);
         const char **word;
         char buf[100];
-        long res;
         for (word = WORD_LIST; *word; word++) {
             frt_h_set(h, *word, (void *)1);
         }
         for (word = WORD_LIST; *word; word++) {
             strcpy(buf, *word);
-            res = (long)frt_h_get(h, buf);
+            res = frt_h_get(h, buf);
         }
         frt_h_destroy(h);
     }
+    (void)res;
 }
 
 BENCH(hash_implementations)
@@ -31,18 +32,19 @@ BENCH(hash_implementations)
 static void standard_hash()
 {
     int i;
+    void *res = NULL;
     for (i = 0; i < N; i++) {
         FrtHash *h = frt_h_new_str(NULL, NULL);
         const char **word;
         char buf[100];
-        long res;
         for (word = WORD_LIST; *word; word++) {
             frt_h_set(h, *word, (void *)1);
             strcpy(buf, *word);
-            res = (long)frt_h_get(h, buf);
+            res = frt_h_get(h, buf);
         }
         frt_h_destroy(h);
     }
+    (void)res;
 }
 
 #define PERTURB_SHIFT 5
@@ -96,19 +98,20 @@ static FrtHashEntry *h_lookup_str(FrtHash *ht, register const void *key)
 static void string_hash()
 {
     int i;
+    void *res = NULL;
     for (i = 0; i < N; i++) {
         FrtHash *h = frt_h_new_str(NULL, NULL);
         const char **word;
         char buf[100];
-        long res;
         h->lookup_i = &h_lookup_str;
         for (word = WORD_LIST; *word; word++) {
             frt_h_set(h, *word, (void *)1);
             strcpy(buf, *word);
-            res = (long)frt_h_get(h, buf);
+            res = frt_h_get(h, buf);
         }
         frt_h_destroy(h);
     }
+    (void)res;
 }
 
 BENCH(specialized_string_hash)

data/ext/isomorfeus_ferret_ext/bm_micro_string.c

@@ -5,7 +5,7 @@
 
 static void do_strcmp()
 {
-    char **word;
+    const char **word;
     char buf[100];
     int res, i;
 
@@ -15,11 +15,12 @@ static void do_strcmp()
             memcpy(buf, *word, len+1);
             res = strcmp(buf, *word);
         }
+    (void)res;
 }
 
 static void do_strncmp()
 {
-    char **word;
+    const char **word;
     char buf[100];
     int res, i;
 
@@ -29,6 +30,7 @@ static void do_strncmp()
             memcpy(buf, *word, len+1);
             res = strncmp(buf, *word, len + 1);
         }
+    (void)res;
 }
 
 BENCH(strcmp_when_length_is_known)

data/ext/isomorfeus_ferret_ext/frb_store.c

@@ -1,5 +1,6 @@
 #include "frt_store.h"
 #include "isomorfeus_ferret.h"
+#include <time.h>
 
 static ID id_ref_cnt;
 VALUE cLock;
@@ -70,13 +71,26 @@ frb_lock_obtain(int argc, VALUE *argv, VALUE self)
     int timeout = 1;
     FrtLock *lock;
     GET_LOCK(lock, self);
+    bool got_lock = false;
+    bool got_timeout = false;
+    time_t end_t;
 
     if (rb_scan_args(argc, argv, "01", &rtimeout) > 0) {
         timeout = FIX2INT(rtimeout);
     }
-    /* TODO: use the lock timeout */
-    (void)timeout;
-    if (!lock->obtain(lock)) {
+    end_t = time(NULL) + timeout;
+    if (lock->obtain(lock)) {
+        got_lock = true;
+    }
+    while (!got_lock && !got_timeout) {
+        frt_micro_sleep(10000);
+        if (lock->obtain(lock)) {
+            got_lock = true;
+        } else if (time(NULL) >= end_t) {
+            got_timeout = true;
+        }
+    }
+    if (!got_lock) {
         rb_raise(cLockError, "could not obtain lock: #%s", lock->name);
     }
     return Qtrue;
@@ -103,11 +117,26 @@ frb_lock_while_locked(int argc, VALUE *argv, VALUE self)
     int timeout = 1;
     FrtLock *lock;
     GET_LOCK(lock, self);
+    bool got_lock = false;
+    bool got_timeout = false;
+    time_t end_t;
+
     if (rb_scan_args(argc, argv, "01", &rtimeout) > 0) {
         timeout = FIX2INT(rtimeout);
     }
-    (void)timeout;
-    if (!lock->obtain(lock)) {
+    end_t = time(NULL) + timeout;
+    if (lock->obtain(lock)) {
+        got_lock = true;
+    }
+    while (!got_lock && !got_timeout) {
+        frt_micro_sleep(10000);
+        if (lock->obtain(lock)) {
+            got_lock = true;
+        } else if (time(NULL) >= end_t) {
+            got_timeout = true;
+        }
+    }
+    if (!got_lock) {
         rb_raise(cLockError, "could not obtain lock: #%s", lock->name);
     }
     rb_yield(Qnil);

data/ext/isomorfeus_ferret_ext/frt_posh.h

@@ -236,7 +236,11 @@ Metrowerks:
 #endif
 
 #if defined __GNUC__
-#  define POSH_COMPILER_STRING "Gnu GCC"
+#  if defined __MINGW32__
+#     define POSH_COMPILER_STRING "MingW Gnu GCC"
+#  else
+#     define POSH_COMPILER_STRING "Gnu GCC"
+#  endif
 #  define POSH_COMPILER_GCC 1
 #endif
 
@@ -307,9 +311,13 @@ Metrowerks:
 
 #if defined __MINGW32__
 #  define POSH_OS_MINGW 1
-#  define POSH_OS_STRING "MinGW"
 #  if defined _WIN64
 #    define POSH_OS_WIN64 1
+#    define POSH_OS_STRING "Win64"
+#  elif defined _WIN32
+#    define POSH_OS_STRING "Win32"
+#  else
+#    define POSH_OS_STRING "MinGW"
 #  endif
 #endif
 
@@ -474,7 +482,7 @@ Metrowerks:
 #  define POSH_CPU_SPARC 1
 #endif
 
-#if defined ARM || defined __arm__ || defined _ARM || __aarch64__
+#if defined ARM || defined __arm__ || defined _ARM || defined __aarch64__
 #  define POSH_CPU_STRONGARM 1
 #  define POSH_CPU_STRING "ARM"
 #endif
@@ -690,16 +698,6 @@ typedef unsigned long long posh_u64_t;
 #  define POSH_I64_PRINTF_PREFIX "ll"
 #endif
 
-/* hack */
-#ifdef __MINGW32__
-#undef POSH_I64
-#undef POSH_U64
-#undef POSH_I64_PRINTF_PREFIX
-#define POSH_I64( x ) ((posh_i64_t)x)
-#define POSH_U64( x ) ((posh_u64_t)x)
-#define POSH_I64_PRINTF_PREFIX "I64"
-#endif
-
 /** Minimum value for a 64-bit signed integer */
 #define POSH_I64_MIN  POSH_I64(0x8000000000000000)
 /** Maximum value for a 64-bit signed integer */
@@ -965,9 +963,3 @@ extern posh_i64_t  POSH_ReadI64FromBig( const void *src );
 #  endif /* POSH_64BIT_INTEGER */
 
 #endif
-
-#ifdef __cplusplus
-}
-#endif
-
-