summaryrefslogtreecommitdiff
path: root/digital/ucoolib/ucoolib/utils/trace.hh
blob: df8d59bb9db18c0b0d7a147eb6bb7878e42616dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
#ifndef ucoolib_utils_trace_hh
#define ucoolib_utils_trace_hh
// ucoolib - Microcontroller object oriented library. {{{
//
// Copyright (C) 2013 Nicolas Schodet
//
// APBTeam:
//        Web: http://apbteam.org/
//      Email: team AT apbteam DOT org
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// }}}

namespace ucoo {

/// Trace buffer to be read with debugger, no initialisation, should be
/// instantiated in BSS.
class TraceBuffer
{
    /// Maximum number of arguments.
    static const int args_nb = 4;
    /// Maximum number of trace entries.
    static const int entries_nb = 32;
  public:
    /// Trace without argument.
    inline void operator() (const char *str);
    /// Trace with N arguments...
    inline void operator() (const char *str, int a0);
    inline void operator() (const char *str, int a0, int a1);
    inline void operator() (const char *str, int a0, int a1, int a2);
    inline void operator() (const char *str, int a0, int a1, int a2, int a3);
  private:
    /// Trace entry, contains all given parameters.
    struct Entry
    {
        const char *str;
        int args[args_nb];
    };
    /// Trace entries array.
    Entry entries[entries_nb];
    /// Index of next entry to be written in entries array.
    unsigned int index;
};

/// Dummy trace, trace nothing.
class TraceDummy
{
  public:
    inline void operator() (const char *str) { }
    inline void operator() (const char *str, int a0) { }
    inline void operator() (const char *str, int a0, int a1) { }
    inline void operator() (const char *str, int a0, int a1, int a2) { }
    inline void operator() (const char *str, int a0, int a1, int a2, int a3) { }
};

/// Conditional trace, whether it trace or not depends on the template
/// argument.
template<bool ENABLED>
class Trace
{
};

template<>
class Trace<true> : public TraceBuffer
{
};

template<>
class Trace<false> : public TraceDummy
{
};

inline void
TraceBuffer::operator() (const char *str)
{
    entries[index].str = str;
    index = (index + 1) % entries_nb;
}

inline void
TraceBuffer::operator() (const char *str, int a0)
{
    entries[index].str = str;
    entries[index].args[0] = a0;
    index = (index + 1) % entries_nb;
}

inline void
TraceBuffer::operator() (const char *str, int a0, int a1)
{
    entries[index].str = str;
    entries[index].args[0] = a0;
    entries[index].args[1] = a1;
    index = (index + 1) % entries_nb;
}

inline void
TraceBuffer::operator() (const char *str, int a0, int a1, int a2)
{
    entries[index].str = str;
    entries[index].args[0] = a0;
    entries[index].args[1] = a1;
    entries[index].args[2] = a2;
    index = (index + 1) % entries_nb;
}

inline void
TraceBuffer::operator() (const char *str, int a0, int a1, int a2, int a3)
{
    entries[index].str = str;
    entries[index].args[0] = a0;
    entries[index].args[1] = a1;
    entries[index].args[2] = a2;
    entries[index].args[3] = a3;
    index = (index + 1) % entries_nb;
}

} // namespace ucoo

#endif // ucoolib_utils_trace_hh