Move/refactoring of public interfaces..
[idzebra-moved-to-github.git] / bfile / cfile.c
index 7bbb8dc..60dc4d2 100644 (file)
@@ -1,70 +1,42 @@
-/*
- * Copyright (C) 1995, Index Data I/S 
- * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: cfile.c,v $
- * Revision 1.13  1996-04-09 14:48:49  adam
- * Bug fix: offset calculation when using flat files was completely broken.
- *
- * Revision 1.12  1996/04/09  06:47:28  adam
- * Function scan_areadef doesn't use sscanf (%n fails on this Linux).
- *
- * Revision 1.11  1996/03/26 15:59:05  adam
- * The directory of the shadow table file can be specified by the new
- * bf_lockDir call.
- *
- * Revision 1.10  1996/02/07  14:03:46  adam
- * Work on flat indexed shadow files.
- *
- * Revision 1.9  1996/02/07  10:08:43  adam
- * Work on flat shadow (not finished yet).
- *
- * Revision 1.8  1995/12/15  12:36:52  adam
- * Moved hash file information to union.
- * Renamed commit files.
- *
- * Revision 1.7  1995/12/15  10:35:07  adam
- * Changed names of commit files.
- *
- * Revision 1.6  1995/12/11  09:03:53  adam
- * New function: cf_unlink.
- * New member of commit file head: state (0) deleted, (1) hash file.
- *
- * Revision 1.5  1995/12/08  16:21:14  adam
- * Work on commit/update.
- *
- * Revision 1.4  1995/12/01  16:24:28  adam
- * Commit files use separate meta file area.
- *
- * Revision 1.3  1995/12/01  11:37:22  adam
- * Cached/commit files implemented as meta-files.
- *
- * Revision 1.2  1995/11/30  17:00:49  adam
- * Several bug fixes. Commit system runs now.
- *
- * Revision 1.1  1995/11/30  08:33:11  adam
- * Started work on commit facility.
- *
- */
+/* $Id: cfile.c,v 1.32 2004-12-08 12:23:08 adam Exp $
+   Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
+   Index Data Aps
+
+This file is part of the Zebra server.
+
+Zebra is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with Zebra; see the file LICENSE.zebra.  If not, write to the
+Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
+*/
 
 #include <assert.h>
 #include <stdlib.h>
 #include <string.h>
 
