xapian-core/tests/perftest/perftest.h

   1 /** @file
   2  * @brief performance tests for Xapian.
   3  */
   4 /* Copyright 2008 Lemur Consulting Ltd
   5  * Copyright 2010 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_PERFTEST_H
  24 #define XAPIAN_INCLUDED_PERFTEST_H
  25
  26 #include <xapian.h>
  27
  28 #include <fstream>
  29 #include <map>
  30 #include <string>
  31
  32 class PerfTestLogger {
  33     std::ofstream out;
  34
  35     int repetition_number;
  36
  37     bool testcase_started;
  38
  39     bool indexing_started;
  40     Xapian::doccount indexing_addcount;
  41     bool indexing_unlogged_changes;
  42     double indexing_timer;
  43     double last_indexlog_timer;
  44
  45     bool searching_started;
  46     double searching_timer;
  47
  48     bool diversifying_started;
  49     double diversifying_timer;
  50
  51     /** Write a log entry for the current indexing run.
  52      */
  53     void indexing_log();
  54
  55     void write(const std::string & text);
  56
  57   public:
  58     PerfTestLogger();
  59     ~PerfTestLogger();
  60
  61     /** Open a file to log to.
  62      *
  63      *  Returns false if the file can't be opened.
  64      */
  65     bool open(const std::string & logpath);
  66
  67     /** Flush and close the log file.
  68      */
  69     void close();
  70
  71     /** Log the start of an indexing run.
  72      */
  73     void indexing_begin(const std::string & dbname,
  74                         const std::map<std::string, std::string> & params);
  75
  76     /** Log the addition of a document in an indexing run.
  77      */
  78     void indexing_add();
  79
  80     /** Log the end of an indexing run.
  81      */
  82     void indexing_end();
  83
  84     /** Log the start of a search run.
  85      */
  86     void searching_start(const std::string & description);
  87
  88     /** Log the start of a search.
  89      */
  90     void search_start();
  91
  92     /** Log the completion of a search.
  93      */
  94     void search_end(const Xapian::Query & query,
  95                     const Xapian::MSet & mset);
  96
  97     /** Log the end of a search run.
  98      */
  99     void searching_end();
 100
 101     /** Log the start of a diversification run.
 102      */
 103     void diversifying_start(const std::string & description);
 104
 105     /** Log the start of diversification.
 106      */
 107     void diversify_start();
 108
 109     /** Log the completion of diversification.
 110      */
 111     void diversify_end(Xapian::doccount k,
 112                        Xapian::doccount r,
 113                        const Xapian::DocumentSet & dset);
 114
 115     /** Log the end of a diversification run.
 116      */
 117     void diversifying_end();
 118
 119     /** Start a testcase.
 120      */
 121     void testcase_begin(const std::string & testcase);
 122
 123     /** End a testcase.
 124      */
 125     void testcase_end();
 126
 127     /** Start a repetition of the tests.
 128      */
 129     void repetition_begin(int num);
 130
 131     /** End a repetition of the tests.
 132      */
 133     void repetition_end();
 134 };
 135
 136 extern PerfTestLogger logger;
 137
 138 #endif // XAPIAN_INCLUDED_PERFTEST_H