1 /**************************************************************************
3 * Copyright 2007-2013 VMware, Inc.
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
24 **************************************************************************/
27 * Trace writing functions, used to trace calls in the current process.
30 #ifndef _TRACE_WRITER_LOCAL_HPP_
31 #define _TRACE_WRITER_LOCAL_HPP_
36 #include "os_thread.hpp"
37 #include "os_process.hpp"
38 #include "trace_writer.hpp"
43 extern const FunctionSig memcpy_sig;
44 extern const FunctionSig malloc_sig;
45 extern const FunctionSig free_sig;
46 extern const FunctionSig realloc_sig;
49 * A specialized Writer class, mean to trace the current process.
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
57 class LocalWriter : public Writer {
60 * This mutex guarantees that only one thread writes to the trace file
61 * at one given instance.
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.
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.
71 os::recursive_mutex mutex;
75 * ID of the processed that opened the trace file.
79 void checkProcessId();
83 * Should never called directly -- use localWriter singleton below
92 * It will acquire the mutex.
94 unsigned beginEnter(const FunctionSig *sig, bool fake = false);
97 * It will release the mutex.
102 * It will acquire the mutex.
104 void beginLeave(unsigned call);
107 * It will release the mutex.
117 extern LocalWriter localWriter;
119 } /* namespace trace */
121 #endif /* _TRACE_WRITER_LOCAL_HPP_ */