-#include <alexutil.h>
-#include <mfile.h>
+#include <zebrautl.h>
+#include "mfile.h"
 #include "cfile.h"
 
 static int write_head (CFile cf)
 {
-    int left = cf->head.hash_size * sizeof(int);
+    int left = cf->head.hash_size * sizeof(zint);
     int bno = 1;
     const char *tab = (char*) cf->array;
 
     if (!tab)
         return 0;
-    while (left >= HASH_BSIZE)
+    while (left >= (int) HASH_BSIZE)
     {
         mf_write (cf->hash_mf, bno++, 0, 0, tab);
         tab += HASH_BSIZE;
@@ -77,13 +49,13 @@ static int write_head (CFile cf)
 
 static int read_head (CFile cf)
 {
-    int left = cf->head.hash_size * sizeof(int);
+    int left = cf->head.hash_size * sizeof(zint);
     int bno = 1;
     char *tab = (char*) cf->array;
 
     if (!tab)
         return 0;
-    while (left >= HASH_BSIZE)
+    while (left >= (int) HASH_BSIZE)
     {
         mf_read (cf->hash_mf, bno++, 0, 0, tab);
         tab += HASH_BSIZE;
@@ -100,21 +72,21 @@ CFile cf_open (MFile mf, MFile_area area, const char *fname,
 {
     char path[1024];
     int i;
-    CFile cf = xmalloc (sizeof(*cf));
+    CFile cf = (CFile) xmalloc (sizeof(*cf));
     int hash_bytes;
    
     cf->rmf = mf; 
-    logf (LOG_LOG, "cf_open %s", cf->rmf->name);
+    yaz_log (YLOG_DEBUG, "cf: open %s %s", cf->rmf->name, wflag ? "rdwr" : "rd");
     sprintf (path, "%s-b", fname);
     if (!(cf->block_mf = mf_open (area, path, block_size, wflag)))
     {
-        logf (LOG_FATAL|LOG_ERRNO, "Failed to open %s", path);
+        yaz_log (YLOG_FATAL|YLOG_ERRNO, "Failed to open %s", path);
         exit (1);
     }
     sprintf (path, "%s-i", fname);
     if (!(cf->hash_mf = mf_open (area, path, HASH_BSIZE, wflag)))
     {
-        logf (LOG_FATAL|LOG_ERRNO, "Failed to open %s", path);
+        yaz_log (YLOG_FATAL|YLOG_ERRNO, "Failed to open %s", path);
         exit (1);
     }
     assert (firstp);
@@ -125,13 +97,13 @@ CFile cf_open (MFile mf, MFile_area area, const char *fname,
         cf->head.state = 1;
         cf->head.block_size = block_size;
         cf->head.hash_size = 199;
-        hash_bytes = cf->head.hash_size * sizeof(int);
+        hash_bytes = cf->head.hash_size * sizeof(zint);
         cf->head.flat_bucket = cf->head.next_bucket = cf->head.first_bucket = 
             (hash_bytes+sizeof(cf->head))/HASH_BSIZE + 2;
-        cf->head.next_block = 0;
+        cf->head.next_block = 1;
         if (wflag)
             mf_write (cf->hash_mf, 0, 0, sizeof(cf->head), &cf->head);
-        cf->array = xmalloc (hash_bytes);
+        cf->array = (zint *) xmalloc (hash_bytes);
         for (i = 0; i<cf->head.hash_size; i++)
             cf->array[i] = 0;
         if (wflag)
@@ -142,17 +114,19 @@ CFile cf_open (MFile mf, MFile_area area, const char *fname,
         *firstp = 0;
         assert (cf->head.block_size == block_size);
         assert (cf->head.hash_size > 2);
-        hash_bytes = cf->head.hash_size * sizeof(int);
+        hash_bytes = cf->head.hash_size * sizeof(zint);
         assert (cf->head.next_bucket > 0);
+        assert (cf->head.next_block > 0);
         if (cf->head.state == 1)
-            cf->array = xmalloc (hash_bytes);
+            cf->array = (zint *) xmalloc (hash_bytes);
         else
             cf->array = NULL;
         read_head (cf);
     }
     if (cf->head.state == 1)
     {
-        cf->parray = xmalloc (cf->head.hash_size * sizeof(*cf->parray));
+        cf->parray = (struct CFile_hash_bucket **)
+           xmalloc (cf->head.hash_size * sizeof(*cf->parray));
         for (i = 0; i<cf->head.hash_size; i++)
             cf->parray[i] = NULL;
     }
@@ -162,16 +136,17 @@ CFile cf_open (MFile mf, MFile_area area, const char *fname,
     cf->bucket_in_memory = 0;
     cf->max_bucket_in_memory = 100;
     cf->dirty = 0;
-    cf->iobuf = xmalloc (cf->head.block_size);
+    cf->iobuf = (char *) xmalloc (cf->head.block_size);
     memset (cf->iobuf, 0, cf->head.block_size);
     cf->no_hits = 0;
     cf->no_miss = 0;
+    zebra_mutex_init (&cf->mutex);
     return cf;
 }
 
-static int cf_hash (CFile cf, int no)
+static int cf_hash (CFile cf, zint no)
 {
-    return (no>>3) % cf->head.hash_size;
+    return (int) (((no >> 3) % cf->head.hash_size));
 }
 
 static void release_bucket (CFile cf, struct CFile_hash_bucket *p)
@@ -212,7 +187,7 @@ static void flush_bucket (CFile cf, int no_to_flush)
     }
 }
 
-static struct CFile_hash_bucket *alloc_bucket (CFile cf, int block_no, int hno)
+static struct CFile_hash_bucket *alloc_bucket (CFile cf, zint block_no, int hno)
 {
     struct CFile_hash_bucket *p, **pp;
 
@@ -220,7 +195,7 @@ static struct CFile_hash_bucket *alloc_bucket (CFile cf, int block_no, int hno)
         flush_bucket (cf, 1);
     assert (cf->bucket_in_memory < cf->max_bucket_in_memory);
     ++(cf->bucket_in_memory);
-    p = xmalloc (sizeof(*p));
+    p = (struct CFile_hash_bucket *) xmalloc (sizeof(*p));
 
     p->lru_next = NULL;
     p->lru_prev = cf->bucket_lru_front;
@@ -239,14 +214,14 @@ static struct CFile_hash_bucket *alloc_bucket (CFile cf, int block_no, int hno)
     return p;
 }
 
-static struct CFile_hash_bucket *get_bucket (CFile cf, int block_no, int hno)
+static struct CFile_hash_bucket *get_bucket (CFile cf, zint block_no, int hno)
 {
     struct CFile_hash_bucket *p;
 
     p = alloc_bucket (cf, block_no, hno);
     if (!mf_read (cf->hash_mf, block_no, 0, 0, &p->ph))
     {
-        logf (LOG_FATAL|LOG_ERRNO, "read get_bucket");
+        yaz_log (YLOG_FATAL|YLOG_ERRNO, "read get_bucket");
         exit (1);
     }
     assert (p->ph.this_bucket == block_no);
@@ -254,13 +229,14 @@ static struct CFile_hash_bucket *get_bucket (CFile cf, int block_no, int hno)
     return p;
 }
 
-static struct CFile_hash_bucket *new_bucket (CFile cf, int *block_no, int hno)
+static struct CFile_hash_bucket *new_bucket (CFile cf, zint *block_nop, int hno)
 {
     struct CFile_hash_bucket *p;
     int i;
+    zint block_no;
 
-    *block_no = cf->head.next_bucket++;
-    p = alloc_bucket (cf, *block_no, hno);
+    block_no = *block_nop = cf->head.next_bucket++;
+    p = alloc_bucket (cf, block_no, hno);
 
     for (i = 0; i<HASH_BUCKET; i++)
     {
@@ -268,26 +244,27 @@ static struct CFile_hash_bucket *new_bucket (CFile cf, int *block_no, int hno)
         p->ph.no[i] = 0;
     }
     p->ph.next_bucket = 0;
-    p->ph.this_bucket = *block_no;
+    p->ph.this_bucket = block_no;
     p->dirty = 1;
     return p;
 }
 
-static int cf_lookup_flat (CFile cf, int no)
+static zint cf_lookup_flat (CFile cf, zint no)
 {
-    int hno = (no*sizeof(int))/HASH_BSIZE;
-    int off = (no*sizeof(int)) - hno*HASH_BSIZE;
-    int vno = 0;
+    zint hno = (no*sizeof(zint))/HASH_BSIZE;
+    int off = (int) ((no*sizeof(zint)) - hno*HASH_BSIZE);
+    zint vno = 0;
 
-    mf_read (cf->hash_mf, hno+cf->head.next_bucket, off, sizeof(int), &vno);
+    mf_read (cf->hash_mf, hno+cf->head.next_bucket, off, sizeof(zint), &vno);
     return vno;
 }
 
-static int cf_lookup_hash (CFile cf, int no)
+static zint cf_lookup_hash (CFile cf, zint no)
 {
     int hno = cf_hash (cf, no);
     struct CFile_hash_bucket *hb;
-    int block_no, i;
+    zint block_no;
+    int i;
 
     for (hb = cf->parray[hno]; hb; hb = hb->h_next)
     {
@@ -307,6 +284,23 @@ static int cf_lookup_hash (CFile cf, int no)
         }
         if (hb)
             continue;
+#if 0
+        /* extra check ... */
+        for (hb = cf->bucket_lru_back; hb; hb = hb->lru_next)
+        {
+            if (hb->ph.this_bucket == block_no)
+            {
+                yaz_log (YLOG_FATAL, "Found hash bucket on other chain (1)");
+                abort ();
+            }
+            for (i = 0; i<HASH_BUCKET && hb->ph.vno[i]; i++)
+                if (hb->ph.no[i] == no)
+                {
+                    yaz_log (YLOG_FATAL, "Found hash bucket on other chain (2)");
+                    abort ();
+                }
+        }
+#endif
         (cf->no_miss)++;
         hb = get_bucket (cf, block_no, hno);
         for (i = 0; i<HASH_BUCKET && hb->ph.vno[i]; i++)
@@ -316,35 +310,38 @@ static int cf_lookup_hash (CFile cf, int no)
     return 0;
 }
 
-static void cf_write_flat (CFile cf, int no, int vno)
+static void cf_write_flat (CFile cf, zint no, zint vno)
 {
-    int hno = (no*sizeof(int))/HASH_BSIZE;
-    int off = (no*sizeof(int)) - hno*HASH_BSIZE;
+    zint hno = (no*sizeof(zint))/HASH_BSIZE;
+    int off = (int) ((no*sizeof(zint)) - hno*HASH_BSIZE);
 
     hno += cf->head.next_bucket;
     if (hno >= cf->head.flat_bucket)
         cf->head.flat_bucket = hno+1;
-    mf_write (cf->hash_mf, hno, off, sizeof(int), &vno);
+    cf->dirty = 1;
+    mf_write (cf->hash_mf, hno, off, sizeof(zint), &vno);
 }
 
 static void cf_moveto_flat (CFile cf)
 {
     struct CFile_hash_bucket *p;
-    int i, j;
+    int j;
+    zint i;
 
-    logf (LOG_LOG, "Moving to flat shadow: %s", cf->rmf->name);
-    logf (LOG_LOG, "hits=%d miss=%d bucket_in_memory=%d total=%d",
+    yaz_log (YLOG_DEBUG, "cf: Moving to flat shadow: %s", cf->rmf->name);
+    yaz_log (YLOG_DEBUG, "cf: hits=%d miss=%d bucket_in_memory=" ZINT_FORMAT " total="
+         ZINT_FORMAT,
        cf->no_hits, cf->no_miss, cf->bucket_in_memory, 
         cf->head.next_bucket - cf->head.first_bucket);
     assert (cf->head.state == 1);
     flush_bucket (cf, -1);
     assert (cf->bucket_in_memory == 0);
-    p = xmalloc (sizeof(*p));
+    p = (struct CFile_hash_bucket *) xmalloc (sizeof(*p));
     for (i = cf->head.first_bucket; i < cf->head.next_bucket; i++)
     {
         if (!mf_read (cf->hash_mf, i, 0, 0, &p->ph))
         {
-            logf (LOG_FATAL|LOG_ERRNO, "read bucket moveto flat");
+            yaz_log (YLOG_FATAL|YLOG_ERRNO, "read bucket moveto flat");
             exit (1);
         }
         for (j = 0; j < HASH_BUCKET && p->ph.vno[j]; j++)
@@ -356,29 +353,31 @@ static void cf_moveto_flat (CFile cf)
     xfree (cf->parray);
     cf->parray = NULL;
     cf->head.state = 2;
+    cf->dirty = 1;
 }
 
-static int cf_lookup (CFile cf, int no)
+static zint cf_lookup (CFile cf, zint no)
 {
     if (cf->head.state > 1)
         return cf_lookup_flat (cf, no);
     return cf_lookup_hash (cf, no);
 }
 
-static int cf_new_flat (CFile cf, int no)
+static zint cf_new_flat (CFile cf, zint no)
 {
-    int vno = (cf->head.next_block)++;
+    zint vno = (cf->head.next_block)++;
 
     cf_write_flat (cf, no, vno);
     return vno;
 }
 
-static int cf_new_hash (CFile cf, int no)
+static zint cf_new_hash (CFile cf, zint no)
 {
     int hno = cf_hash (cf, no);
     struct CFile_hash_bucket *hbprev = NULL, *hb = cf->parray[hno];
-    int *bucketpp = &cf->array[hno]; 
-    int i, vno = (cf->head.next_block)++;
+    zint *bucketpp = &cf->array[hno]; 
+    int i;
+    zint vno = (cf->head.next_block)++;
   
     for (hb = cf->parray[hno]; hb; hb = hb->h_next)
         if (!hb->ph.vno[HASH_BUCKET-1])
@@ -403,6 +402,18 @@ static int cf_new_hash (CFile cf, int no)
             }
         if (hb)
             continue;
+
+#if 0
+        /* extra check ... */
+        for (hb = cf->bucket_lru_back; hb; hb = hb->lru_next)
+        {
+            if (hb->ph.this_bucket == *bucketpp)
+            {
+                yaz_log (YLOG_FATAL, "Found hash bucket on other chain");
+                abort ();
+            }
+        }
+#endif
         (cf->no_miss)++;
         hb = get_bucket (cf, *bucketpp, hno);
         assert (hb);
@@ -425,11 +436,11 @@ static int cf_new_hash (CFile cf, int no)
     return vno;
 }
 
-int cf_new (CFile cf, int no)
+zint cf_new (CFile cf, zint no)
 {
     if (cf->head.state > 1)
         return cf_new_flat (cf, no);
-    if (cf->no_miss*5 > cf->no_hits)
+    if (cf->no_miss*2 > cf->no_hits)
     {
         cf_moveto_flat (cf);
         assert (cf->head.state > 1);
@@ -439,41 +450,49 @@ int cf_new (CFile cf, int no)
 }
 
 
-int cf_read (CFile cf, int no, int offset, int num, void *buf)
+int cf_read (CFile cf, zint no, int offset, int nbytes, void *buf)
 {
-    int block;
+    zint block;
     
     assert (cf);
+    zebra_mutex_lock (&cf->mutex);
     if (!(block = cf_lookup (cf, no)))
+    {
+       zebra_mutex_unlock (&cf->mutex);
         return -1;
-    if (!mf_read (cf->block_mf, block, offset, num, buf))
+    }
+    zebra_mutex_unlock (&cf->mutex);
+    if (!mf_read (cf->block_mf, block, offset, nbytes, buf))
     {
-        logf (LOG_FATAL|LOG_ERRNO, "cf_read no=%d, block=%d", no, block);
+        yaz_log (YLOG_FATAL|YLOG_ERRNO, "cf_read no=" ZINT_FORMAT " block=" ZINT_FORMAT, no, block);
         exit (1);
     }
     return 1;
 }
 
-int cf_write (CFile cf, int no, int offset, int num, const void *buf)
+int cf_write (CFile cf, zint no, int offset, int nbytes, const void *buf)
 {
-    int block;
+    zint block;
 
     assert (cf);
+    zebra_mutex_lock (&cf->mutex);
     if (!(block = cf_lookup (cf, no)))
     {
         block = cf_new (cf, no);
-        if (offset || num)
+        if (offset || nbytes)
         {
             mf_read (cf->rmf, no, 0, 0, cf->iobuf);
-            memcpy (cf->iobuf + offset, buf, num);
+            memcpy (cf->iobuf + offset, buf, nbytes);
             buf = cf->iobuf;
             offset = 0;
-            num = 0;
+            nbytes = 0;
         }
     }
-    if (mf_write (cf->block_mf, block, offset, num, buf))
+    zebra_mutex_unlock (&cf->mutex);
+    if (mf_write (cf->block_mf, block, offset, nbytes, buf))
     {
-        logf (LOG_FATAL|LOG_ERRNO, "cf_write no=%d, block=%d", no, block);
+        yaz_log (YLOG_FATAL|YLOG_ERRNO, "cf_write no=" ZINT_FORMAT
+             " block=" ZINT_FORMAT, no, block);
         exit (1);
     }
     return 0;
@@ -481,8 +500,8 @@ int cf_write (CFile cf, int no, int offset, int num, const void *buf)
 
 int cf_close (CFile cf)
 {
-    logf (LOG_LOG, "cf_close %s", cf->rmf->name);
-    logf (LOG_LOG, "hits=%d miss=%d bucket_in_memory=%d total=%d",
+    yaz_log (YLOG_DEBUG, "cf: close hits=%d miss=%d bucket_in_memory=" ZINT_FORMAT
+         " total=" ZINT_FORMAT,
           cf->no_hits, cf->no_miss, cf->bucket_in_memory,
           cf->head.next_bucket - cf->head.first_bucket);
     flush_bucket (cf, -1);
@@ -496,6 +515,7 @@ int cf_close (CFile cf)
     xfree (cf->array);
     xfree (cf->parray);
     xfree (cf->iobuf);
+    zebra_mutex_destroy (&cf->mutex);
     xfree (cf);
     return 0;
 }