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

   1 /**************************************************************************
   2  *
   3  * Copyright 2007-2013 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, used to trace calls in the current process.
  28  */
  29
  30 #ifndef _TRACE_WRITER_LOCAL_HPP_
  31 #define _TRACE_WRITER_LOCAL_HPP_
  32
  33
  34 #include <stdint.h>
  35
  36 #include "os_thread.hpp"
  37 #include "os_process.hpp"
  38 #include "trace_writer.hpp"
  39
  40
  41 namespace trace {
  42
  43     extern const FunctionSig memcpy_sig;
  44     extern const FunctionSig malloc_sig;
  45     extern const FunctionSig free_sig;
  46     extern const FunctionSig realloc_sig;
  47
  48     /**
  49      * A specialized Writer class, mean to trace the current process.
  50      *
  51      * In particular:
  52      * - it creates a trace file based on the current process name
  53      * - uses mutexes to allow tracing from multiple threades
  54      * - flushes the output to ensure the last call is traced in event of
  55      *   abnormal termination
  56      */
  57     class LocalWriter : public Writer {
  58     protected:
  59         /**
  60          * This mutex guarantees that only one thread writes to the trace file
  61          * at one given instance.
  62          *
  63          * We need a recursive mutex so that we dont't dead lock in the event
  64          * of a segfault happens while the mutex is held.
  65          *
  66          * To prevent deadlocks, the call for the real function (the one being
  67          * traced) should not be done with the mutex held. That is, it should
  68          * be done outside the beginEnter/endEnter and beginLeave/endLeave
  69          * pairs. Preferably between these two pairs.
  70          */
  71         os::recursive_mutex mutex;
  72         int acquired;
  73
  74         /**
  75          * ID of the processed that opened the trace file.
  76          */
  77         os::ProcessId pid;
  78
  79         void checkProcessId();
  80
  81     public:
  82         /**
  83          * Should never called directly -- use localWriter singleton below
  84          * instead.
  85          */
  86         LocalWriter();
  87         ~LocalWriter();
  88
  89         void open(void);
  90
  91         /**
  92          * It will acquire the mutex.
  93          */
  94         unsigned beginEnter(const FunctionSig *sig, bool fake = false);
  95
  96         /**
  97          * It will release the mutex.
  98          */
  99         void endEnter(void);
 100
 101         /**
 102          * It will acquire the mutex.
 103          */
 104         void beginLeave(unsigned call);
 105
 106         /**
 107          * It will release the mutex.
 108          */
 109         void endLeave(void);
 110
 111         void flush(void);
 112     };
 113
 114     /**
 115      * Singleton.
 116      */
 117     extern LocalWriter localWriter;
 118
 119 } /* namespace trace */
 120
 121 #endif /* _TRACE_WRITER_LOCAL_HPP_ */