LCOV - code coverage report
Current view: top level - backends/glass - glass_values.h (source / functions) Hit Total Coverage
Test: Test Coverage for xapian-core 954b5873a738 Lines: 42 44 95.5 %
Date: 2019-06-30 05:20:33 Functions: 16 16 100.0 %
Branches: 24 44 54.5 %

           Branch data     Line data    Source code
       1                 :            : /** @file glass_values.h
       2                 :            :  * @brief GlassValueManager class
       3                 :            :  */
       4                 :            : /* Copyright (C) 2008,2009,2011 Olly Betts
       5                 :            :  * Copyright (C) 2008 Lemur Consulting Ltd
       6                 :            :  *
       7                 :            :  * This program is free software; you can redistribute it and/or modify
       8                 :            :  * it under the terms of the GNU General Public License as published by
       9                 :            :  * the Free Software Foundation; either version 2 of the License, or
      10                 :            :  * (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 USA
      20                 :            :  */
      21                 :            : 
      22                 :            : #ifndef XAPIAN_INCLUDED_GLASS_VALUES_H
      23                 :            : #define XAPIAN_INCLUDED_GLASS_VALUES_H
      24                 :            : 
      25                 :            : #include "pack.h"
      26                 :            : #include "backends/valuestats.h"
      27                 :            : 
      28                 :            : #include "xapian/error.h"
      29                 :            : #include "xapian/types.h"
      30                 :            : 
      31                 :            : #include <map>
      32                 :            : #include <memory>
      33                 :            : #include <string>
      34                 :            : 
      35                 :            : class GlassCursor;
      36                 :            : 
      37                 :            : namespace Glass {
      38                 :            : 
      39                 :            : /** Generate a key for a value stream chunk. */
      40                 :            : inline std::string
      41                 :    2414141 : make_valuechunk_key(Xapian::valueno slot, Xapian::docid did)
      42                 :            : {
      43         [ +  - ]:    2414141 :     std::string key("\0\xd8", 2);
      44         [ +  - ]:    2414141 :     pack_uint(key, slot);
      45         [ +  - ]:    2414141 :     pack_uint_preserving_sort(key, did);
      46                 :    2414141 :     return key;
      47                 :            : }
      48                 :            : 
      49                 :            : inline Xapian::docid
      50                 :     499113 : docid_from_key(Xapian::valueno required_slot, const std::string & key)
      51                 :            : {
      52                 :     499113 :     const char * p = key.data();
      53                 :     499113 :     const char * end = p + key.length();
      54                 :            :     // Fail if not a value chunk key.
      55 [ +  + ][ +  + ]:     499113 :     if (end - p < 2 || *p++ != '\0' || *p++ != '\xd8') return 0;
         [ +  + ][ +  + ]
      56                 :            :     Xapian::valueno slot;
      57         [ -  + ]:     489848 :     if (!unpack_uint(&p, end, &slot))
      58 [ #  # ][ #  # ]:          0 :         throw Xapian::DatabaseCorruptError("bad value key");
                 [ #  # ]
      59                 :            :     // Fail if for a different slot.
      60         [ +  + ]:     489848 :     if (slot != required_slot) return 0;
      61                 :            :     Xapian::docid did;
      62         [ -  + ]:      46291 :     if (!unpack_uint_preserving_sort(&p, end, &did))
      63 [ #  # ][ #  # ]:          0 :         throw Xapian::DatabaseCorruptError("bad value key");
                 [ #  # ]
      64                 :     499113 :     return did;
      65                 :            : }
      66                 :            : 
      67                 :            : }
      68                 :            : 
      69                 :            : namespace Xapian {
      70                 :            :     class Document;
      71                 :            : }
      72                 :            : 
      73                 :            : class GlassPostListTable;
      74                 :            : class GlassTermListTable;
      75                 :            : struct ValueStats;
      76                 :            : 
      77                 :       8256 : class GlassValueManager {
      78                 :            :     /** The value number for the most recently used value statistics.
      79                 :            :      *
      80                 :            :      *  Set to Xapian::BAD_VALUENO if no value statistics are currently
      81                 :            :      *  cached.
      82                 :            :      */
      83                 :            :     mutable Xapian::valueno mru_slot;
      84                 :            : 
      85                 :            :     /** The most recently used value statistics. */
      86                 :            :     mutable ValueStats mru_valstats;
      87                 :            : 
      88                 :            :     GlassPostListTable * postlist_table;
      89                 :            : 
      90                 :            :     GlassTermListTable * termlist_table;
      91                 :            : 
      92                 :            :     std::map<Xapian::docid, std::string> slots;
      93                 :            : 
      94                 :            :     std::map<Xapian::valueno, std::map<Xapian::docid, std::string>> changes;
      95                 :            : 
      96                 :            :     mutable std::unique_ptr<GlassCursor> cursor;
      97                 :            : 
      98                 :            :     void add_value(Xapian::docid did, Xapian::valueno slot,
      99                 :            :                    const std::string & val);
     100                 :            : 
     101                 :            :     void remove_value(Xapian::docid did, Xapian::valueno slot);
     102                 :            : 
     103                 :            :     Xapian::docid get_chunk_containing_did(Xapian::valueno slot,
     104                 :            :                                            Xapian::docid did,
     105                 :            :                                            std::string &chunk) const;
     106                 :            : 
     107                 :            :     /** Get the statistics for value slot @a slot. */
     108                 :            :     void get_value_stats(Xapian::valueno slot) const;
     109                 :            : 
     110                 :            :     void get_value_stats(Xapian::valueno slot, ValueStats & stats) const;
     111                 :            : 
     112                 :            :   public:
     113                 :            :     /** Create a new GlassValueManager object. */
     114                 :       4128 :     GlassValueManager(GlassPostListTable * postlist_table_,
     115                 :            :                       GlassTermListTable * termlist_table_)
     116                 :            :         : mru_slot(Xapian::BAD_VALUENO),
     117                 :            :           postlist_table(postlist_table_),
     118 [ +  - ][ +  - ]:       4128 :           termlist_table(termlist_table_) { }
     119                 :            : 
     120                 :            :     // Merge in batched-up changes.
     121                 :            :     void merge_changes();
     122                 :            : 
     123                 :            :     void add_document(Xapian::docid did, const Xapian::Document &doc,
     124                 :            :                       std::map<Xapian::valueno, ValueStats> & value_stats);
     125                 :            : 
     126                 :            :     void delete_document(Xapian::docid did,
     127                 :            :                          std::map<Xapian::valueno, ValueStats> & value_stats);
     128                 :            : 
     129                 :            :     void replace_document(Xapian::docid did, const Xapian::Document &doc,
     130                 :            :                           std::map<Xapian::valueno, ValueStats> & value_stats);
     131                 :            : 
     132                 :            :     std::string get_value(Xapian::docid did, Xapian::valueno slot) const;
     133                 :            : 
     134                 :            :     void get_all_values(std::map<Xapian::valueno, std::string> & values,
     135                 :            :                         Xapian::docid did) const;
     136                 :            : 
     137                 :       1715 :     Xapian::doccount get_value_freq(Xapian::valueno slot) const {
     138         [ +  + ]:       1715 :         if (mru_slot != slot) get_value_stats(slot);
     139                 :       1715 :         return mru_valstats.freq;
     140                 :            :     }
     141                 :            : 
     142                 :       2475 :     std::string get_value_lower_bound(Xapian::valueno slot) const {
     143         [ +  + ]:       2475 :         if (mru_slot != slot) get_value_stats(slot);
     144                 :       2475 :         return mru_valstats.lower_bound;
     145                 :            :     }
     146                 :            : 
     147                 :       2555 :     std::string get_value_upper_bound(Xapian::valueno slot) const {
     148         [ +  + ]:       2555 :         if (mru_slot != slot) get_value_stats(slot);
     149                 :       2555 :         return mru_valstats.upper_bound;
     150                 :            :     }
     151                 :            : 
     152                 :            :     /** Write the updated statistics to the table.
     153                 :            :      *
     154                 :            :      *  If the @a freq member of the statistics for a particular slot is 0, the
     155                 :            :      *  statistics for that slot will be cleared.
     156                 :            :      *
     157                 :            :      *  @param value_stats The statistics to set.
     158                 :            :      */
     159                 :            :     void set_value_stats(std::map<Xapian::valueno, ValueStats> & value_stats);
     160                 :            : 
     161                 :       3161 :     void reset() {
     162                 :            :         /// Ignore any old cached valuestats.
     163                 :       3161 :         mru_slot = Xapian::BAD_VALUENO;
     164                 :       3161 :     }
     165                 :            : 
     166                 :       4179 :     bool is_modified() const {
     167                 :       4179 :         return !changes.empty();
     168                 :            :     }
     169                 :            : 
     170                 :        251 :     void cancel() {
     171                 :            :         // Discard batched-up changes.
     172                 :        251 :         slots.clear();
     173                 :        251 :         changes.clear();
     174                 :        251 :     }
     175                 :            : };
     176                 :            : 
     177                 :            : namespace Glass {
     178                 :            : 
     179                 :    4341440 : class ValueChunkReader {
     180                 :            :     const char *p;
     181                 :            :     const char *end;
     182                 :            : 
     183                 :            :     Xapian::docid did;
     184                 :            : 
     185                 :            :     std::string value;
     186                 :            : 
     187                 :            :   public:
     188                 :            :     /// Create a ValueChunkReader which is already at_end().
     189                 :     506140 :     ValueChunkReader() : p(NULL) { }
     190                 :            : 
     191                 :    3835300 :     ValueChunkReader(const char * p_, size_t len, Xapian::docid did_) {
     192         [ +  - ]:    1917650 :         assign(p_, len, did_);
     193                 :    1917650 :     }
     194                 :            : 
     195                 :            :     void assign(const char * p_, size_t len, Xapian::docid did_);
     196                 :            : 
     197                 :    9476156 :     bool at_end() const { return p == NULL; }
     198                 :            : 
     199                 :    5076574 :     Xapian::docid get_docid() const { return did; }
     200                 :            : 
     201                 :    5128284 :     const std::string & get_value() const { return value; }
     202                 :            : 
     203                 :            :     void next();
     204                 :            : 
     205                 :            :     void skip_to(Xapian::docid target);
     206                 :            : };
     207                 :            : 
     208                 :            : }
     209                 :            : 
     210                 :            : #endif // XAPIAN_INCLUDED_GLASS_VALUES_H

Generated by: LCOV version 1.11