]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
d76f09ea | 2 | * Copyright (c) 2009, 2010 Nicira Networks. |
064af421 | 3 | * |
a14bc59f BP |
4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at: | |
064af421 | 7 | * |
a14bc59f BP |
8 | * http://www.apache.org/licenses/LICENSE-2.0 |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
064af421 BP |
15 | */ |
16 | ||
17 | #ifndef COVERAGE_H | |
18 | #define COVERAGE_H 1 | |
19 | ||
20 | /* This file implements a simple form of coverage instrumentation. Points in | |
21 | * source code that are of interest must be explicitly annotated with | |
22 | * COVERAGE_INC. The coverage counters may be logged at any time with | |
23 | * coverage_log(). | |
24 | * | |
25 | * This form of coverage instrumentation is intended to be so lightweight that | |
26 | * it can be enabled in production builds. It is obviously not a substitute | |
27 | * for traditional coverage instrumentation with e.g. "gcov", but it is still | |
28 | * a useful debugging tool. */ | |
29 | ||
30 | #include "vlog.h" | |
31 | ||
32 | /* A coverage counter. */ | |
33 | struct coverage_counter { | |
34 | const char *name; /* Textual name. */ | |
35 | unsigned int count; /* Count within the current epoch. */ | |
36 | unsigned long long int total; /* Total count over all epochs. */ | |
37 | }; | |
38 | ||
d76f09ea BP |
39 | /* Defines COUNTER. There must be exactly one such definition at file scope |
40 | * within a program. */ | |
41 | #if USE_LINKER_SECTIONS | |
42 | #define COVERAGE_DEFINE(COUNTER) \ | |
43 | COVERAGE_DEFINE__(COUNTER); \ | |
44 | struct coverage_counter *counter_ptr_##COUNTER \ | |
45 | __attribute__((section("coverage"))) = &counter_##COUNTER | |
46 | #else | |
47 | #define COVERAGE_DEFINE(MODULE) \ | |
48 | extern struct coverage_counter counter_##MODULE | |
49 | #endif | |
50 | ||
51 | /* Adds 1 to COUNTER. */ | |
52 | #define COVERAGE_INC(COUNTER) counter_##COUNTER.count++; | |
53 | ||
54 | /* Adds AMOUNT to COUNTER. */ | |
55 | #define COVERAGE_ADD(COUNTER, AMOUNT) counter_##COUNTER.count += (AMOUNT); | |
064af421 | 56 | |
f5c6854a JP |
57 | void coverage_init(void); |
58 | void coverage_log(enum vlog_level, bool suppress_dups); | |
064af421 BP |
59 | void coverage_clear(void); |
60 | ||
d76f09ea BP |
61 | /* Implementation detail. */ |
62 | #define COVERAGE_DEFINE__(COUNTER) \ | |
63 | struct coverage_counter counter_##COUNTER = { #COUNTER, 0, 0 } | |
64 | ||
064af421 | 65 | #endif /* coverage.h */ |