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
36namespace r600 {
37/* Implement some logging for shader-from-nir
38
39*/
40
41class stderr_streambuf : public std::streambuf
42{
43public:
44   stderr_streambuf();
45protected:
46   int sync();
47   int overflow(int c);
48   std::streamsize xsputn ( const char *s, std::streamsize n );
49};
50
51class SfnLog {
52public:
53   enum LogFlag {
54      instr = 1 << 0,
55      r600ir = 1 << 1,
56      cc     = 1 << 2,
57      err    = 1 << 3,
58      shader_info = 1 << 4,
59      test_shader = 1 << 5,
60      reg = 1 << 6,
61      io = 1 << 7,
62      assembly = 1 << 8,
63      flow = 1 << 9,
64      merge = 1 << 10,
65      tex = 1 << 11,
66      trans = 1 << 12,
67      schedule = 1 << 13,
68      opt = 1 << 14,
69      all = (1 << 15) - 1,
70      nomerge = 1 << 16,
71      steps = 1 << 17,
72      noopt = 1 << 18
73   };
74
75   SfnLog();
76
77   /** a special handling to set the output level "inline"
78       \param l the level of the following messages
79     */
80   SfnLog& operator << (LogFlag const l);
81
82   /* general output routine; output is only given, if the log flags and the
83    * currently active log mask overlap
84      \returns a reference to this object
85   */
86   template <class T>
87   SfnLog& operator << (const T&  text)
88   {
89      if (m_active_log_flags & m_log_mask)
90         m_output << text;
91
92      return *this;
93   }
94
95   /* A funny construct to enable std::endl to work on this stream
96      idea of Dave Brondsema:
97      http://gcc.gnu.org/bugzilla/show_bug.cgi?id=8567
98    */
99   SfnLog& operator << (std::ostream & (*f)(std::ostream&));
100
101   SfnLog& operator << (nir_shader &sh);
102
103   SfnLog& operator << (nir_instr& instr);
104
105   int has_debug_flag(uint64_t flag) {
106      return (m_log_mask & flag) == flag;
107   }
108
109private:
110   uint64_t m_active_log_flags;
111   uint64_t m_log_mask;
112   stderr_streambuf m_buf;
113   std::ostream m_output;
114};
115
116class SfnTrace {
117public:
118   SfnTrace(SfnLog::LogFlag flag, const char *msg);
119   ~SfnTrace();
120private:
121   SfnLog::LogFlag m_flag;
122   const char *m_msg;
123   static int m_indention;
124};
125
126
127#ifndef NDEBUG
128#define SFN_TRACE_FUNC(LEVEL, MSG) SfnTrace __trace(LEVEL, MSG)
129#else
130#define SFN_TRACE_FUNC(LEVEL, MSG)
131#endif
132
133extern SfnLog sfn_log;
134
135}
136#endif // SFN_STDERR_STREAMBUF_H
137