xapian-core/tests/perftest/perftest.h

   1 /** @file perftest.h
   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     /** Write a log entry for the current indexing run.
  49      */
  50     void indexing_log();
  51
  52     void write(const std::string & text);
  53
  54   public:
  55     PerfTestLogger();
  56     ~PerfTestLogger();
  57
  58     /** Open a file to log to.
  59      *
  60      *  Returns false if the file can't be opened.
  61      */
  62     bool open(const std::string & logpath);
  63
  64     /** Flush and close the log file.
  65      */
  66     void close();
  67
  68     /** Log the start of an indexing run.
  69      */
  70     void indexing_begin(const std::string & dbname,
  71                         const std::map<std::string, std::string> & params);
  72
  73     /** Log the addition of a document in an indexing run.
  74      */
  75     void indexing_add();
  76
  77     /** Log the end of an indexing run.
  78      */
  79     void indexing_end();
  80
  81     /** Log the start of a search run.
  82      */
  83     void searching_start(const std::string & description);
  84
  85     /** Log the start of a search.
  86      */
  87     void search_start();
  88
  89     /** Log the completion of a search.
  90      */
  91     void search_end(const Xapian::Query & query,
  92                     const Xapian::MSet & mset);
  93
  94     /** Log the end of a search run.
  95      */
  96     void searching_end();
  97
  98     /** Start a testcase.
  99      */
 100     void testcase_begin(const std::string & testcase);
 101
 102     /** End a testcase.
 103      */
 104     void testcase_end();
 105
 106     /** Start a repetition of the tests.
 107      */
 108     void repetition_begin(int num);
 109
 110     /** End a repetition of the tests.
 111      */
 112     void repetition_end();
 113 };
 114
 115 extern PerfTestLogger logger;
 116
 117 #endif // XAPIAN_INCLUDED_PERFTEST_H