LCOV - code coverage report
Current view: top level - backends/glass - glass_cursor.h (source / functions) Hit Total Coverage
Test: Test Coverage for xapian-core 954b5873a738 Lines: 54 59 91.5 %
Date: 2019-06-30 05:20:33 Functions: 16 17 94.1 %
Branches: 20 26 76.9 %

           Branch data     Line data    Source code
       1                 :            : /** @file glass_cursor.h
       2                 :            :  * @brief Interface to Btree cursors
       3                 :            :  */
       4                 :            : /* Copyright 1999,2000,2001 BrightStation PLC
       5                 :            :  * Copyright 2002,2003,2004,2006,2007,2008,2009,2010,2012,2013,2014,2016 Olly Betts
       6                 :            :  *
       7                 :            :  * This program is free software; you can redistribute it and/or
       8                 :            :  * modify it under the terms of the GNU General Public License as
       9                 :            :  * published by the Free Software Foundation; either version 2 of the
      10                 :            :  * License, or (at your option) any later version.
      11                 :            :  *
      12                 :            :  * This program is distributed in the hope that it will be useful,
      13                 :            :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      14                 :            :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      15                 :            :  * GNU General Public License for more details.
      16                 :            :  *
      17                 :            :  * You should have received a copy of the GNU General Public License
      18                 :            :  * along with this program; if not, write to the Free Software
      19                 :            :  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
      20                 :            :  * USA
      21                 :            :  */
      22                 :            : 
      23                 :            : #ifndef XAPIAN_INCLUDED_GLASS_CURSOR_H
      24                 :            : #define XAPIAN_INCLUDED_GLASS_CURSOR_H
      25                 :            : 
      26                 :            : #include "glass_defs.h"
      27                 :            : 
      28                 :            : #include "alignment_cast.h"
      29                 :            : #include "omassert.h"
      30                 :            : 
      31                 :            : #include <algorithm>
      32                 :            : #include <cstring>
      33                 :            : #include <string>
      34                 :            : using std::string;
      35                 :            : 
      36                 :            : #define BLK_UNUSED uint4(-1)
      37                 :            : 
      38                 :            : namespace Glass {
      39                 :            : 
      40                 :            : class Cursor {
      41                 :            :     // Prevent copying
      42                 :            :     Cursor(const Cursor &);
      43                 :            :     Cursor & operator=(const Cursor &);
      44                 :            : 
      45                 :            :     /// Pointer to reference counted data.
      46                 :            :     char * data;
      47                 :            : 
      48                 :            :   public:
      49                 :            :     /// Constructor.
      50                 :    2038408 :     Cursor() : data(0), c(-1), rewrite(false) { }
      51                 :            : 
      52                 :    4076816 :     ~Cursor() { destroy(); }
      53                 :            : 
      54                 :    5593911 :     uint8_t * init(unsigned block_size) {
      55 [ +  + ][ +  + ]:    5593911 :         if (data && refs() > 1) {
                 [ +  + ]
      56                 :     477088 :             --refs();
      57                 :     477088 :             data = NULL;
      58                 :            :         }
      59         [ +  + ]:    5593911 :         if (!data)
      60                 :     533656 :             data = new char[block_size + 8];
      61                 :    5593911 :         refs() = 1;
      62                 :    5593911 :         set_n(BLK_UNUSED);
      63                 :    5593911 :         rewrite = false;
      64                 :    5593911 :         c = -1;
      65                 :    5593911 :         return reinterpret_cast<uint8_t*>(data + 8);
      66                 :            :     }
      67                 :            : 
      68                 :    1848086 :     const uint8_t * clone(const Cursor & o) {
      69         [ +  - ]:    1848086 :         if (data != o.data) {
      70                 :    1848086 :             destroy();
      71                 :    1848086 :             data = o.data;
      72                 :    1848086 :             ++refs();
      73                 :            :         }
      74                 :    1848086 :         return reinterpret_cast<uint8_t*>(data + 8);
      75                 :            :     }
      76                 :            : 
      77                 :          0 :     void swap(Cursor & o) {
      78                 :          0 :         std::swap(data, o.data);
      79                 :          0 :         std::swap(c, o.c);
      80                 :          0 :         std::swap(rewrite, o.rewrite);
      81                 :          0 :     }
      82                 :            : 
      83                 :    3943179 :     void destroy() {
      84         [ +  + ]:    3943179 :         if (data) {
      85         [ +  + ]:    1904654 :             if (--refs() == 0)
      86         [ +  - ]:     533751 :                 delete [] data;
      87                 :    1904654 :             data = NULL;
      88                 :    1904654 :             rewrite = false;
      89                 :            :         }
      90                 :    3943179 :     }
      91                 :            : 
      92                 :   19531922 :     uint4 & refs() const {
      93                 :            :         Assert(data);
      94                 :   19531922 :         return *alignment_cast<uint4*>(data);
      95                 :            :     }
      96                 :            : 
      97                 :            :     /** Get the block number.
      98                 :            :      *
      99                 :            :      *  Returns BLK_UNUSED if no block is currently loaded.
     100                 :            :      */
     101                 :   24969385 :     uint4 get_n() const {
     102                 :            :         Assert(data);
     103                 :   24969385 :         return *alignment_cast<uint4*>(data + 4);
     104                 :            :     }
     105                 :            : 
     106                 :   10875365 :     void set_n(uint4 n) {
     107                 :            :         Assert(data);
     108                 :            :         // Assert(refs() == 1);
     109                 :   10875365 :         *alignment_cast<uint4*>(data + 4) = n;
     110                 :   10875365 :     }
     111                 :            : 
     112                 :            :     /** Get pointer to block.
     113                 :            :      *
     114                 :            :      * Returns NULL if no block is currently loaded.
     115                 :            :      */
     116                 :   65444996 :     const uint8_t * get_p() const {
     117         [ -  + ]:   65444996 :         if (rare(!data)) return NULL;
     118                 :   65444996 :         return reinterpret_cast<uint8_t*>(data + 8);
     119                 :            :     }
     120                 :            : 
     121                 :    4170650 :     uint8_t * get_modifiable_p(unsigned block_size) {
     122         [ -  + ]:    4170650 :         if (rare(!data)) return NULL;
     123         [ +  + ]:    4170650 :         if (refs() > 1) {
     124                 :         95 :             char * new_data = new char[block_size + 8];
     125                 :         95 :             std::memcpy(new_data, data, block_size + 8);
     126                 :         95 :             --refs();
     127                 :         95 :             data = new_data;
     128                 :         95 :             refs() = 1;
     129                 :            :         }
     130                 :    4170650 :         return reinterpret_cast<uint8_t*>(data + 8);
     131                 :            :     }
     132                 :            : 
     133                 :            :     /// offset in the block's directory
     134                 :            :     int c;
     135                 :            : 
     136                 :            :     /// true if the block is not the same as on disk, and so needs rewriting
     137                 :            :     bool rewrite;
     138                 :            : };
     139                 :            : 
     140                 :            : }
     141                 :            : 
     142                 :            : class GlassTable;
     143                 :            : 
     144                 :            : /** A cursor pointing to a position in a Btree table, for reading several
     145                 :            :  *  entries in order, or finding approximate matches.
     146                 :            :  */
     147                 :            : class GlassCursor {
     148                 :            :     /// Copying not allowed
     149                 :            :     GlassCursor(const GlassCursor &);
     150                 :            : 
     151                 :            :     /// Assignment not allowed
     152                 :            :     GlassCursor & operator=(const GlassCursor &);
     153                 :            : 
     154                 :            :     /** Rebuild the cursor.
     155                 :            :      *
     156                 :            :      *  Called when the table has changed.
     157                 :            :      */
     158                 :            :     void rebuild();
     159                 :            : 
     160                 :            :   protected:
     161                 :            :     /** Whether the cursor is positioned at a valid entry.
     162                 :            :      *
     163                 :            :      *  false initially, and after the cursor has dropped
     164                 :            :      *  off either end of the list of items
     165                 :            :      */
     166                 :            :     bool is_positioned;
     167                 :            : 
     168                 :            :     /** Whether the cursor is off the end of the table.
     169                 :            :      */
     170                 :            :     bool is_after_end;
     171                 :            : 
     172                 :            :   private:
     173                 :            :     /** Status of the current_tag member. */
     174                 :            :     enum { UNREAD, UNREAD_ON_LAST_CHUNK, UNCOMPRESSED, COMPRESSED } tag_status;
     175                 :            : 
     176                 :            :   protected:
     177                 :            :     /// The Btree table
     178                 :            :     const GlassTable * B;
     179                 :            : 
     180                 :            :   private:
     181                 :            :     /// Pointer to an array of Cursors
     182                 :            :     Glass::Cursor * C;
     183                 :            : 
     184                 :            :     unsigned long version;
     185                 :            : 
     186                 :            :     /** The value of level in the Btree structure. */
     187                 :            :     int level;
     188                 :            : 
     189                 :            :     /** Get the key.
     190                 :            :      *
     191                 :            :      *  The key of the item at the cursor is copied into key.
     192                 :            :      *
     193                 :            :      *  The cursor must be positioned before calling this method.
     194                 :            :      *
     195                 :            :      *  e.g.
     196                 :            :      *
     197                 :            :      *    GlassCursor BC(&btree);
     198                 :            :      *    string key;
     199                 :            :      *
     200                 :            :      *    // Now do something to each key in the Btree
     201                 :            :      *    BC.rewind();
     202                 :            :      *    while (BC.next()) {
     203                 :            :      *        BC.get_key(&key);
     204                 :            :      *        do_something_to(key);
     205                 :            :      *    }
     206                 :            :      */
     207                 :            :     void get_key(string * key) const;
     208                 :            : 
     209                 :            :   public:
     210                 :            :     /** Create a cursor attached to a Btree.
     211                 :            :      *
     212                 :            :      *  Creates a cursor, which can be used to remember a position inside
     213                 :            :      *  the B-tree. The position is simply the item (key and tag) to which
     214                 :            :      *  the cursor points. A cursor is either positioned or unpositioned,
     215                 :            :      *  and is initially unpositioned.
     216                 :            :      *
     217                 :            :      *  NB: You must not try to use a GlassCursor after the Btree it is
     218                 :            :      *  attached to is destroyed.  It's safe to destroy the GlassCursor
     219                 :            :      *  after the Btree though, you just may not use the GlassCursor.
     220                 :            :      */
     221                 :            :     explicit GlassCursor(const GlassTable *B,
     222                 :            :                          const Glass::Cursor * C_ = NULL);
     223                 :            : 
     224                 :            :     /** Clone a cursor.
     225                 :            :      *
     226                 :            :      *  Creates a new cursor, primed with the blocks in the first cursor.
     227                 :            :      *  The new cursor is initially *unpositioned*.
     228                 :            :      */
     229                 :      99636 :     GlassCursor * clone() const {
     230         [ +  - ]:      99636 :         return new GlassCursor(B, C);
     231                 :            :     }
     232                 :            : 
     233                 :            :     /** Destroy the GlassCursor */
     234                 :            :     ~GlassCursor();
     235                 :            : 
     236                 :            :     /** Current key pointed to by cursor.
     237                 :            :      */
     238                 :            :     string current_key;
     239                 :            : 
     240                 :            :     /** Current tag pointed to by cursor.  You must call read_tag to
     241                 :            :      *  make this value available.
     242                 :            :      */
     243                 :            :     string current_tag;
     244                 :            : 
     245                 :            :     /** Position cursor on the dummy empty key.
     246                 :            :      *
     247                 :            :      *  Calling next() after this moves the cursor to the first entry.
     248                 :            :      */
     249                 :       1706 :     void rewind() {
     250         [ +  - ]:       1706 :         (void)find_entry_ge(string());
     251                 :       1706 :     }
     252                 :            : 
     253                 :            :     /** Read the tag from the table and store it in current_tag.
     254                 :            :      *
     255                 :            :      *  Some cursor users don't need the tag, so for efficiency we
     256                 :            :      *  only read it when asked to.
     257                 :            :      *
     258                 :            :      *  @param keep_compressed  Don't uncompress the tag - e.g. useful
     259                 :            :      *                      if it's just being opaquely copied
     260                 :            :      *                      (default: false).
     261                 :            :      *
     262                 :            :      *  @return true if current_tag holds compressed data (always
     263                 :            :      *          false if keep_compressed was false).
     264                 :            :      */
     265                 :            :     bool read_tag(bool keep_compressed = false);
     266                 :            : 
     267                 :            :     /** Advance to the next key.
     268                 :            :      *
     269                 :            :      *  If cursor is unpositioned, the result is simply false.
     270                 :            :      *
     271                 :            :      *  If cursor is positioned, and points to the very last item in the
     272                 :            :      *  Btree the cursor is made unpositioned, and the result is false.
     273                 :            :      *  Otherwise the cursor is moved to the next item in the B-tree,
     274                 :            :      *  and the result is true.
     275                 :            :      *
     276                 :            :      *  Effectively, GlassCursor::next() loses the position of BC when it
     277                 :            :      *  drops off the end of the list of items. If this is awkward, one can
     278                 :            :      *  always arrange for a key to be present which has a rightmost
     279                 :            :      *  position in a set of keys,
     280                 :            :      */
     281                 :            :     bool next();
     282                 :            : 
     283                 :            :     /** Position the cursor on the highest entry with key <= @a key.
     284                 :            :      *
     285                 :            :      *  If the exact key is found in the table, the cursor will be
     286                 :            :      *  set to point to it, and the method will return true.
     287                 :            :      *
     288                 :            :      *  If the key is not found, the cursor will be set to point to
     289                 :            :      *  the key preceding that asked for, and the method will return
     290                 :            :      *  false.  If there is no key preceding that asked for, the cursor
     291                 :            :      *  will point to a null key.
     292                 :            :      *
     293                 :            :      *  Note:  Since the B-tree always contains a null key, which precedes
     294                 :            :      *  everything, a call to GlassCursor::find_entry always results in a
     295                 :            :      *  valid key being pointed to by the cursor.
     296                 :            :      *
     297                 :            :      *  Note: Calling this method with a null key, then calling next()
     298                 :            :      *  will leave the cursor pointing to the first key.
     299                 :            :      *
     300                 :            :      *  @param key    The key to look for in the table.
     301                 :            :      *
     302                 :            :      *  @return true if the exact key was found in the table, false
     303                 :            :      *          otherwise.
     304                 :            :      */
     305                 :            :     bool find_entry(const string &key);
     306                 :            : 
     307                 :            :     /** Position the cursor exactly on a key.
     308                 :            :      *
     309                 :            :      *  If key is found, the cursor will be set to it, the tag read.  If
     310                 :            :      *  it is not found, the cursor is left unpositioned.
     311                 :            :      *
     312                 :            :      *  @param key      The key to search for.
     313                 :            :      *  @return true if the key was found.
     314                 :            :      */
     315                 :            :     bool find_exact(const string &key);
     316                 :            : 
     317                 :            :     /// Position the cursor on the highest entry with key < @a key.
     318                 :            :     void find_entry_lt(const string &key);
     319                 :            : 
     320                 :            :     /** Position the cursor on the lowest entry with key >= @a key.
     321                 :            :      *
     322                 :            :      *  @return true if the exact key was found in the table, false
     323                 :            :      *          otherwise.
     324                 :            :      */
     325                 :            :     bool find_entry_ge(const string &key);
     326                 :            : 
     327                 :            :     /** Set the cursor to be off the end of the table.
     328                 :            :      */
     329                 :      10221 :     void to_end() { is_after_end = true; }
     330                 :            : 
     331                 :            :     /** Determine whether cursor is off the end of table.
     332                 :            :      *
     333                 :            :      *  @return true if the cursor has been moved off the end of the
     334                 :            :      *          table, past the last entry in it, and false otherwise.
     335                 :            :      */
     336                 :     358692 :     bool after_end() const { return is_after_end; }
     337                 :            : 
     338                 :            :     /// Return a pointer to the GlassTable we're a cursor for.
     339                 :            :     const GlassTable * get_table() const { return B; }
     340                 :            : };
     341                 :            : 
     342                 :         20 : class MutableGlassCursor : public GlassCursor {
     343                 :            :   public:
     344                 :            :     /** Create a mutable cursor attached to a Btree.
     345                 :            :      *
     346                 :            :      *  A mutable cursor allows the items to be deleted.
     347                 :            :      *
     348                 :            :      *  Creates a cursor, which can be used to remember a position inside
     349                 :            :      *  the B-tree. The position is simply the item (key and tag) to which
     350                 :            :      *  the cursor points. A cursor is either positioned or unpositioned,
     351                 :            :      *  and is initially unpositioned.
     352                 :            :      *
     353                 :            :      *  NB: You must not try to use a MutableGlassCursor after the Btree it is
     354                 :            :      *  attached to is destroyed.  It's safe to destroy the MutableGlassCursor
     355                 :            :      *  after the Btree though, you just may not use the MutableGlassCursor.
     356                 :            :      */
     357                 :         20 :     explicit MutableGlassCursor(GlassTable *B_) : GlassCursor(B_) { }
     358                 :            : 
     359                 :            :     /** Delete the current key/tag pair, leaving the cursor on the next
     360                 :            :      *  entry.
     361                 :            :      *
     362                 :            :      *  @return false if the cursor ends up unpositioned.
     363                 :            :      */
     364                 :            :     bool del();
     365                 :            : };
     366                 :            : 
     367                 :            : #ifdef DISABLE_GPL_LIBXAPIAN
     368                 :            : # error GPL source we cannot relicense included in libxapian
     369                 :            : #endif
     370                 :            : 
     371                 :            : #endif /* XAPIAN_INCLUDED_GLASS_CURSOR_H */

Generated by: LCOV version 1.11