/usr/include/libcw_debug.h is in libcw6-dev 3.5.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | /*
* Copyright (C) 2001-2006 Simon Baldwin (simon_baldwin@yahoo.com)
* Copyright (C) 2011-2017 Kamil Ignacak (acerion@wp.pl)
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef H_LIBCW_DEBUG
#define H_LIBCW_DEBUG
#include <stdio.h>
#include <assert.h>
#include <stdbool.h>
#if defined(__cplusplus)
extern "C"
{
#endif
#include <stdint.h> /* uint32_t */
#define CW_DEBUG_N_EVENTS_MAX (1024 * 128)
typedef struct {
uint32_t flags; /* Unused at the moment. */
int n; /* Event counter. */
int n_max; /* Flush threshold. */
/* Current debug level. */
int level;
/* Human-readable labels for debug levels. */
const char **level_labels;
struct {
uint32_t event; /* Event ID. One of values from enum below. */
long long sec; /* Time of registering the event - second. */
long long usec; /* Time of registering the event - microsecond. */
} events[CW_DEBUG_N_EVENTS_MAX];
} cw_debug_t;
void cw_debug_set_flags(cw_debug_t *debug_object, uint32_t flags);
uint32_t cw_debug_get_flags(cw_debug_t *debug_object);
void cw_debug_print_flags(cw_debug_t *debug_object);
bool cw_debug_has_flag(cw_debug_t *debug_object, uint32_t flag);
void cw_debug_event_internal(cw_debug_t *debug_object, uint32_t flag, uint32_t event, const char *func, int line);
void cw_set_debug_flags(uint32_t flags) __attribute__ ((deprecated));
uint32_t cw_get_debug_flags(void) __attribute__ ((deprecated));
#define cw_debug_msg(debug_object, flag, debug_level, ...) { \
if (debug_level >= (debug_object)->level) { \
if ((debug_object)->flags & flag) { \
fprintf(stderr, "%s:", (debug_object)->level_labels[debug_level]); \
if (debug_level == CW_DEBUG_DEBUG) { \
fprintf(stderr, "%s: %d: ", __func__, __LINE__); \
} \
fprintf(stderr, __VA_ARGS__); \
fprintf(stderr, "\n"); \
} \
} \
}
#define cw_debug_ev(debug_object, flag, event) \
{ \
cw_debug_event_internal(debug_object, flag, event, __func__, __LINE__); \
}
enum {
CW_DEBUG_EVENT_TONE_LOW = 0, /* Tone with non-zero frequency. */
CW_DEBUG_EVENT_TONE_MID, /* A state between LOW and HIGH, probably unused. */
CW_DEBUG_EVENT_TONE_HIGH, /* Tone with zero frequency. */
CW_DEBUG_EVENT_TQ_JUST_EMPTIED, /* A last tone from libcw's queue of tones has been dequeued, making the queue empty. */
CW_DEBUG_EVENT_TQ_NONEMPTY, /* A tone from libcw's queue of tones has been dequeued, but the queue is still non-empty. */
CW_DEBUG_EVENT_TQ_STILL_EMPTY /* libcw's queue of tones has been asked for tone, but there were no tones on the queue. */
};
/**
\brief Print debug message - verbose version
This macro behaves much like fprintf(stderr, ...) function, caller
only have to provide format string with converesion specifiers and
list of arguments for this format string.
Each message is preceeded with name of function that called the
macro.
See "C: A Reference Manual", chapter 3.3.10 for more information on
variable argument lists in macros (it requires C99).
Macro copied from my cdw project.
*/
#ifndef NDEBUG
#define cw_vdm(...) fprintf(stderr, "%s():%d: ", __func__, __LINE__); fprintf(stderr, __VA_ARGS__);
#else
#define cw_vdm(...)
#endif
/**
\brief Assert macro with message
Macro copied from my cdw project.
*/
#ifndef NDEBUG
#define cw_assert(expr, ...) \
if (! (expr)) { \
fprintf(stderr, "\n\nassertion failed in:\n"); \
fprintf(stderr, "file %s\n", __FILE__); \
fprintf(stderr, "line %d\n", __LINE__); \
cw_vdm (__VA_ARGS__); \
fprintf(stderr, "\n\n"); \
assert (expr); \
}
#else
/* "if ()" expression prevents compiler warnings about unused
variables. */
#define cw_assert(expr, ...) { if (expr) {} }
#endif
#ifdef LIBCW_WITH_DEV
int cw_dev_debug_raw_sink_write_internal(cw_gen_t *gen);
void cw_dev_debug_print_generator_setup(cw_gen_t *gen);
#endif
#ifdef LIBCW_UNIT_TESTS
unsigned int test_cw_debug_flags_internal(void);
#endif /* #ifdef LIBCW_UNIT_TESTS */
#if defined(__cplusplus)
}
#endif
#endif /* H_LIBCW_DEBUG */
|