git.cworth.org Git - apitrace/blob - common/trace_writer_local.hpp

   1 /**************************************************************************
   2  *
   3  * Copyright 2007-2010 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  *
  24  **************************************************************************/
  25
  26 /*
  27  * Trace writing functions.
  28  */
  29
  30 #ifndef _TRACE_WRITER_LOCAL_HPP_
  31 #define _TRACE_WRITER_LOCAL_HPP_
  32
  33
  34 #include "os_thread.hpp"
  35 #include "trace_writer.hpp"
  36
  37
  38 namespace trace {
  39
  40     extern const FunctionSig memcpy_sig;
  41     extern const FunctionSig malloc_sig;
  42     extern const FunctionSig free_sig;
  43     extern const FunctionSig realloc_sig;
  44
  45     /**
  46      * A specialized Writer class, mean to trace the current process.
  47      *
  48      * In particular:
  49      * - it creates a trace file based on the current process name
  50      * - uses mutexes to allow tracing from multiple threades
  51      * - flushes the output to ensure the last call is traced in event of
  52      *   abnormal termination
  53      */
  54     class LocalWriter : public Writer {
  55     protected:
  56         /**
  57          * We need a recursive mutex so that it doesn't dead lock when a segfault happens when the mutex is held.
  58          */
  59         os::recursive_mutex mutex;
  60         int acquired;
  61
  62     public:
  63         /**
  64          * Should never called directly -- use localWriter singleton below instead.
  65          */
  66         LocalWriter();
  67         ~LocalWriter();
  68
  69         void open(void);
  70
  71         unsigned beginEnter(const FunctionSig *sig);
  72         void endEnter(void);
  73
  74         void beginLeave(unsigned call);
  75         void endLeave(void);
  76
  77         void flush(void);
  78     };
  79
  80     /**
  81      * Singleton.
  82      */
  83     extern LocalWriter localWriter;
  84
  85 } /* namespace trace */
  86
  87 #endif /* _TRACE_WRITER_LOCAL_HPP_ */