LCOV - code coverage report
Current view: top level - backends/honey - honey_table.h (source / functions) Hit Total Coverage
Test: Test Coverage for xapian-core eba1a2e3082b Lines: 188 206 91.3 %
Date: 2019-06-13 13:35:36 Functions: 41 44 93.2 %
Branches: 81 118 68.6 %

           Branch data     Line data    Source code
       1                 :            : /** @file honey_table.h
       2                 :            :  * @brief HoneyTable class
       3                 :            :  */
       4                 :            : /* Copyright (C) 2017,2018 Olly Betts
       5                 :            :  *
       6                 :            :  * This program is free software; you can redistribute it and/or modify
       7                 :            :  * it under the terms of the GNU General Public License as published by
       8                 :            :  * the Free Software Foundation; either version 2 of the License, or
       9                 :            :  * (at your option) any later version.
      10                 :            :  *
      11                 :            :  * This program is distributed in the hope that it will be useful,
      12                 :            :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      13                 :            :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      14                 :            :  * GNU General Public License for more details.
      15                 :            :  *
      16                 :            :  * You should have received a copy of the GNU General Public License
      17                 :            :  * along with this program; if not, write to the Free Software
      18                 :            :  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
      19                 :            :  */
      20                 :            : 
      21                 :            : #ifndef XAPIAN_INCLUDED_HONEY_TABLE_H
      22                 :            : #define XAPIAN_INCLUDED_HONEY_TABLE_H
      23                 :            : 
      24                 :            : #ifndef PACKAGE
      25                 :            : # error config.h must be included first in each C++ source file
      26                 :            : #endif
      27                 :            : 
      28                 :            : #define SSTINDEX_ARRAY
      29                 :            : //#define SSTINDEX_BINARY_CHOP
      30                 :            : //#define SSTINDEX_SKIPLIST
      31                 :            : 
      32                 :            : #define SSTINDEX_BINARY_CHOP_KEY_SIZE 4
      33                 :            : #define SSTINDEX_BINARY_CHOP_PTR_SIZE 4
      34                 :            : #define SSTINDEX_BINARY_CHOP_ENTRY_SIZE \
      35                 :            :     (SSTINDEX_BINARY_CHOP_KEY_SIZE + SSTINDEX_BINARY_CHOP_PTR_SIZE)
      36                 :            : 
      37                 :            : //#include "xapian/constants.h"
      38                 :            : #include "xapian/error.h"
      39                 :            : 
      40                 :            : #include <algorithm>
      41                 :            : #if 0
      42                 :            : #include <iostream> // FIXME
      43                 :            : #endif
      44                 :            : 
      45                 :            : #include <cerrno>
      46                 :            : #include <cstdio> // For EOF
      47                 :            : #include <cstdlib> // std::abort()
      48                 :            : #include <type_traits>
      49                 :            : #ifdef HAVE_SYS_UIO_H
      50                 :            : # include <sys/uio.h>
      51                 :            : #endif
      52                 :            : 
      53                 :            : #include <sys/types.h>
      54                 :            : #include "safesysstat.h"
      55                 :            : #include "safeunistd.h"
      56                 :            : 
      57                 :            : #include "compression_stream.h"
      58                 :            : #include "honey_defs.h"
      59                 :            : #include "honey_version.h"
      60                 :            : #include "internaltypes.h"
      61                 :            : #include "io_utils.h"
      62                 :            : #include "pack.h"
      63                 :            : #include "str.h"
      64                 :            : #include "stringutils.h"
      65                 :            : #include "wordaccess.h"
      66                 :            : 
      67                 :            : #include "unicode/description_append.h"
      68                 :            : 
      69                 :            : #ifdef BLK_UNUSED
      70                 :            : # undef BLK_UNUSED
      71                 :            : #endif // FIXME: namespace it?
      72                 :            : 
      73                 :            : const uint4 BLK_UNUSED = uint4(-1);
      74                 :            : 
      75                 :            : class HoneyFreeListChecker;
      76                 :            : 
      77                 :            : class BufferedFileCommon {
      78                 :            :     friend class BufferedFile;
      79                 :            :     int fd = -1;
      80                 :            :     unsigned _refs = 0;
      81                 :            :     off_t offset = 0;
      82                 :            : 
      83                 :       2386 :     BufferedFileCommon(int fd_, off_t offset_)
      84                 :       2386 :         : fd(fd_), _refs(1), offset(offset_) {}
      85                 :            : 
      86                 :            :     BufferedFileCommon(const BufferedFileCommon&) = delete;
      87                 :            : 
      88                 :            :     BufferedFileCommon& operator=(const BufferedFileCommon&) = delete;
      89                 :            : };
      90                 :            : 
      91                 :            : class BufferedFile {
      92                 :            :     BufferedFileCommon* common = nullptr;
      93                 :            : 
      94                 :            :     mutable off_t pos = 0;
      95                 :            :     bool read_only = true;
      96                 :            :     mutable size_t buf_end = 0;
      97                 :            :     mutable char buf[4096];
      98                 :            : 
      99                 :            :     const int FORCED_CLOSE = -2;
     100                 :            : 
     101                 :            :   public:
     102                 :       2996 :     BufferedFile() { }
     103                 :            : 
     104                 :      54775 :     BufferedFile(const BufferedFile& o) : common(o.common) {
     105         [ -  + ]:      54775 :         if (!o.read_only) std::abort();
     106         [ +  - ]:      54775 :         if (common) ++common->_refs;
     107                 :            : #if 0
     108                 :            :         if (o.buf_end) {
     109                 :            :             buf_end = o.buf_end;
     110                 :            :             std::memcpy(buf, o.buf, buf_end);
     111                 :            :         }
     112                 :            : #endif
     113                 :      54775 :     }
     114                 :            : 
     115                 :         14 :     BufferedFile(int fd_, off_t offset_, off_t pos_, bool read_only_)
     116                 :         14 :         : common(new BufferedFileCommon(fd_, offset_)),
     117                 :         14 :           pos(pos_), read_only(read_only_) {}
     118                 :            : 
     119                 :      57785 :     ~BufferedFile() {
     120 [ +  + ][ +  + ]:      57785 :         if (common && --common->_refs == 0)
                 [ +  + ]
     121                 :       2386 :             delete common;
     122                 :      57785 :     }
     123                 :            : 
     124                 :            :     off_t get_offset() const { return common->offset; }
     125                 :            : 
     126                 :       3010 :     void close(bool fd_owned) {
     127 [ +  + ][ +  + ]:       3010 :         if (common && common->fd >= 0) {
     128         [ +  + ]:       2378 :             if (fd_owned) ::close(common->fd);
     129                 :       2378 :             common->fd = -1;
     130                 :            :         }
     131                 :       3010 :     }
     132                 :            : 
     133                 :         18 :     void force_close(bool fd_owned) {
     134         [ +  + ]:         18 :         if (common) {
     135 [ +  - ][ +  + ]:         12 :             if (fd_owned && common->fd >= 0) ::close(common->fd);
     136                 :         12 :             common->fd = FORCED_CLOSE;
     137                 :            :         }
     138                 :         18 :     }
     139                 :            : 
     140 [ +  - ][ +  + ]:     293728 :     bool is_open() const { return common && common->fd >= 0; }
     141                 :            : 
     142                 :    1230939 :     bool was_forced_closed() const {
     143 [ +  - ][ +  + ]:    1230939 :         return !common || common->fd == FORCED_CLOSE;
     144                 :            :     }
     145                 :            : 
     146                 :       2996 :     bool open(const std::string& path, bool read_only_) {
     147 [ -  + ][ #  # ]:       2996 :         if (common && --common->_refs == 0)
                 [ -  + ]
     148                 :          0 :             delete common;
     149                 :       2996 :         common = nullptr;
     150                 :       2996 :         read_only = read_only_;
     151                 :            :         int fd;
     152         [ +  + ]:       2996 :         if (read_only) {
     153                 :            :             // FIXME: add new io_open_stream_rd() etc?
     154                 :       1824 :             fd = io_open_block_rd(path);
     155                 :            :         } else {
     156                 :            :             // FIXME: Always create anew for now...
     157                 :       1172 :             fd = io_open_block_wr(path, true);
     158                 :            :         }
     159         [ +  + ]:       2996 :         if (fd < 0) return false;
     160                 :       2372 :         common = new BufferedFileCommon(fd, 0);
     161                 :       2372 :         return true;
     162                 :            :     }
     163                 :            : 
     164                 :   32720326 :     off_t get_pos() const {
     165         [ +  + ]:   32720326 :         return read_only ? pos - buf_end : pos + buf_end;
     166                 :            :     }
     167                 :            : 
     168                 :      56667 :     void set_pos(off_t pos_) {
     169         [ +  + ]:      56667 :         if (!read_only) flush();
     170                 :            :         if (false && pos_ >= pos) { // FIXME: need to take buf_end into account
     171                 :            :             skip(pos_ - pos);
     172                 :            :         } else {
     173                 :            :             // FIXME: salvage some of the buffer if we can?
     174                 :      56667 :             buf_end = 0;
     175                 :      56667 :             pos = pos_;
     176                 :            :         }
     177                 :      56667 :     }
     178                 :            : 
     179                 :   32672668 :     void skip(size_t delta) const {
     180         [ -  + ]:   32672668 :         if (!read_only) std::abort();
     181                 :            :         // Keep any buffered data we can.
     182         [ +  + ]:   32672668 :         if (delta > buf_end) {
     183                 :    2948623 :             pos -= buf_end;
     184                 :    2948623 :             pos += delta;
     185                 :    2948623 :             buf_end = 0;
     186                 :            :         } else {
     187                 :   29724045 :             buf_end -= delta;
     188                 :            :         }
     189                 :   32672668 :     }
     190                 :            : 
     191                 :            : #if 0
     192                 :            :     bool empty() const {
     193                 :            :         if (buf_end) return false;
     194                 :            :         struct stat sbuf;
     195                 :            :         if (fd == -1 || fstat(fd, &sbuf) < 0) return true;
     196                 :            :         return (sbuf.st_size == 0);
     197                 :            :     }
     198                 :            : #endif
     199                 :            : 
     200                 :    2063394 :     void write(unsigned char ch) {
     201         [ +  + ]:    2063394 :         if (buf_end == sizeof(buf)) {
     202                 :            :             // writev()?
     203                 :        736 :             io_write(common->fd, buf, buf_end);
     204                 :        736 :             pos += buf_end;
     205                 :        736 :             buf_end = 0;
     206                 :            :         }
     207                 :    2063394 :         buf[buf_end++] = ch;
     208                 :    2063394 :     }
     209                 :            : 
     210                 :    3096271 :     void write(const char* p, size_t len) {
     211         [ +  + ]:    3096271 :         if (buf_end + len <= sizeof(buf)) {
     212                 :    3090936 :             memcpy(buf + buf_end, p, len);
     213                 :    3090936 :             buf_end += len;
     214                 :    3090936 :             return;
     215                 :            :         }
     216                 :            : 
     217                 :            : #ifdef HAVE_WRITEV
     218                 :       5335 :         pos += buf_end + len;
     219                 :            :         while (true) {
     220                 :            :             struct iovec iov[2];
     221                 :       5335 :             iov[0].iov_base = buf;
     222                 :       5335 :             iov[0].iov_len = buf_end;
     223                 :       5335 :             iov[1].iov_base = const_cast<char*>(p);
     224                 :       5335 :             iov[1].iov_len = len;
     225         [ +  - ]:       5335 :             ssize_t n_ = writev(common->fd, iov, 2);
     226         [ -  + ]:       5335 :             if (n_ < 0) std::abort();
     227                 :       5335 :             size_t n = n_;
     228         [ +  - ]:       5335 :             if (n == buf_end + len) {
     229                 :            :                 // Wrote everything.
     230                 :       5335 :                 buf_end = 0;
     231                 :    3096271 :                 return;
     232                 :            :             }
     233         [ #  # ]:          0 :             if (n >= buf_end) {
     234                 :            :                 // Wrote all of buf.
     235                 :          0 :                 n -= buf_end;
     236                 :          0 :                 p += n;
     237                 :          0 :                 len -= n;
     238         [ #  # ]:          0 :                 io_write(common->fd, p, len);
     239                 :          0 :                 buf_end = 0;
     240                 :          0 :                 return;
     241                 :            :             }
     242                 :          0 :             buf_end -= n;
     243                 :          0 :             memmove(buf, buf + n, buf_end);
     244                 :          0 :         }
     245                 :            : #else
     246                 :            :         io_write(common->fd, buf, buf_end);
     247                 :            :         pos += buf_end;
     248                 :            :         if (len >= sizeof(buf)) {
     249                 :            :             // If it's bigger than our buffer, just write it directly.
     250                 :            :             io_write(common->fd, p, len);
     251                 :            :             pos += len;
     252                 :            :             buf_end = 0;
     253                 :            :             return;
     254                 :            :         }
     255                 :            :         memcpy(buf, p, len);
     256                 :            :         buf_end = len;
     257                 :            : #endif
     258                 :            :     }
     259                 :            : 
     260                 :  106441956 :     int read() const {
     261         [ +  + ]:  106441956 :         if (buf_end == 0) {
     262                 :            :             // The buffer is currently empty, so we need to read at least one
     263                 :            :             // byte.
     264                 :    3354022 :             size_t r = io_pread(common->fd, buf, sizeof(buf), pos, 0);
     265         [ +  + ]:    3354022 :             if (r < sizeof(buf)) {
     266         [ -  + ]:     231372 :                 if (r == 0) {
     267                 :          0 :                     return EOF;
     268                 :            :                 }
     269                 :     231372 :                 memmove(buf + sizeof(buf) - r, buf, r);
     270                 :            :             }
     271                 :    3354022 :             pos += r;
     272                 :    3354022 :             buf_end = r;
     273                 :            :         }
     274                 :  106441956 :         return static_cast<unsigned char>(buf[sizeof(buf) - buf_end--]);
     275                 :            :     }
     276                 :            : 
     277                 :     201218 :     uint4 read_uint4_be() const {
     278                 :     201218 :         uint4 res = read() << 24;
     279                 :     201218 :         res |= read() << 16;
     280                 :     201218 :         res |= read() << 8;
     281                 :     201218 :         res |= read();
     282                 :     201218 :         return res;
     283                 :            :     }
     284                 :            : 
     285                 :   32891825 :     void read(char* p, size_t len) const {
     286         [ +  + ]:   32891825 :         if (buf_end != 0) {
     287         [ +  + ]:   32891822 :             if (len <= buf_end) {
     288                 :   32878493 :                 memcpy(p, buf + sizeof(buf) - buf_end, len);
     289                 :   32878493 :                 buf_end -= len;
     290                 :   32878493 :                 return;
     291                 :            :             }
     292                 :      13329 :             memcpy(p, buf + sizeof(buf) - buf_end, buf_end);
     293                 :      13329 :             p += buf_end;
     294                 :      13329 :             len -= buf_end;
     295                 :      13329 :             buf_end = 0;
     296                 :            :         }
     297                 :            :         // FIXME: refill buffer if len < sizeof(buf)
     298                 :      13332 :         size_t r = io_pread(common->fd, p, len, pos + common->offset, len);
     299                 :            :         // io_pread() should throw an exception if it read < len bytes.
     300                 :            :         AssertEq(r, len);
     301                 :      13332 :         pos += r;
     302                 :            :     }
     303                 :            : 
     304                 :       1188 :     void flush() {
     305 [ +  - ][ +  + ]:       1188 :         if (!read_only && buf_end) {
     306                 :       1171 :             io_write(common->fd, buf, buf_end);
     307                 :       1171 :             pos += buf_end;
     308                 :       1171 :             buf_end = 0;
     309                 :            :         }
     310                 :       1188 :     }
     311                 :            : 
     312                 :       2360 :     void sync() {
     313                 :       2360 :         io_sync(common->fd);
     314                 :       2360 :     }
     315                 :            : 
     316                 :     403662 :     void rewind(off_t start) {
     317                 :     403662 :         read_only = true;
     318                 :     403662 :         pos = start;
     319                 :     403662 :         buf_end = 0;
     320                 :     403662 :     }
     321                 :            : };
     322                 :            : 
     323                 :            : class HoneyCursor;
     324                 :            : 
     325                 :            : class SSTIndex {
     326                 :            :     std::string data;
     327                 :            : #if defined SSTINDEX_BINARY_CHOP
     328                 :            :     size_t block = size_t(-1);
     329                 :            : #elif defined SSTINDEX_SKIPLIST
     330                 :            :     size_t block = 0;
     331                 :            : #endif
     332                 :            : #if defined SSTINDEX_BINARY_CHOP || defined SSTINDEX_SKIPLIST
     333                 :            :     std::string last_index_key;
     334                 :            : #endif
     335                 :            :     // Put an index entry every this much:
     336                 :            :     // FIXME: tune - seems 64K is common elsewhere
     337                 :            :     enum { INDEXBLOCK = 4096 };
     338                 :            :     SSTIndex* parent_index = NULL;
     339                 :            : 
     340                 :            : #ifdef SSTINDEX_ARRAY
     341                 :            :     unsigned char first, last = static_cast<unsigned char>(-1);
     342                 :            :     off_t* pointers = NULL;
     343                 :            : #endif
     344                 :            : 
     345                 :            :   public:
     346                 :       6020 :     SSTIndex() {
     347                 :            : #ifdef SSTINDEX_ARRAY
     348                 :            :         // Header added in write() method.
     349                 :            : #elif defined SSTINDEX_BINARY_CHOP
     350                 :            :         data.assign(5, '\x01');
     351                 :            : #elif defined SSTINDEX_SKIPLIST
     352                 :            :         data.assign(1, '\x02');
     353                 :            : #else
     354                 :            : # error "SSTINDEX type not specified"
     355                 :            : #endif
     356                 :       3010 :     }
     357                 :            : 
     358                 :       6020 :     ~SSTIndex() {
     359                 :            : #ifdef SSTINDEX_ARRAY
     360         [ -  + ]:       3010 :         delete [] pointers;
     361                 :            : #endif
     362                 :       3010 :     }
     363                 :            : 
     364                 :      12530 :     void maybe_add_entry(const std::string& key, off_t ptr) {
     365                 :            : #ifdef SSTINDEX_ARRAY
     366                 :      12530 :         unsigned char initial = key[0];
     367         [ +  + ]:      12530 :         if (!pointers) {
     368         [ +  + ]:     300176 :             pointers = new off_t[256]();
     369                 :       1168 :             first = initial;
     370                 :            :         }
     371                 :            :         // We should only be called for valid index points.
     372                 :            :         AssertRel(int(initial), !=, last);
     373                 :            : 
     374         [ +  + ]:      71622 :         while (++last != int(initial)) {
     375                 :      59092 :             pointers[last] = ptr;
     376                 :            :             // FIXME: Perhaps record this differently so that an exact key
     377                 :            :             // search can return false?
     378                 :            :         }
     379                 :      12530 :         pointers[initial] = ptr;
     380                 :      12530 :         last = initial;
     381                 :            : #elif defined SSTINDEX_BINARY_CHOP
     382                 :            :         // We store entries truncated to a maximum width (and trailing zeros
     383                 :            :         // are used to indicate keys shorter than that max width).  These then
     384                 :            :         // point to the first key that maps to this truncated value.
     385                 :            :         //
     386                 :            :         // We need constant width entries to allow binary chop to work, but
     387                 :            :         // there are other ways to achieve this which could be explored.  We
     388                 :            :         // could allow the full key width of 256 bytes, but that would take a
     389                 :            :         // lot more space.  We could store a pointer (offset) to the key data,
     390                 :            :         // but that's more complex to read, and adds the pointer overhead.  We
     391                 :            :         // could use a "SKO" - a fixed width entry which encodes variable
     392                 :            :         // length pointer and key with short keys in the entry and long keys
     393                 :            :         // pointed to (or prefix included and rest pointed to).
     394                 :            :         if (last_index_key.size() == SSTINDEX_BINARY_CHOP_KEY_SIZE) {
     395                 :            :             if (startswith(key, last_index_key)) {
     396                 :            :                 return;
     397                 :            :             }
     398                 :            :         }
     399                 :            : 
     400                 :            :         // Ensure the truncated key doesn't end in a zero byte.
     401                 :            :         if (key.size() >= SSTINDEX_BINARY_CHOP_KEY_SIZE) {
     402                 :            :             // FIXME: Start from char N if we have N array index levels above.
     403                 :            :             last_index_key.assign(key, 0, SSTINDEX_BINARY_CHOP_KEY_SIZE);
     404                 :            :             if (key[SSTINDEX_BINARY_CHOP_KEY_SIZE - 1] == '\0')
     405                 :            :                 return;
     406                 :            :         } else {
     407                 :            :             last_index_key = key;
     408                 :            :             if (key.back() == '\0')
     409                 :            :                 return;
     410                 :            :             // Pad with zero bytes.
     411                 :            :             last_index_key.resize(SSTINDEX_BINARY_CHOP_KEY_SIZE);
     412                 :            :         }
     413                 :            : 
     414                 :            :         // Thin entries to at most one per INDEXBLOCK sized block.
     415                 :            :         size_t cur_block = ptr / INDEXBLOCK;
     416                 :            :         if (cur_block == block)
     417                 :            :             return;
     418                 :            : 
     419                 :            : #if 0
     420                 :            :         {
     421                 :            :             std::string esc;
     422                 :            :             description_append(esc, last_index_key);
     423                 :            :             std::cout << "Adding «" << esc << "» -> file offset " << ptr << std::endl;
     424                 :            :         }
     425                 :            : #endif
     426                 :            :         data += last_index_key;
     427                 :            :         size_t c = data.size();
     428                 :            :         data.resize(c + 4);
     429                 :            :         unaligned_write4(reinterpret_cast<unsigned char*>(&data[c]), ptr);
     430                 :            : 
     431                 :            :         block = cur_block;
     432                 :            : #elif defined SSTINDEX_SKIPLIST
     433                 :            :         size_t cur_block = ptr / INDEXBLOCK;
     434                 :            :         if (cur_block == block) return;
     435                 :            : 
     436                 :            :         size_t reuse = common_prefix_length(last_index_key, key);
     437                 :            : 
     438                 :            :         data += char(reuse);
     439                 :            :         data += char(key.size() - reuse);
     440                 :            :         data.append(key, reuse, key.size() - reuse);
     441                 :            :         pack_uint(data, static_cast<std::make_unsigned<off_t>::type>(ptr));
     442                 :            : 
     443                 :            :         block = cur_block;
     444                 :            :         // FIXME: deal with parent_index...
     445                 :            : 
     446                 :            :         last_index_key = key;
     447                 :            : #else
     448                 :            : # error "SSTINDEX type not specified"
     449                 :            : #endif
     450                 :      12530 :     }
     451                 :            : 
     452                 :       1180 :     off_t write(BufferedFile& store) {
     453                 :       1180 :         off_t root = store.get_pos();
     454                 :            : 
     455                 :            : #ifdef SSTINDEX_ARRAY
     456         [ +  + ]:       1180 :         if (!pointers) {
     457                 :         12 :             first = last = 0;
     458         [ +  + ]:         24 :             pointers = new off_t[1]();
     459                 :            :         }
     460                 :       1180 :         data.resize(0);
     461                 :       1180 :         data.resize(3 + (last - first + 1) * 4);
     462                 :       1180 :         data[0] = 0;
     463                 :       1180 :         data[1] = first;
     464                 :       1180 :         data[2] = last - first;
     465         [ +  + ]:      45340 :         for (unsigned ch = first; ch <= last; ++ch) {
     466                 :      44160 :             size_t o = 3 + (ch - first) * 4;
     467                 :            :             // FIXME: Just make offsets 8 bytes?  Or allow different widths?
     468                 :      44160 :             off_t ptr = pointers[ch];
     469         [ -  + ]:      44160 :             if (ptr > 0xffffffff)
     470 [ #  # ][ #  # ]:          0 :                 throw Xapian::DatabaseError("Index offset needs >4 bytes");
                 [ #  # ]
     471                 :            :             Assert(o + 4 <= data.size());
     472                 :      44160 :             unaligned_write4(reinterpret_cast<unsigned char*>(&data[o]), ptr);
     473                 :            :         }
     474         [ +  - ]:       1180 :         delete [] pointers;
     475                 :       1180 :         pointers = NULL;
     476                 :            : #elif defined SSTINDEX_BINARY_CHOP
     477                 :            :         if (last_index_key.size() == SSTINDEX_BINARY_CHOP_KEY_SIZE) {
     478                 :            :             // Increment final byte(s) to give a key which is definitely
     479                 :            :             // at or above any key which this could be truncated from.
     480                 :            :             size_t i = last_index_key.size();
     481                 :            :             unsigned char ch;
     482                 :            :             do {
     483                 :            :                 if (i == 0) {
     484                 :            :                     // We can't increment "\xff\xff\xff\xff" to give an upper
     485                 :            :                     // bound - just skip adding one in this case as the table
     486                 :            :                     // will handle it OK and there's not much to be gained by
     487                 :            :                     // adding one as few keys are larger.
     488                 :            :                     goto skip_adding_upper_bound;
     489                 :            :                 }
     490                 :            :                 --i;
     491                 :            :                 ch = static_cast<unsigned char>(last_index_key[i]) + 1;
     492                 :            :                 last_index_key[i] = ch;
     493                 :            :             } while (ch == 0);
     494                 :            :         } else {
     495                 :            :             // Pad with zeros, which gives an upper bound.
     496                 :            :             last_index_key.resize(SSTINDEX_BINARY_CHOP_KEY_SIZE);
     497                 :            :         }
     498                 :            : 
     499                 :            :         {
     500                 :            :             data += last_index_key;
     501                 :            :             size_t c = data.size();
     502                 :            :             data.resize(c + 4);
     503                 :            :             unaligned_write4(reinterpret_cast<unsigned char*>(&data[c]), root);
     504                 :            :         }
     505                 :            : 
     506                 :            : skip_adding_upper_bound:
     507                 :            :         // Fill in bytes 1 to 4 with the number of entries.
     508                 :            :         size_t n_index = (data.size() - 5) / SSTINDEX_BINARY_CHOP_ENTRY_SIZE;
     509                 :            :         data[1] = n_index >> 24;
     510                 :            :         data[2] = n_index >> 16;
     511                 :            :         data[3] = n_index >> 8;
     512                 :            :         data[4] = n_index;
     513                 :            : #elif defined SSTINDEX_SKIPLIST
     514                 :            :         // Already built in data.
     515                 :            : #else
     516                 :            : # error "SSTINDEX type not specified"
     517                 :            : #endif
     518                 :            : 
     519                 :       1180 :         store.write(data.data(), data.size());
     520                 :            :         // FIXME: parent stuff...
     521                 :       1180 :         return root;
     522                 :            :     }
     523                 :            : 
     524                 :            :     size_t size() const {
     525                 :            :         // FIXME: For SSTINDEX_ARRAY, data.size() only correct after calling
     526                 :            :         // write().
     527                 :            :         size_t s = data.size();
     528                 :            :         if (parent_index) s += parent_index->size();
     529                 :            :         return s;
     530                 :            :     }
     531                 :            : };
     532                 :            : 
     533                 :            : class HoneyCursor;
     534                 :            : class MutableHoneyCursor;
     535                 :            : 
     536                 :            : class HoneyTable {
     537                 :            :     // FIXME cleaner way?
     538                 :            :     friend class HoneyCursor; // Allow access to store.
     539                 :            :     friend class MutableHoneyCursor; // Allow access to store.
     540                 :            : 
     541                 :            :     std::string path;
     542                 :            :     bool read_only;
     543                 :            :     int flags;
     544                 :            :     uint4 compress_min;
     545                 :            :     mutable BufferedFile store;
     546                 :            :     mutable std::string last_key;
     547                 :            :     SSTIndex index;
     548                 :            :     off_t root = -1;
     549                 :            :     honey_tablesize_t num_entries = 0;
     550                 :            :     bool lazy;
     551                 :            : 
     552                 :       9732 :     bool single_file() const { return path.empty(); }
     553                 :            : 
     554                 :            :     /** Offset to add to pointers in this table.
     555                 :            :      *
     556                 :            :      *  This is zero when each table is a separate file, but likely non-zero
     557                 :            :      *  when the tables are all embedded in one file.
     558                 :            :      */
     559                 :            :     off_t offset = 0;
     560                 :            : 
     561                 :            :     bool get_exact_entry(const std::string& key, std::string* tag) const;
     562                 :            : 
     563                 :            :     bool read_key(std::string& key, size_t& val_size, bool& compressed) const;
     564                 :            : 
     565                 :            :     void read_val(std::string& val, size_t val_size) const;
     566                 :            : 
     567                 :            :   public:
     568                 :       2996 :     HoneyTable(const char*, const std::string& path_, bool read_only_,
     569                 :            :                bool lazy_ = false)
     570                 :            :         : path(path_ + HONEY_TABLE_EXTENSION),
     571                 :            :           read_only(read_only_),
     572 [ +  - ][ +  - ]:       2996 :           lazy(lazy_)
     573                 :            :     {
     574                 :       2996 :     }
     575                 :            : 
     576                 :         14 :     HoneyTable(const char*, int fd, off_t offset_, bool read_only_,
     577                 :            :                bool lazy_ = false)
     578                 :            :         : read_only(read_only_),
     579                 :            :           store(fd, 0, offset_, read_only_),
     580                 :            :           lazy(lazy_),
     581 [ +  - ][ +  - ]:         14 :           offset(offset_)
                 [ +  - ]
     582                 :            :     {
     583                 :         14 :     }
     584                 :            : 
     585                 :       6020 :     ~HoneyTable() {
     586                 :            : #if 0
     587                 :            :         size_t index_size = index.size();
     588                 :            :         if (index_size)
     589                 :            :             std::cout << "*** " << path << " - index " << index_size << " for "
     590                 :            :                       << index.get_num_entries() << " entries" << std::endl;
     591                 :            : #endif
     592                 :       3010 :         bool fd_owned = !single_file();
     593                 :       3010 :         store.close(fd_owned);
     594                 :       3010 :     }
     595                 :            : 
     596                 :            :     bool is_writable() const { return !read_only; }
     597                 :            : 
     598                 :            :     int get_flags() const { return flags; }
     599                 :            : 
     600                 :            :     void create_and_open(int flags_, const Honey::RootInfo& root_info);
     601                 :            : 
     602                 :            :     void open(int flags_, const Honey::RootInfo& root_info,
     603                 :            :               honey_revision_number_t);
     604                 :            : 
     605                 :         18 :     void close(bool permanent) {
     606                 :         18 :         bool fd_owned = !single_file();
     607         [ +  - ]:         18 :         if (permanent)
     608                 :         18 :             store.force_close(fd_owned);
     609                 :            :         else
     610                 :          0 :             store.close(fd_owned);
     611                 :         18 :     }
     612                 :            : 
     613                 :        180 :     const std::string& get_path() const { return path; }
     614                 :            : 
     615                 :            :     void add(const std::string& key,
     616                 :            :              const char* val,
     617                 :            :              size_t val_size,
     618                 :            :              bool compressed = false);
     619                 :            : 
     620                 :    1031697 :     void add(const std::string& key,
     621                 :            :              const std::string& val,
     622                 :            :              bool compressed = false) {
     623                 :    1031697 :         add(key, val.data(), val.size(), compressed);
     624                 :    1031697 :     }
     625                 :            : 
     626                 :       1180 :     void flush_db() {
     627                 :       1180 :         root = index.write(store);
     628                 :       1180 :         store.flush();
     629                 :       1180 :     }
     630                 :            : 
     631                 :            :     void cancel(const Honey::RootInfo&, honey_revision_number_t) {
     632                 :            :         std::abort();
     633                 :            :     }
     634                 :            : 
     635                 :            :     void commit(honey_revision_number_t, Honey::RootInfo* root_info);
     636                 :            : 
     637                 :       2360 :     bool sync() {
     638                 :       2360 :         store.sync();
     639                 :       2360 :         return true;
     640                 :            :     }
     641                 :            : 
     642                 :      26763 :     bool empty() const {
     643                 :      26763 :         return num_entries == 0;
     644                 :            :     }
     645                 :            : 
     646                 :     116075 :     bool get_exact_entry(const std::string& key, std::string& tag) const {
     647                 :     116075 :         return get_exact_entry(key, &tag);
     648                 :            :     }
     649                 :            : 
     650                 :        153 :     bool key_exists(const std::string& key) const {
     651                 :        153 :         return get_exact_entry(key, NULL);
     652                 :            :     }
     653                 :            : 
     654                 :          0 :     bool del(const std::string&) {
     655                 :          0 :         std::abort();
     656                 :            :     }
     657                 :            : 
     658                 :            :     // readahead probably not useful?  (FIXME)
     659                 :            :     bool readahead_key(const std::string&) const { return false; }
     660                 :            : 
     661                 :            :     bool is_modified() const { return !read_only && !empty(); }
     662                 :            : 
     663                 :            :     HoneyCursor* cursor_get() const;
     664                 :            : 
     665                 :            :     bool exists() const {
     666                 :            :         struct stat sbuf;
     667                 :            :         return stat(path.c_str(), &sbuf) == 0;
     668                 :            :     }
     669                 :            : 
     670                 :        580 :     bool is_open() const { return store.is_open(); }
     671                 :            : 
     672                 :         23 :     static void throw_database_closed() {
     673 [ +  - ][ +  - ]:         23 :         throw Xapian::DatabaseClosedError("Closed!");
                 [ +  - ]
     674                 :            :     }
     675                 :            : 
     676                 :          0 :     honey_tablesize_t get_entry_count() const { return num_entries; }
     677                 :            : 
     678                 :            :     /** Return an approximation of the number of entries in the table.
     679                 :            :      *
     680                 :            :      *  Currently this is exact, but may not be in the future.
     681                 :            :      */
     682                 :          0 :     honey_tablesize_t get_approx_entry_count() const { return num_entries; }
     683                 :            : 
     684                 :      61186 :     off_t get_root() const { return root; }
     685                 :            : 
     686                 :      61186 :     off_t get_offset() const { return offset; }
     687                 :            : };
     688                 :            : 
     689                 :            : #endif // XAPIAN_INCLUDED_HONEY_TABLE_H

Generated by: LCOV version 1.11