dyld3/Diagnostics.h

   1 /*
   2  * Copyright (c) 2017 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24
  25 #ifndef Diagnostics_h
  26 #define Diagnostics_h
  27
  28 #include <stdint.h>
  29
  30 #if BUILDING_CACHE_BUILDER
  31 #include <set>
  32 #include <string>
  33 #include <vector>
  34 #include <dispatch/dispatch.h>
  35 #endif
  36
  37 #include "Logging.h"
  38
  39
  40 class VIS_HIDDEN Diagnostics
  41 {
  42 public:
  43                     Diagnostics(bool verbose=false);
  44                     ~Diagnostics();
  45
  46     void            error(const char* format, ...)  __attribute__((format(printf, 2, 3)));
  47     void            error(const char* format, va_list list);
  48 #if BUILDING_CACHE_BUILDER
  49                     Diagnostics(const std::string& prefix, bool verbose=false);
  50
  51     void            warning(const char* format, ...)  __attribute__((format(printf, 2, 3)));
  52     void            verbose(const char* format, ...)  __attribute__((format(printf, 2, 3)));
  53     void            copy(const Diagnostics&);
  54 #endif
  55
  56     bool            hasError() const;
  57     bool            noError() const;
  58     void            clearError();
  59     void            assertNoError() const;
  60     bool            errorMessageContains(const char* subString) const;
  61
  62 #if !BUILDING_CACHE_BUILDER
  63     const char*                     errorMessage() const;
  64 #else
  65     const std::string               prefix() const;
  66     std::string                     errorMessage() const;
  67     const std::set<std::string>     warnings() const;
  68     void                            clearWarnings();
  69 #endif
  70
  71 private:
  72
  73     void*                    _buffer = nullptr;
  74 #if BUILDING_CACHE_BUILDER
  75     std::string              _prefix;
  76     std::set<std::string>    _warnings;
  77     bool                     _verbose = false;
  78 #endif
  79 };
  80
  81 #if BUILDING_CACHE_BUILDER
  82
  83 class VIS_HIDDEN TimeRecorder
  84 {
  85 public:
  86     // Call pushTimedSection(), then mark events with recordTime. Call popTimedSection() to stop the current timing session.
  87     // This is stack-based, so you can start a sub-timer with pushTimedSection() / recordTime / recordTime... / popTimedSection()
  88     // inside a first timed section.
  89     // Call logTimings() to print everything.
  90
  91     // Start a new timed section.
  92     void pushTimedSection();
  93
  94     // Records the time taken since the last pushTimedSection() / recordTime() at the current level
  95     void recordTime(const char* format, ...);
  96
  97     // Stop the current timed section and pop back one level.
  98     void popTimedSection();
  99
 100     void logTimings();
 101 private:
 102     struct TimingEntry {
 103         uint64_t time;
 104         std::string logMessage;
 105         int depth;
 106     };
 107
 108     std::vector<uint64_t> openTimings;
 109     std::vector<TimingEntry> timings;
 110 };
 111
 112 #endif /* BUILDING_CACHE_BUILDER */
 113
 114 #endif // Diagnostics_h