flatdb.h

   1 /*
   2  * Copyright (c) 2004 Teodor Sigaev <teodor@sigaev.ru>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *        notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *        notice, this list of conditions and the following disclaimer in the
  12  *        documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the author nor the names of any co-contributors
  14  *        may be used to endorse or promote products derived from this software
  15  *        without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED. IN NO EVENT SHALL CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29 #ifndef __FLAT_DB__
  30 #define __FLAT_DB__
  31
  32 #include <sys/types.h>
  33
  34 typedef struct {
  35         off_t   freespace;
  36         size_t  lenfreespace;
  37         u_int32_t
  38                 unused:31,
  39                 isopened:1;
  40 } FDBHeader;
  41
  42 typedef struct {
  43         size_t  length;
  44         char    data[1];
  45 } FDBRecord;
  46
  47 #define RECHDRSZ        (sizeof(size_t))
  48
  49 typedef struct {
  50         off_t   offset;
  51         size_t  length;
  52 } FDBFreeSpace;
  53
  54 typedef struct {
  55         int     fd; /* file descriptor */
  56         u_int32_t       unused:31,
  57                         readonly:1;
  58         u_int32_t       listlen;
  59         u_int32_t       listcur;
  60         FDBFreeSpace    *space;
  61 } FDB;
  62
  63 int FDBOpen(FDB *db, char *file, int readonly);
  64 int FDBClose(FDB *db);
  65 int FDBPut(FDB *db, FDBRecord *record /*in*/, off_t *offset /*out*/);
  66 int FDBGet(FDB *db, off_t offset /* in */, size_t length /*in, may =0, then stored size*/, FDBRecord **record /*out*/);
  67 int FDBDelete(FDB *db, off_t offset /* in */, size_t length /*in, may =0, then stored size*/ );
  68 void FDBVacuumFreeSpace(FDB *db);
  69
  70 #define FDB_OK          0
  71 #define FDB_NOTFOUND    1
  72 #define FDB_ERROR       2
  73 #define FDB_INCORRECT   3
  74
  75 #endif