1 /* -*- mesa-c++  -*-
2  *
3  * Copyright (c) 2018-2019 Collabora LTD
4  *
5  * Author: Gert Wollny <gert.wollny@collabora.com>
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a
8  * copy of this software and associated documentation files (the "Software"),
9  * to deal in the Software without restriction, including without limitation
10  * on the rights to use, copy, modify, merge, publish, distribute, sub
11  * license, and/or sell copies of the Software, and to permit persons to whom
12  * the Software is furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice (including the next
15  * paragraph) shall be included in all copies or substantial portions of the
16  * Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21  * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
25  */
26 
27 #ifndef SFN_STDERR_STREAMLOG_H
28 #define SFN_STDERR_STREAMLOG_H
29 
30 
31 #include <streambuf>
32 #include <ostream>
33 #include <fstream>
34 #include "compiler/nir/nir.h"
35 
36 namespace r600 {
37 /* Implemnt some logging for shader-from-nir
38 
39 */
40 
41 class SfnLog {
42 public:
43    enum LogFlag {
44       instr = 1 << 0,
45       r600ir = 1 << 1,
46       cc     = 1 << 2,
47       err    = 1 << 3,
48       shader_info = 1 << 4,
49       test_shader = 1 << 5,
50       reg = 1 << 6,
51       io = 1 << 7,
52       assembly = 1 << 8,
53       flow = 1 << 9,
54       merge = 1 << 10,
55       tex = 1 << 11,
56       trans = 1 << 12,
57       all = (1 << 13) - 1,
58       nomerge = 1 << 16,
59    };
60 
61    SfnLog();
62 
63    /** a special handling to set the output level "inline"
64        \param l the level of the following messages
65      */
66    SfnLog& operator << (LogFlag const l);
67 
68    /* general output routine; output is only given, if the log flags and the
69     * currently active log mask overlap
70       \returns a reference to this object
71    */
72    template <class T>
73    SfnLog& operator << (const T&  text)
74    {
75       if (m_active_log_flags & m_log_mask)
76          m_output << text;
77 
78       return *this;
79    }
80 
81    /* A funny construct to enable std::endl to work on this stream
82       idea of Dave Brondsema:
83       http://gcc.gnu.org/bugzilla/show_bug.cgi?id=8567
84     */
85    SfnLog& operator << (std::ostream & (*f)(std::ostream&));
86 
87    SfnLog& operator << (nir_shader &sh);
88 
89    SfnLog& operator << (nir_instr& instr);
90 
has_debug_flag(uint64_t flag)91    int has_debug_flag(uint64_t flag) {
92       return (m_log_mask & flag) == flag;
93    }
94 
95 private:
96    uint64_t m_active_log_flags;
97    uint64_t m_log_mask;
98    std::ostream m_output;
99 };
100 
101 class SfnTrace {
102 public:
103    SfnTrace(SfnLog::LogFlag flag, const char *msg);
104    ~SfnTrace();
105 private:
106    SfnLog::LogFlag m_flag;
107    const char *m_msg;
108    static int m_indention;
109 };
110 
111 
112 #ifndef NDEBUG
113 #define SFN_TRACE_FUNC(LEVEL, MSG) SfnTrace __trace(LEVEL, MSG)
114 #else
115 #define SFN_TRACE_FUNC(LEVEL, MSG)
116 #endif
117 
118 extern SfnLog sfn_log;
119 
120 }
121 #endif // SFN_STDERR_STREAMBUF_H
122