1 // Copyright 2020 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 // https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 //
15 // This is a simple test that ensures a provided trace backend compiles.
16
17 #define PW_TRACE_MODULE_NAME "TST"
18 #include "pw_trace/trace.h"
19 #include "pw_unit_test/framework.h"
20
21 namespace {
22
TraceFunction()23 void TraceFunction() { PW_TRACE_FUNCTION(); }
TraceFunctionGroup()24 void TraceFunctionGroup() { PW_TRACE_FUNCTION("FunctionGroup"); }
TraceFunctionGroupId()25 void TraceFunctionGroupId() {
26 const uint32_t trace_id = 1;
27 PW_TRACE_FUNCTION("FunctionGroup", trace_id);
28 }
TraceFunctionFlag()29 void TraceFunctionFlag() { PW_TRACE_FUNCTION_FLAG(PW_TRACE_FLAGS); }
TraceFunctionFlagGroup()30 void TraceFunctionFlagGroup() {
31 PW_TRACE_FUNCTION_FLAG(PW_TRACE_FLAGS, "FunctionGroup");
32 }
TraceFunctionFlagGroupId()33 void TraceFunctionFlagGroupId() {
34 const uint32_t trace_id = 1;
35 PW_TRACE_FUNCTION_FLAG(PW_TRACE_FLAGS, "FunctionGroup", trace_id);
36 }
37
38 const char kSomeData[] = "SOME DATA";
39
40 } // namespace
41
TEST(BasicTrace,Instant)42 TEST(BasicTrace, Instant) {
43 const uint32_t trace_id = 1;
44 PW_TRACE_INSTANT("Test");
45 PW_TRACE_INSTANT("Test", "Group");
46 PW_TRACE_INSTANT("Test", "Group", trace_id);
47 }
48
TEST(BasicTrace,InstantFlag)49 TEST(BasicTrace, InstantFlag) {
50 const uint32_t trace_id = 1;
51 PW_TRACE_INSTANT_FLAG(PW_TRACE_FLAGS, "Test");
52 PW_TRACE_INSTANT_FLAG(PW_TRACE_FLAGS, "Test", "Group");
53 PW_TRACE_INSTANT_FLAG(PW_TRACE_FLAGS, "Test", "Group", trace_id);
54 }
55
TEST(BasicTrace,InstantData)56 TEST(BasicTrace, InstantData) {
57 const uint32_t trace_id = 1;
58 PW_TRACE_INSTANT_DATA("Test", "s", kSomeData, sizeof(kSomeData));
59 PW_TRACE_INSTANT_DATA("Test", "Group", "s", kSomeData, sizeof(kSomeData));
60 PW_TRACE_INSTANT_DATA(
61 "Test", "Group", trace_id, "s", kSomeData, sizeof(kSomeData));
62 }
63
TEST(BasicTrace,InstantDataFlag)64 TEST(BasicTrace, InstantDataFlag) {
65 const uint32_t trace_id = 1;
66 PW_TRACE_INSTANT_DATA_FLAG(
67 PW_TRACE_FLAGS, "Test", "s", kSomeData, sizeof(kSomeData));
68 PW_TRACE_INSTANT_DATA_FLAG(
69 PW_TRACE_FLAGS, "Test", "Group", "s", kSomeData, sizeof(kSomeData));
70 PW_TRACE_INSTANT_DATA_FLAG(PW_TRACE_FLAGS,
71 "Test",
72 "Group",
73 trace_id,
74 "s",
75 kSomeData,
76 sizeof(kSomeData));
77 }
78
TEST(BasicTrace,Start)79 TEST(BasicTrace, Start) {
80 const uint32_t trace_id = 1;
81 PW_TRACE_START("Test");
82 PW_TRACE_START("Test", "Group");
83 PW_TRACE_START("Test", "Group", trace_id);
84 }
85
TEST(BasicTrace,StartFlag)86 TEST(BasicTrace, StartFlag) {
87 const uint32_t trace_id = 1;
88 PW_TRACE_START_FLAG(PW_TRACE_FLAGS, "Test");
89 PW_TRACE_START_FLAG(PW_TRACE_FLAGS, "Test", "Group");
90 PW_TRACE_START_FLAG(PW_TRACE_FLAGS, "Test", "Group", trace_id);
91 }
92
TEST(BasicTrace,StartData)93 TEST(BasicTrace, StartData) {
94 const uint32_t trace_id = 1;
95 PW_TRACE_START_DATA("Test", "s", kSomeData, sizeof(kSomeData));
96 PW_TRACE_START_DATA("Test", "Group", "s", kSomeData, sizeof(kSomeData));
97 PW_TRACE_START_DATA(
98 "Test", "Group", trace_id, "s", kSomeData, sizeof(kSomeData));
99 }
100
TEST(BasicTrace,StartDataFlag)101 TEST(BasicTrace, StartDataFlag) {
102 const uint32_t trace_id = 1;
103 PW_TRACE_START_DATA_FLAG(
104 PW_TRACE_FLAGS, "Test", "s", kSomeData, sizeof(kSomeData));
105 PW_TRACE_START_DATA_FLAG(
106 PW_TRACE_FLAGS, "Test", "Group", "s", kSomeData, sizeof(kSomeData));
107 PW_TRACE_START_DATA_FLAG(PW_TRACE_FLAGS,
108 "Test",
109 "Group",
110 trace_id,
111 "s",
112 kSomeData,
113 sizeof(kSomeData));
114 }
115
TEST(BasicTrace,End)116 TEST(BasicTrace, End) {
117 const uint32_t trace_id = 1;
118 PW_TRACE_END("Test");
119 PW_TRACE_END("Test", "Group");
120 PW_TRACE_END("Test", "Group", trace_id);
121 }
122
TEST(BasicTrace,EndFlag)123 TEST(BasicTrace, EndFlag) {
124 const uint32_t trace_id = 1;
125 PW_TRACE_END_FLAG(PW_TRACE_FLAGS, "Test");
126 PW_TRACE_END_FLAG(PW_TRACE_FLAGS, "Test", "Group");
127 PW_TRACE_END_FLAG(PW_TRACE_FLAGS, "Test", "Group", trace_id);
128 }
129
TEST(BasicTrace,EndData)130 TEST(BasicTrace, EndData) {
131 const uint32_t trace_id = 1;
132 PW_TRACE_END_DATA("Test", "s", kSomeData, sizeof(kSomeData));
133 PW_TRACE_END_DATA("Test", "Group", "s", kSomeData, sizeof(kSomeData));
134 PW_TRACE_END_DATA(
135 "Test", "Group", trace_id, "s", kSomeData, sizeof(kSomeData));
136 }
137
TEST(BasicTrace,EndDataFlag)138 TEST(BasicTrace, EndDataFlag) {
139 const uint32_t trace_id = 1;
140 PW_TRACE_END_DATA_FLAG(
141 PW_TRACE_FLAGS, "Test", "s", kSomeData, sizeof(kSomeData));
142 PW_TRACE_END_DATA_FLAG(
143 PW_TRACE_FLAGS, "Test", "Group", "s", kSomeData, sizeof(kSomeData));
144 PW_TRACE_END_DATA_FLAG(PW_TRACE_FLAGS,
145 "Test",
146 "Group",
147 trace_id,
148 "s",
149 kSomeData,
150 sizeof(kSomeData));
151 }
152
TEST(BasicTrace,Scope)153 TEST(BasicTrace, Scope) {
154 const uint32_t trace_id = 1;
155 PW_TRACE_SCOPE("scoped trace");
156 PW_TRACE_SCOPE("scoped trace", "Group");
157 PW_TRACE_SCOPE("scoped trace", "Group", trace_id);
158 {
159 PW_TRACE_SCOPE("sub scoped trace");
160 PW_TRACE_SCOPE("sub scoped trace", "Group");
161 PW_TRACE_SCOPE("sub scoped trace", "Group", trace_id);
162 }
163 }
164
TEST(BasicTrace,ScopeFlag)165 TEST(BasicTrace, ScopeFlag) {
166 const uint32_t trace_id = 1;
167 PW_TRACE_SCOPE_FLAG(PW_TRACE_FLAGS, "scoped trace");
168 PW_TRACE_SCOPE_FLAG(PW_TRACE_FLAGS, "scoped trace", "Group");
169 PW_TRACE_SCOPE_FLAG(PW_TRACE_FLAGS, "scoped trace", "Group", trace_id);
170 {
171 PW_TRACE_SCOPE_FLAG(PW_TRACE_FLAGS, "sub scoped trace");
172 PW_TRACE_SCOPE_FLAG(PW_TRACE_FLAGS, "sub scoped trace", "Group");
173 PW_TRACE_SCOPE_FLAG(PW_TRACE_FLAGS, "sub scoped trace", "Group", trace_id);
174 }
175 }
176
TEST(BasicTrace,Function)177 TEST(BasicTrace, Function) {
178 TraceFunction();
179 TraceFunctionGroup();
180 TraceFunctionGroupId();
181 }
182
TEST(BasicTrace,FunctionFlag)183 TEST(BasicTrace, FunctionFlag) {
184 TraceFunctionFlag();
185 TraceFunctionFlagGroup();
186 TraceFunctionFlagGroupId();
187 }
188