xapian-core/tests/harness/fdtracker.h

   1 /** @file fdtracker.h
   2  * @brief Track leaked file descriptors.
   3  */
   4 /* Copyright (C) 2010,2018 Olly Betts
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (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_FDTRACKER_H
  22 #define XAPIAN_INCLUDED_FDTRACKER_H
  23
  24 #include <set>
  25 #include <string>
  26
  27 // Disable fd tracking where it can't possibly work.
  28 #ifndef __WIN32__
  29 # define XAPIAN_TESTSUITE_TRACK_FDS
  30 #endif
  31
  32 class FDTracker {
  33 #ifdef XAPIAN_TESTSUITE_TRACK_FDS
  34     std::set<int> fds;
  35
  36     /** The DIR* from opendir("/proc/self/fd") (or equivalent) cast to void*.
  37      *
  38      *  We store this cast to void* here to minimise the header we have to
  39      *  include here.
  40      */
  41     void * dir_void;
  42
  43     std::string message;
  44
  45   public:
  46     FDTracker() : dir_void(NULL) { }
  47
  48     ~FDTracker();
  49
  50     void init();
  51
  52     bool check();
  53
  54     const std::string & get_message() const { return message; }
  55 #else
  56   public:
  57     FDTracker() { }
  58
  59     void init() { }
  60
  61     bool check() { return true; }
  62
  63     std::string get_message() const { return std::string(); }
  64 #endif
  65
  66     FDTracker(const FDTracker&) = delete;
  67
  68     FDTracker& operator=(const FDTracker&) = delete;
  69 };
  70
  71 #endif // XAPIAN_INCLUDED_FDTRACKER_H