]> git.cworth.org Git - apitrace/blob - common/trace_writer_local.hpp
qapitrace: Adjust PATH only once and for all.
[apitrace] / 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 <stdint.h>
35
36 #include "os_thread.hpp"
37 #include "trace_writer.hpp"
38
39
40 namespace trace {
41
42     extern const FunctionSig memcpy_sig;
43     extern const FunctionSig malloc_sig;
44     extern const FunctionSig free_sig;
45     extern const FunctionSig realloc_sig;
46
47     /**
48      * A specialized Writer class, mean to trace the current process.
49      *
50      * In particular:
51      * - it creates a trace file based on the current process name
52      * - uses mutexes to allow tracing from multiple threades
53      * - flushes the output to ensure the last call is traced in event of
54      *   abnormal termination
55      */
56     class LocalWriter : public Writer {
57     protected:
58         /**
59          * We need a recursive mutex so that it doesn't dead lock when a segfault happens when the mutex is held.
60          */
61         os::recursive_mutex mutex;
62         int acquired;
63
64     public:
65         /**
66          * Should never called directly -- use localWriter singleton below instead.
67          */
68         LocalWriter();
69         ~LocalWriter();
70
71         void open(void);
72
73         unsigned beginEnter(const FunctionSig *sig);
74         void endEnter(void);
75
76         void beginLeave(unsigned call);
77         void endLeave(void);
78
79         void flush(void);
80     };
81
82     /**
83      * Singleton.
84      */
85     extern LocalWriter localWriter;
86
87 } /* namespace trace */
88
89 #endif /* _TRACE_WRITER_LOCAL_HPP_ */