| blob | fcb586edb27f8f007a87654e6d767459a15023f9 |
1 /*
2 This file is part of the NoBug debugging library.
4 Copyright (C)
5 2007, 2008, 2009 Christian Thaeter <ct@pipapo.org>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, contact Christian Thaeter <ct@pipapo.org>.
19 */
20 #ifndef NOBUG_H
21 #define NOBUG_H
24 #ifdef NDEBUG
25 #ifdef EBUG_ALPHA
26 #error NDEBUG incompatible with -DEBUG_ALPHA
27 #endif
28 #ifdef EBUG_BETA
29 #error NDEBUG incompatible with -DEBUG_BETA
30 #endif
31 #endif
33 #if defined(EBUG_ALPHA)
34 # define NOBUG_MODE_ALPHA 1
35 # define NOBUG_MODE_BETA 0
36 # define NOBUG_MODE_RELEASE 0
37 #elif defined(EBUG_BETA)
38 # define NOBUG_MODE_ALPHA 0
39 # define NOBUG_MODE_BETA 1
40 # define NOBUG_MODE_RELEASE 0
41 #elif defined(NDEBUG)
42 # define NOBUG_MODE_ALPHA 0
43 # define NOBUG_MODE_BETA 0
44 # define NOBUG_MODE_RELEASE 1
45 #else
46 #error no debug level and no NDEBUG defined
47 #endif
50 /*
51 HEADERS
52 */
54 #include <syslog.h>
55 #include <stdlib.h>
56 #include <string.h>
57 #include <stdio.h>
58 #include <stdarg.h>
60 #ifdef HAVE_EXECINFO_H
61 # ifndef NOBUG_USE_EXECINFO
62 # define NOBUG_USE_EXECINFO 1
63 # endif
64 #else
65 # undef NOBUG_USE_EXECINFO
66 # define NOBUG_USE_EXECINFO 0
67 #endif
69 #if NOBUG_USE_EXECINFO
70 #include <execinfo.h>
71 #endif
73 #if defined(HAVE_VALGRIND) && !defined(NVALGRIND)
74 # ifndef NOBUG_USE_VALGRIND
75 # define NOBUG_USE_VALGRIND 1
76 # endif
77 #else
78 # undef NOBUG_USE_VALGRIND
79 # define NOBUG_USE_VALGRIND 0
80 #endif
82 #if NOBUG_USE_VALGRIND
83 #include <valgrind.h>
84 #endif
86 #ifdef HAVE_PTHREAD
87 # ifndef NOBUG_USE_PTHREAD
88 # define NOBUG_USE_PTHREAD 1
89 # endif
90 #else
91 # ifdef NOBUG_USE_PTHREAD
92 # undef NOBUG_USE_PTHREAD
93 # endif
94 # define NOBUG_USE_PTHREAD 0
95 #endif
97 #if NOBUG_USE_PTHREAD
98 #include <pthread.h>
99 #endif
101 /*
102 //assertions HEAD- Assertions;;
103 //assertions
104 //assertions PARA CHECK; CHECK; unnconditional assertion for testsuites
105 //assertions CHECK(expr, ...)
106 //assertions CHECK_IF(when, expr, ...)
107 //assertions
108 //assertions This assertion is never optimized out. Its main purpose is for implementing
109 //assertions testsuites where one want to assert tests independent of the build level
110 //assertions
111 */
112 #define NOBUG_CHECK(expr, ...) \
115 #define NOBUG_CHECK_IF(when, expr, ...) \
116 NOBUG_WHEN(when, NOBUG_CHECK(expr, ## __VA_ARGS__))
119 /*
120 //assertions PARA REQUIRE; REQUIRE; preconditions (input parameters)
121 //assertions REQUIRE(expr, ...)
122 //assertions REQUIRE_DBG(expr, ...)
123 //assertions REQUIRE_IF(when, expr, ...)
124 //assertions REQUIRE_IF_DBG(when, expr, ...)
125 //assertions
126 //assertions Precondition (input) check. Use these macros to validate input a
127 //assertions function receives. The checks are enabled in *ALPHA* and *BETA* builds and
128 //assertions optimized out in *RELEASE* builds.
129 //assertions
130 */
131 #define NOBUG_REQUIRE(expr, ...) \
133 NOBUG_LOCATION_INFO, ## __VA_ARGS__))
136 #define NOBUG_REQUIRE_DBG(expr, ...) \
138 NOBUG_LOCATION_INFO, ## __VA_ARGS__))
141 #define NOBUG_REQUIRE_IF(when, expr, ...) \
142 NOBUG_IF_NOT_RELEASE (NOBUG_WHEN(when, NOBUG_REQUIRE(expr, ## __VA_ARGS__)))
144 #define NOBUG_REQUIRE_IF_DBG(when, expr, ...) \
145 NOBUG_IF_NOT_RELEASE (NOBUG_WHEN(when, NOBUG_REQUIRE_DBG(expr, ## __VA_ARGS__)))
148 /*
149 //assertions PARA ENSURE; ENSURE; postconditions (computation outcomes)
150 //assertions ENSURE(expr, ...)
151 //assertions ENSURE_DBG(expr, ...)
152 //assertions ENSURE_IF(when, expr, ...)
153 //assertions ENSURE_IF_DBG(when, expr, ...)
154 //assertions
155 //assertions Postcondition (progress/output) check. Use these macros to validate the
156 //assertions data a function produces (example: return value). The checks enabled
157 //assertions unconditionally in *ALPHA* builds and optimized out in *BETA* builds for
158 //assertions scopes which are tagged as `CHECKED`. In *RELEASE* builds this checks are
159 //assertions always optimized out, but scopes tagged as `UNCHECKED` are not permitted.
160 //assertions
161 */
162 #define NOBUG_ENSURE(expr, ...) \
164 NOBUG_LOCATION_INFO, ## __VA_ARGS__)) \
165 NOBUG_IF_BETA ( \
166 NOBUG_WHEN (NOBUG_SCOPE_UNCHECKED, \
168 NOBUG_LOCATION_INFO, ## __VA_ARGS__))\
169 )
171 #define NOBUG_ENSURE_DBG(expr, ...) \
173 NOBUG_LOCATION_INFO, ## __VA_ARGS__)) \
174 NOBUG_IF_BETA ( \
175 NOBUG_WHEN (NOBUG_SCOPE_UNCHECKED, \
177 NOBUG_LOCATION_INFO, ## __VA_ARGS__)) \
178 )
181 #define NOBUG_ENSURE_IF(when, expr, ...) \
182 NOBUG_IF_NOT_RELEASE (NOBUG_WHEN(when, NOBUG_ENSURE(expr, ## __VA_ARGS__)))
184 #define NOBUG_ENSURE_IF_DBG(when, expr, ...) \
185 NOBUG_IF_NOT_RELEASE (NOBUG_WHEN(when, NOBUG_ENSURE_DBG(expr, ## __VA_ARGS__)))
188 /*
189 //assertions PARA ASSERT; ASSERT; generic assertion
190 //assertions ASSERT(expr, ...)
191 //assertions ASSERT_DBG(expr, ...)
192 //assertions ASSERT_IF(when, expr, ...)
193 //assertions ASSERT_IF_DBG(when, expr, ...)
194 //assertions
195 //assertions Generic check. Use these macros when you want to validate something
196 //assertions which doesn't fall into one of the above categories. A example is when
197 //assertions a library function can return a unexpected result (scanf with syntax
198 //assertions error in the formatstring, when a constant/literal formatstring is
199 //assertions expected). The checks are enabled in *ALPHA* and *BETA* builds and
200 //assertions optimized out in *RELEASE* builds.
201 //assertions
202 */
203 #define NOBUG_ASSERT(expr, ...) \
204 NOBUG_IF_NOT_RELEASE( \
206 NOBUG_LOCATION_INFO, ## __VA_ARGS__) \
207 )
209 #define NOBUG_ASSERT_DBG(expr, ...) \
210 NOBUG_IF_NOT_RELEASE( \
212 NOBUG_LOCATION_INFO, ## __VA_ARGS__) \
213 )
215 #define NOBUG_ASSERT_IF(when, expr, ...) \
216 NOBUG_IF_NOT_RELEASE (NOBUG_WHEN(when, NOBUG_ASSERT(expr, ## __VA_ARGS__)))
218 #define NOBUG_ASSERT_IF_DBG(when, expr, ...) \
219 NOBUG_IF_NOT_RELEASE (NOBUG_WHEN(when, NOBUG_ASSERT_DBG(expr, ## __VA_ARGS__)))
222 /*
223 //assertions PARA assert; assert; C standard assertion
224 //assertions assert(expr)
225 //assertions
226 //assertions NoBug overrides the standard assert macro in *ALPHA* and *BETA* builds.
227 //assertions This is just a compatibility feature, its use is not suggested.
228 //assertions
229 */
230 #if NOBUG_MODE_RELEASE==0
231 #undef assert
232 #define assert(expr) NOBUG_ASSERT(expr)
233 #endif
236 /*
237 low level assert
238 */
239 #define NOBUG_ASSERT_(expr, what, location, ...) \
240 NOBUG_WHEN (!(expr), \
241 NOBUG_LOG_( &nobug_flag_NOBUG_ON, LOG_EMERG, \
243 NOBUG_HEAD(__VA_ARGS__), \
244 #expr NOBUG_TAIL(__VA_ARGS__)); \
245 NOBUG_BACKTRACE; \
246 NOBUG_ABORT \
247 )
249 #define NOBUG_ASSERT_DBG_(expr, what, location, ...) \
250 NOBUG_WHEN (NOBUG_ACTIVE_DBG && !(expr), \
251 NOBUG_LOG_( &nobug_flag_NOBUG_ON, LOG_EMERG, \
253 NOBUG_HEAD(__VA_ARGS__), \
254 #expr NOBUG_TAIL(__VA_ARGS__)); \
255 NOBUG_BACKTRACE; \
256 NOBUG_ABORT \
257 )
260 /*
261 //assertions PARA INVARIANT; INVARIANT; validate invariant state
262 //assertions INVARIANT(type, pointer, depth)
263 //assertions INVARIANT_DBG(type, pointer, depth)
264 //assertions INVARIANT_IF(when,type, pointer, depth)
265 //assertions INVARIANT_IF_DBG(when, type, pointer, depth)
266 //assertions
267 //assertions Checking invariants. You can provide more complex checking functions
268 //assertions which test the validity of datastructures. Invariants are only enabled
269 //assertions in *ALPHA* builds for scopes which are not tagged as `CHECKED` and
270 //assertions otherwise optimized out.
271 //assertions
272 //assertions TODO: describe how to create invariant checks
273 //assertions
274 */
275 #define NOBUG_INVARIANT(type, pointer, depth) \
276 NOBUG_IF_ALPHA( \
277 NOBUG_WHEN (NOBUG_SCOPE_UNCHECKED, \
278 NOBUG_CAT(type,_invariant)(pointer, depth, \
279 NOBUG_LOCATION_ARGS) \
280 ) \
281 )
283 #define NOBUG_INVARIANT_DBG(type, pointer, ...) \
284 NOBUG_IF_ALPHA( \
285 NOBUG_WHEN (NOBUG_SCOPE_UNCHECKED && NOBUG_ACTIVE_DBG, \
286 NOBUG_CAT(type,_invariant)(pointer, depth, \
287 NOBUG_LOCATION_ARGS) \
288 ) \
289 )
291 #define NOBUG_INVARIANT_IF(when, type, pointer, ...) \
292 NOBUG_IF_ALPHA (NOBUG_WHEN (when, \
293 NOBUG_INVARIANT(type, pointer, ## __VA_ARGS__)) \
294 )
296 #define NOBUG_INVARIANT_IF_DBG(when, type, pointer, ...) \
297 NOBUG_IF_ALPHA (NOBUG_WHEN (when, \
298 NOBUG_INVARIANT_DBG(type, pointer, ## __VA_ARGS__))\
299 )
301 #define NOBUG_INVARIANT_ASSERT(expr, ...) \
305 /*
306 checked/unchecked tagged scopes
307 */
308 #define NOBUG_SCOPE_UNCHECKED NOBUG_CHECKED_VALUE == 0
310 #define NOBUG_CHECKED NOBUG_IF_NOT_RELEASE(enum {NOBUG_CHECKED_VALUE=1})
312 #define NOBUG_UNCHECKED \
313 NOBUG_IF_NOT_RELEASE(enum {NOBUG_CHECKED_VALUE=0}) \
314 NOBUG_IF_RELEASE(NOBUG_UNCHECKED_NOT_ALLOWED_IN_RELEASE_BUILD)
318 /*TODO dump-level for flags instead limits[0]*/
319 /*
320 //dumpmacros PARA DUMP; DUMP; dumping datastructures
321 //dumpmacros DUMP(flag, type, pointer, depth)
322 //dumpmacros DUMP_IF(when, flag, type, pointer, depth)
323 //dumpmacros
324 //dumpmacros This macros call a datastructure dump of the object (`pointer`) in question.
325 //dumpmacros `DUMP_IF` is the only enabled dumping macro for the RELEASE build level.
326 //dumpmacros
327 */
328 #define NOBUG_DUMP(flag, type, pointer, depth) \
329 NOBUG_IF_NOT_RELEASE( \
330 NOBUG_WHEN (NOBUG_DUMP_LEVEL >= NOBUG_FLAG(flag).limits[NOBUG_LOG_TARGET], \
331 NOBUG_CAT3 (nobug_, type, _dump)(pointer, depth, \
332 NOBUG_LOCATION_ARGS) \
333 ) \
334 )
336 #define NOBUG_DUMP_DBG(flag, type, pointer, depth) \
337 NOBUG_IF_NOT_RELEASE( \
338 NOBUG_WHEN (NOBUG_ACTIVE_DBG && NOBUG_DUMP_LEVEL >= NOBUG_FLAG(flag).limits[NOBUG_LOG_TARGET], \
339 NOBUG_CAT3 (nobug_, type, _dump)(pointer, depth, \
340 NOBUG_LOCATION_ARGS) \
341 ) \
342 )
344 #define NOBUG_DUMP_IF(when, flag, type, pointer, depth) \
345 NOBUG_WHEN (when && NOBUG_DUMP_LEVEL >= NOBUG_FLAG(flag).limits[NOBUG_LOG_TARGET], \
346 NOBUG_CAT3 (nobug_, type, _dump)(pointer, depth, \
347 NOBUG_LOCATION_ARGS) \
348 )
350 #define NOBUG_DUMP_IF_DBG(when, flag, type, pointer, depth) \
351 NOBUG_IF_NOT_RELEASE( \
352 NOBUG_WHEN (NOBUG_ACTIVE_DBG && when && NOBUG_DUMP_LEVEL >= NOBUG_FLAG(flag).limits[NOBUG_LOG_TARGET],\
353 NOBUG_CAT3 (nobug_, type, _dump)(pointer, depth, \
354 NOBUG_LOCATION_ARGS) \
355 ) \
356 )
359 /*
360 //dumpmacros PARA DUMP_LOG; DUMP_LOG; logging helper for dumping
361 //dumpmacros DUMP_LOG(fmt, ...)
362 //dumpmacros DUMP_LOG_DBG(fmt, ...)
363 //dumpmacros DUMP_LOG_IF(when, fmt, ...)
364 //dumpmacros DUMP_LOG_IF_DBG(when, fmt, ...)
365 //dumpmacros
366 //dumpmacros Any output from `DUMP` handlers should be done by these macros.
367 //dumpmacros
368 //dumpmacros Dumping is by default done on level `LOG_DEBUG`, this can be overridden by
369 //dumpmacros defining `NOBUG_DUMP_LEVEL` to some other level.
370 //dumpmacros
371 */
372 #define NOBUG_DUMP_LOG(fmt, ...) \
373 NOBUG_LOG_( &nobug_flag_NOBUG_ON, NOBUG_DUMP_LEVEL, \
375 fmt, ## __VA_ARGS__)
378 #define NOBUG_DUMP_LOG_DBG(fmt, ...) \
379 NOBUG_WHEN (NOBUG_ACTIVE_DBG, \
380 NOBUG_LOG_( &nobug_flag_NOBUG_ON, NOBUG_DUMP_LEVEL, \
382 fmt, ## __VA_ARGS__) \
383 )
385 #define NOBUG_DUMP_LOG_IF(expr, fmt, ...) \
386 NOBUG_WHEN (expr, \
387 NOBUG_LOG_( &nobug_flag_NOBUG_ON, NOBUG_DUMP_LEVEL, \
389 fmt, ## __VA_ARGS__) \
390 )
392 #define NOBUG_DUMP_LOG_IF_DBG(expr, fmt, ...) \
393 NOBUG_WHEN (NOBUG_ACTIVE_DBG && expr, \
394 NOBUG_LOG_( &nobug_flag_NOBUG_ON, NOBUG_DUMP_LEVEL, \
396 fmt, ## __VA_ARGS__) \
397 )
400 #ifndef NOBUG_DUMP_LEVEL
401 #define NOBUG_DUMP_LEVEL LOG_DEBUG
402 #endif
404 /*
405 //logmacros HEAD- Logging Macros;;
406 //logmacros
407 //logmacros PARA ECHO; ECHO; unconditional logging for tests
408 //logmacros ECHO(...)
409 //logmacros
410 //logmacros Never optimized out, logs at LOG_NOTICE level. Its main purpose is for implementing
411 //logmacros testsuites where one want to print and log messages independent of the build level
412 //logmacros
413 */
414 #define NOBUG_ECHO(...) \
417 /*
418 //logmacros PARA ALERT; ALERT; about to die
419 //logmacros ALERT(flag, ...)
420 //logmacros ALERT_DBG(flag, ...)
421 //logmacros ALERT_IF(when, flag, ...)
422 //logmacros ALERT_IF_DBG(when, flag, ...)
423 //logmacros
424 //logmacros This is the most critical condition an application might log. This might be used
425 //logmacros if an error occurs which can not be handled except a safe shutdown for example.
426 //logmacros
427 */
428 #define NOBUG_ALERT(flag, ...) \
429 NOBUG_LOG(flag, LOG_ALERT, ## __VA_ARGS__)
430 #define NOBUG_ALERT_IF(expr, flag, ...) \
431 NOBUG_LOG_IF(expr, flag, LOG_ALERT, ## __VA_ARGS__)
432 #define NOBUG_ALERT_DBG(flag, ...) \
433 NOBUG_LOG_DBG(flag, LOG_ALERT, ## __VA_ARGS__)
434 #define NOBUG_ALERT_IF_DBG(expr, flag, ...) \
435 NOBUG_LOG_IF_DBG(expr, flag, LOG_ALERT, ## __VA_ARGS__)
437 /*
438 //logmacros PARA CRITICAL; CRITICAL; can not continue
439 //logmacros CRITICAL(flag, ...)
440 //logmacros CRITICAL_DBG(flag, ...)
441 //logmacros CRITICAL_IF(when, flag, ...)
442 //logmacros CRITICAL_IF_DBG(when, flag, ...)
443 //logmacros
444 //logmacros An error which can not be handled occured but the application does not need to be
445 //logmacros shutdowen, perhaps waiting for an operator to fix the cause.
446 //logmacros
447 */
448 #define NOBUG_CRITICAL(flag, ...) \
449 NOBUG_LOG(flag, LOG_CRIT, ## __VA_ARGS__)
450 #define NOBUG_CRITICAL_IF(expr, flag, ...) \
451 NOBUG_LOG_IF(expr, flag, LOG_CRIT, ## __VA_ARGS__)
452 #define NOBUG_CRITICAL_DBG(flag, ...) \
453 NOBUG_LOG_DBG(flag, LOG_CRIT, ## __VA_ARGS__)
454 #define NOBUG_CRITICAL_IF_DBG(expr, flag, ...) \
455 NOBUG_LOG_IF_DBG(expr, flag, LOG_CRIT, ## __VA_ARGS__)
457 /*
458 //logmacros PARA ERROR; ERROR; something gone wrong
459 //logmacros ERROR(flag, fmt, ...)
460 //logmacros ERROR_DBG(flag, fmt, ...)
461 //logmacros ERROR_IF(when, flag, fmt, ...)
462 //logmacros ERROR_IF_DBG(when, flag, fmt, ...)
463 //logmacros
464 //logmacros Application takes a error handling brach
465 //logmacros
466 */
467 #define NOBUG_ERROR(flag, ...) \
468 NOBUG_LOG(flag, LOG_ERR, ## __VA_ARGS__)
469 #define NOBUG_ERROR_IF(expr, flag, ...) \
470 NOBUG_LOG_IF(expr, flag, LOG_ERR, ## __VA_ARGS__)
471 #define NOBUG_ERROR_DBG(flag, ...) \
472 NOBUG_LOG_DBG(flag, LOG_ERR, ## __VA_ARGS__)
473 #define NOBUG_ERROR_IF_DBG(expr, flag, ...) \
474 NOBUG_LOG_IF_DBG(expr, flag, LOG_ERR, ## __VA_ARGS__)
476 /*
477 //logmacros PARA WARN; WARN; unexpected fixable error
478 //logmacros WARN(flag, fmt, ...)
479 //logmacros WARN_DBG(flag, fmt, ...)
480 //logmacros WARN_IF(when, flag, fmt, ...)
481 //logmacros WARN_IF_DBG(when, flag, fmt, ...)
482 //logmacros
483 //logmacros Rare, handled but unexpected branch
484 //logmacros
485 */
486 #define NOBUG_WARN(flag, ...) \
487 NOBUG_LOG(flag, LOG_WARNING, ## __VA_ARGS__)
488 #define NOBUG_WARN_IF(expr, flag, ...) \
489 NOBUG_LOG_IF(expr, flag, LOG_WARNING, ## __VA_ARGS__)
490 #define NOBUG_WARN_DBG(flag, ...) \
491 NOBUG_LOG_DBG(flag, LOG_WARNING, ## __VA_ARGS__)
492 #define NOBUG_WARN_IF_DBG(expr, flag, ...) \
493 NOBUG_LOG_IF_DBG(expr, flag, LOG_WARNING, ## __VA_ARGS__)
495 /*
496 //logmacros PARA INFO; INFO; progress message
497 //logmacros INFO(flag, fmt, ...)
498 //logmacros INFO_DBG(flag, fmt, ...)
499 //logmacros INFO_IF(when, flag, fmt, ...)
500 //logmacros INFO_IF_DBG(when, flag, fmt, ...)
501 //logmacros
502 //logmacros Message about program progress
503 //logmacros
504 */
505 #define NOBUG_INFO(flag, ...) \
506 NOBUG_LOG(flag, LOG_INFO, ## __VA_ARGS__)
507 #define NOBUG_INFO_IF(expr, flag, ...) \
508 NOBUG_LOG_IF(expr, flag, LOG_INFO, ## __VA_ARGS__)
509 #define NOBUG_INFO_DBG(flag, ...) \
510 NOBUG_LOG_DBG(flag, LOG_INFO, ## __VA_ARGS__)
511 #define NOBUG_INFO_IF_DBG(expr, flag, ...) \
512 NOBUG_LOG_IF_DBG(expr, flag, LOG_INFO, ## __VA_ARGS__)
514 /*
515 //logmacros PARA NOTICE; NOTICE; detailed progress message
516 //logmacros NOTICE(flag, fmt, ...)
517 //logmacros NOTICE_DBG(flag, fmt, ...)
518 //logmacros NOTICE_IF(when, flag, fmt, ...)
519 //logmacros NOTICE_IF_DBG(when, flag, fmt, ...)
520 //logmacros
521 //logmacros More detailed progress message
522 //logmacros
523 */
524 #define NOBUG_NOTICE(flag, ...) \
525 NOBUG_LOG(flag, LOG_NOTICE, ## __VA_ARGS__)
526 #define NOBUG_NOTICE_IF(expr, flag, ...) \
527 NOBUG_LOG_IF(expr, flag, LOG_NOTICE, ## __VA_ARGS__)
528 #define NOBUG_NOTICE_DBG(flag, ...) \
529 NOBUG_LOG_DBG(flag, LOG_NOTICE, ## __VA_ARGS__)
530 #define NOBUG_NOTICE_IF_DBG(expr, flag, ...) \
531 NOBUG_LOG_IF_DBG(expr, flag, LOG_NOTICE, ## __VA_ARGS__)
533 /*
534 //logmacros PARA TRACE; TRACE; debugging level message
535 //logmacros TRACE(flag, fmt, ...)
536 //logmacros TRACE_DBG(flag, fmt, ...)
537 //logmacros TRACE_IF(when, flag, fmt, ...)
538 //logmacros TRACEIF_DBG(when, flag, fmt, ...)
539 //logmacros
540 //logmacros Very fine grained messages
541 //logmacros
542 //logmacros NOTE: that `TRACE` corresponds to `LOG_DEBUG`, because using `DEBUG` could be ambiguous.
543 //logmacros
544 */
545 #define NOBUG_TRACE(flag, ...) \
546 NOBUG_LOG(flag, LOG_DEBUG, ## __VA_ARGS__)
547 #define NOBUG_TRACE_IF(expr, flag, ...) \
548 NOBUG_LOG_IF(expr, flag, LOG_DEBUG, ## __VA_ARGS__)
549 #define NOBUG_TRACE_DBG(flag, ...) \
550 NOBUG_LOG_DBG(flag, LOG_DEBUG, ## __VA_ARGS__)
551 #define NOBUG_TRACE_IF_DBG(expr, flag, ...) \
552 NOBUG_LOG_IF_DBG(expr, flag, LOG_DEBUG, ## __VA_ARGS__)
555 /*
556 //logmacros PARA LOG; LOG; generic logging
557 //logmacros LOG(flag, lvl, fmt, ...)
558 //logmacros LOG_DBG(flag, lvl, fmt, ...)
559 //logmacros LOG_IF(when, flag, lvl, fmt, ...)
560 //logmacros LOG_IF_DBG(when, flag, lvl, fmt, ...)
561 //logmacros
562 //logmacros Generic logging macro which takes the level explicitly,
563 //logmacros avoid this, unless you implement your own logging facilities.
564 //logmacros
565 */
566 #define NOBUG_LOG(flag, lvl, ...) \
567 NOBUG_LOG_(&NOBUG_FLAG(flag), lvl, NOBUG_LOCATION_INFO, \
568 NOBUG_LVL(lvl), ## __VA_ARGS__)
570 #define NOBUG_LOG_DBG(flag, lvl, ...) \
571 NOBUG_WHEN (NOBUG_ACTIVE_DBG, \
572 NOBUG_LOG_(&NOBUG_FLAG(flag), lvl, NOBUG_LOCATION_INFO, \
573 NOBUG_LVL(lvl), ## __VA_ARGS__) \
574 )
576 #define NOBUG_LOG_IF(expr, flag, lvl, ...) \
577 NOBUG_WHEN (expr, \
578 NOBUG_LOG_(&NOBUG_FLAG(flag), lvl, NOBUG_LOCATION_INFO, \
579 NOBUG_LVL(lvl), ## __VA_ARGS__) \
580 )
582 #define NOBUG_LOG_IF_DBG(expr, flag, lvl, ...) \
583 NOBUG_WHEN (NOBUG_ACTIVE_DBG && expr, \
584 NOBUG_LOG_(&NOBUG_FLAG(flag), lvl, NOBUG_LOCATION_INFO, \
585 NOBUG_LVL(lvl), ## __VA_ARGS__) \
586 )
589 /*
590 low level logging handler
591 */
592 #define NOBUG_LOG_(flag, lvl, location, what, ...) \
593 NOBUG_WHEN (lvl <= NOBUG_LOG_BASELIMIT && lvl <= (flag)->limits[NOBUG_TARGET_RINGBUFFER], \
594 nobug_log (flag, lvl, \
596 NOBUG_HEAD(__VA_ARGS__), what, \
597 NOBUG_LOCATION_FILE location, \
598 NOBUG_LOCATION_LINE location NOBUG_THREAD_ID_COMMA, \
599 NOBUG_LOCATION_FUNC location NOBUG_TAIL(__VA_ARGS__)); \
600 )
603 #define NOBUG_LVL(lvl) NOBUG_LVL_##lvl
613 /*
614 //logmacros PARA LOG_BASELIMIT; LOG_BASELIMIT; minimum compliled-in logging limit
615 //logmacros NOBUG_LOG_BASELIMIT_ALPHA
616 //logmacros NOBUG_LOG_BASELIMIT_BETA
617 //logmacros NOBUG_LOG_BASELIMIT_RELEASE
618 //logmacros NOBUG_LOG_BASELIMIT
619 //logmacros
620 //logmacros anything more detailed than this base limits will be optimized out.
621 //logmacros This is used to reduce the logging overhead for *RELEASE* builds.
622 //logmacros By default the limit is set to `LOG_DEBUG` for *ALPHA* and *BETA*
623 //logmacros builds, so all logging is retained and `LOG_NOTICE` in *RELEASE*
624 //logmacros builds to log the application progress only coarsely then.
625 //logmacros
626 //logmacros This macros can be defined before including 'nobug.h' to some other
627 //logmacros log level (as defined in 'syslog.h').
628 //logmacros
629 //logmacros NOTE: there is no logging macro for `LOG_EMERG` since this is used by the assertions as fatal message
630 //logmacros
631 */
632 #ifndef NOBUG_LOG_BASELIMIT_ALPHA
633 #define NOBUG_LOG_BASELIMIT_ALPHA LOG_DEBUG
634 #endif
636 #ifndef NOBUG_LOG_BASELIMIT_BETA
637 #define NOBUG_LOG_BASELIMIT_BETA LOG_DEBUG
638 #endif
640 #ifndef NOBUG_LOG_BASELIMIT_RELEASE
641 #define NOBUG_LOG_BASELIMIT_RELEASE LOG_NOTICE
642 #endif
644 #ifndef NOBUG_LOG_BASELIMIT
645 #define NOBUG_LOG_BASELIMIT \
646 NOBUG_IF_ALPHA(NOBUG_LOG_BASELIMIT_ALPHA) \
647 NOBUG_IF_BETA(NOBUG_LOG_BASELIMIT_BETA) \
648 NOBUG_IF_RELEASE(NOBUG_LOG_BASELIMIT_RELEASE)
649 #endif
651 /*
652 //annotations HEAD- Source Annotations;;
653 //annotations
654 //annotations One can tag features as:
655 //annotations
656 */
658 /*
659 alpha beta release
660 DEPRECATED log nothing wont compile
662 //annotations PARA DEPRECATED; DEPRECATED; to be discarded in future
663 //annotations DEPRECATED(...)
664 //annotations
665 //annotations Something which shouldn't be used in future
666 //annotations
667 */
668 #define NOBUG_DEPRECATED(...) \
669 NOBUG_IF_ALPHA(NOBUG_LOG_(&nobug_flag_NOBUG_ANN, LOG_WARN, \
671 ) \
672 NOBUG_IF_RELEASE(NOBUG_DEPRECATED_NOT_ALLOWED_IN_RELEASE_BUILD(__VA_ARGS__))
675 /*
676 alpha beta release
677 UNIMPLEMENTED abort abort wont compile
679 //annotations PARA UNIMPLEMENTED; UNIMPLEMENTED; not yet implemented
680 //annotations UNIMPLEMENTED(...)
681 //annotations
682 //annotations not yet finished feature
683 //annotations
684 */
685 #define NOBUG_UNIMPLEMENTED(...) \
686 NOBUG_IF_NOT_RELEASE ( do { \
687 NOBUG_LOG_ (&nobug_flag_NOBUG_ANN, LOG_EMERG, NOBUG_LOCATION_INFO, \
689 NOBUG_ABORT; \
690 } while (0)) \
691 NOBUG_IF_RELEASE( NOBUG_UNIMPLEMENTED_NOT_ALLOWED_IN_RELEASE_BUILD(__VA_ARGS__))
694 /*
695 alpha beta release
696 FIXME log wont compile wont compile
698 //annotations PARA FIXME; FIXME; known bug
699 //annotations FIXME(...)
700 //annotations
701 //annotations known bug to be fixed later
702 //annotations
703 */
704 #define NOBUG_FIXME(...) \
705 NOBUG_IF_ALPHA( NOBUG_ONCE( NOBUG_LOG_(&nobug_flag_NOBUG_ANN, LOG_ALERT, \
707 NOBUG_IF_BETA( NOBUG_FIXME_NOT_ALLOWED_IN_BETA_BUILD(__VA_ARGS__)) \
708 NOBUG_IF_RELEASE( NOBUG_FIXME_NOT_ALLOWED_IN_RELEASE_BUILD(__VA_ARGS__))
711 /*
712 alpha beta release
713 TODO log log wont compile
715 //annotations PARA TODO; TODO; things to be done
716 //annotations TODO(...)
717 //annotations
718 //annotations enhancement to be done soon
719 //annotations
720 */
721 #define NOBUG_TODO(...) \
722 NOBUG_IF_NOT_RELEASE ( \
723 NOBUG_ONCE ( \
724 NOBUG_LOG_( &nobug_flag_NOBUG_ANN, LOG_NOTICE, NOBUG_LOCATION_INFO, \
726 )) \
727 NOBUG_IF_RELEASE(NOBUG_TODO_NOT_ALLOWED_IN_RELEASE_BUILD(__VA_ARGS__))
730 /*
731 alpha beta release
732 PLANNED log nothing nothing
734 //annotations PARA PLANNED; PLANNED; ideas for future
735 //annotations PLANNED(...)
736 //annotations
737 //annotations future enhancement
738 //annotations
739 */
740 #define NOBUG_PLANNED(...) \
741 NOBUG_IF_ALPHA( NOBUG_ONCE(NOBUG_LOG_ (&nobug_flag_NOBUG_ANN, LOG_INFO, \
745 /*
746 alpha beta release
747 NOTREACHED abort abort nothing
749 //annotations PARA NOTREACHED; NOTREACHED; code path never taken
750 //annotations NOTREACHED(...)
751 //annotations
752 //annotations used to tag code-path which shall be never executed.
753 //annotations
754 */
755 #define NOBUG_NOTREACHED(...) \
756 NOBUG_IF_NOT_RELEASE( do { \
757 NOBUG_LOG_( &nobug_flag_NOBUG_ANN, LOG_EMERG, \
759 NOBUG_ABORT; \
760 } while (0))
762 /*
763 //annotations PARA ELSE_NOTREACHED; ELSE_NOTREACHED; alternative never taken
764 //annotations ELSE_NOTREACHED(...)
765 //annotations
766 //annotations same as `else NOTREACHED()`, but wholly optimized out in release builds.
767 //annotations
768 */
769 #define NOBUG_ELSE_NOTREACHED(...) \
770 NOBUG_IF_NOT_RELEASE( else do { \
771 NOBUG_LOG_( &nobug_flag_NOBUG_ANN, LOG_EMERG, \
773 NOBUG_ABORT; \
774 } while (0))
778 /*
779 //faultinjection HEAD- Fault injection;;
780 //faultinjection
781 //faultinjection NoBug has some macros which can be used to simulate errorneous behaviour:
782 //faultinjection
783 //faultinjection PARA INJECT_GOODBAD; INJECT_GOODBAD; fault injection expression
784 //faultinjection INJECT_GOODBAD(expr, good, bad)
785 //faultinjection
786 //faultinjection substitutes to an expression and returns good when expr is false and
787 //faultinjection bad when expr is true. In BETA and RELEASE builds 'good' is always returned.
788 //faultinjection
789 */
790 #define NOBUG_INJECT_GOODBAD(expr, good, bad) \
792 NOBUG_IF_NOT_ALPHA(good)
795 /*
796 //faultinjection PARA INJECT_FAULT; INJECT_FAULT; fault injection statement
797 //faultinjection INJECT_FAULT(expr, bad)
798 //faultinjection
799 //faultinjection substitutes to a statement which executes 'bad'
800 //faultinjection when expr is true. Optimitzed out in BETA and RELEASE builds.
801 //faultinjection
802 */
803 #define NOBUG_INJECT_FAULT(expr, bad) \
807 /*
808 //faultinjection PARA INJECT_LEVEL; INJECT_LEVEL; log level for fault injection
809 //faultinjection In both cases, when a fault is injected it will be logged at
810 //faultinjection `NOBUG_INJECT_LEVEL` (default: `LOG_NOTICE`). This can be defined
811 //faultinjection before including 'nobug.h' to override it.
812 //faultinjection
813 */
814 #define NOBUG_INJECT_LOG(msg) \
815 NOBUG_LOG_( &nobug_flag_NOBUG_ON, NOBUG_INJECT_LEVEL, \
817 msg)
820 #ifndef NOBUG_INJECT_LEVEL
821 #define NOBUG_INJECT_LEVEL LOG_NOTICE
822 #endif
825 /*
826 Flag handling
827 */
828 #define NOBUG_FLAG(name) NOBUG_CAT(nobug_flag_, name)
830 #define NOBUG_DECLARE_FLAG(name) extern struct nobug_flag NOBUG_FLAG(name)
833 #define NOBUG_DEFINE_FLAG(name) \
834 NOBUG_FLAG_IF_DECLAREONLY(NOBUG_DECLARE_FLAG(name)) \
835 NOBUG_FLAG_IF_NOT_DECLAREONLY( \
836 struct nobug_flag NOBUG_FLAG(name) = \
837 NOBUG_IF(NOBUG_MODE_ALPHA, {#name, NULL, 0, \
838 {LOG_DEBUG, LOG_INFO, LOG_DEBUG, -1, LOG_INFO}, &nobug_default_ringbuffer, NULL,NULL}) \
839 NOBUG_IF(NOBUG_MODE_BETA, {#name, NULL, 0, \
840 {LOG_INFO, LOG_NOTICE, LOG_NOTICE, LOG_NOTICE, LOG_WARNING}, &nobug_default_ringbuffer, NULL,NULL}) \
841 NOBUG_IF(NOBUG_MODE_RELEASE, {#name, NULL, 0, \
842 {LOG_NOTICE, -1, LOG_WARNING, LOG_WARNING, LOG_ERR}, &nobug_default_ringbuffer, NULL,NULL}) \
843 )
846 #define NOBUG_DEFINE_FLAG_PARENT(name, parent) \
847 NOBUG_FLAG_IF_DECLAREONLY(NOBUG_DECLARE_FLAG(name)) \
848 NOBUG_FLAG_IF_NOT_DECLAREONLY( \
849 NOBUG_DECLARE_FLAG(parent); \
850 struct nobug_flag NOBUG_FLAG(name) = \
851 NOBUG_IF(NOBUG_MODE_ALPHA, {#name, &NOBUG_FLAG(parent), 0, \
852 {LOG_DEBUG, LOG_INFO, LOG_DEBUG, -1, LOG_INFO}, &nobug_default_ringbuffer, NULL,NULL}) \
853 NOBUG_IF(NOBUG_MODE_BETA, {#name, &NOBUG_FLAG(parent), 0, \
854 {LOG_INFO, LOG_NOTICE, LOG_NOTICE, LOG_NOTICE, LOG_WARNING}, &nobug_default_ringbuffer, NULL,NULL}) \
855 NOBUG_IF(NOBUG_MODE_RELEASE, {#name, &NOBUG_FLAG(parent), 0, \
856 {LOG_NOTICE, -1, LOG_WARNING, LOG_WARNING, LOG_ERR}, &nobug_default_ringbuffer, NULL,NULL}) \
857 )
860 #define NOBUG_DEFINE_FLAG_LIMIT(name, limit) \
861 NOBUG_FLAG_IF_DECLAREONLY(NOBUG_DECLARE_FLAG(name)) \
862 NOBUG_FLAG_IF_NOT_DECLAREONLY( \
863 struct nobug_flag NOBUG_FLAG(name) = \
864 NOBUG_IF(NOBUG_MODE_ALPHA, {#name, NULL, 0, \
865 {LOG_DEBUG, limit, LOG_DEBUG, -1, LOG_INFO}, &nobug_default_ringbuffer, NULL,NULL}) \
866 NOBUG_IF(NOBUG_MODE_BETA, {#name, NULL, 0, \
867 {LOG_INFO, LOG_NOTICE, limit, LOG_NOTICE, LOG_WARNING}, &nobug_default_ringbuffer, NULL,NULL}) \
868 NOBUG_IF(NOBUG_MODE_RELEASE, {#name, NULL, 0, \
869 {LOG_NOTICE, -1, LOG_WARNING, limit, LOG_ERR}, &nobug_default_ringbuffer, NULL,NULL}) \
870 )
873 #define NOBUG_DEFINE_FLAG_PARENT_LIMIT(name, parent, limit) \
874 NOBUG_FLAG_IF_DECLAREONLY(NOBUG_DECLARE_FLAG(name)) \
875 NOBUG_FLAG_IF_NOT_DECLAREONLY( \
876 NOBUG_DECLARE_FLAG(parent); \
877 struct nobug_flag NOBUG_FLAG(name) = \
878 NOBUG_IF(NOBUG_MODE_ALPHA, {#name, &NOBUG_FLAG(parent), 0, \
879 {LOG_DEBUG, limit, LOG_DEBUG, -1, LOG_INFO}, &nobug_default_ringbuffer, NULL,NULL}) \
880 NOBUG_IF(NOBUG_MODE_BETA, {#name, &NOBUG_FLAG(parent), 0, \
881 {LOG_INFO, LOG_NOTICE, limit, LOG_NOTICE, LOG_WARNING}, &nobug_default_ringbuffer, NULL,NULL}) \
882 NOBUG_IF(NOBUG_MODE_RELEASE, {#name, &NOBUG_FLAG(parent), 0, \
883 {LOG_NOTICE, -1, LOG_WARNING, limit, LOG_ERR}, &nobug_default_ringbuffer, NULL,NULL}) \
884 )
887 #define NOBUG_INIT_FLAG(name) \
888 nobug_env_init_flag (&NOBUG_FLAG(name), NOBUG_LOG_TARGET, NOBUG_LOG_LIMIT)
891 #define NOBUG_INIT_FLAG_LIMIT(name, default) \
892 nobug_env_init_flag (&NOBUG_FLAG(name), NOBUG_LOG_TARGET, default)
895 #define NOBUG_CPP_DEFINE_FLAG(name) \
896 NOBUG_FLAG_IF_DECLAREONLY( \
897 NOBUG_DECLARE_FLAG(name); \
898 extern int nobug_cppflag_##name \
899 ) \
900 NOBUG_FLAG_IF_NOT_DECLAREONLY_CPP( \
901 NOBUG_DEFINE_FLAG(name); \
902 int nobug_cppflag_##name = NOBUG_INIT_FLAG(name) \
903 )
906 #define NOBUG_CPP_DEFINE_FLAG_PARENT(name, parent) \
907 NOBUG_FLAG_IF_DECLAREONLY( \
908 NOBUG_DECLARE_FLAG(name); \
909 extern int nobug_cppflag_##name \
910 ) \
911 NOBUG_FLAG_IF_NOT_DECLAREONLY_CPP( \
912 NOBUG_DEFINE_FLAG_PARENT(name, parent); \
913 int nobug_cppflag_##name = NOBUG_INIT_FLAG(name) \
914 )
917 #define NOBUG_CPP_DEFINE_FLAG_LIMIT(name, default) \
918 NOBUG_FLAG_IF_DECLAREONLY( \
919 NOBUG_DECLARE_FLAG(name); \
920 extern int nobug_cppflag_##name \
921 ) \
922 NOBUG_FLAG_IF_NOT_DECLAREONLY_CPP( \
923 NOBUG_DEFINE_FLAG_LIMIT(name, default); \
924 int nobug_cppflag_##name = NOBUG_INIT_FLAG_LIMIT(name, default) \
925 )
928 #define NOBUG_CPP_DEFINE_FLAG_PARENT_LIMIT(name, parent, default) \
929 NOBUG_FLAG_IF_DECLAREONLY( \
930 NOBUG_DECLARE_FLAG(name); \
931 extern int nobug_cppflag_##name \
932 ) \
933 NOBUG_FLAG_IF_NOT_DECLAREONLY_CPP( \
934 NOBUG_DEFINE_FLAG_PARENT_LIMIT(name, parent, default); \
935 int nobug_cppflag_##name = NOBUG_INIT_FLAG_LIMIT(name, default) \
936 )
939 #ifndef NOBUG_DECLARE_ONLY
940 #define NOBUG_DECLARE_ONLY 0
941 #endif
943 #define NOBUG_FLAG_IF_DECLAREONLY(...) \
944 NOBUG_IF(NOBUG_DECLARE_ONLY, __VA_ARGS__)
946 #define NOBUG_FLAG_IF_NOT_DECLAREONLY(...) \
947 NOBUG_IFNOT(NOBUG_DECLARE_ONLY, __VA_ARGS__)
949 #ifdef __cplusplus
950 #define NOBUG_FLAG_IF_NOT_DECLAREONLY_CPP(...) \
951 NOBUG_IFNOT(NOBUG_DECLARE_ONLY, __VA_ARGS__)
952 #else
953 #define NOBUG_FLAG_IF_NOT_DECLAREONLY_CPP(...) \
954 NOBUG_IFNOT(NOBUG_DECLARE_ONLY, NOBUG_ERROR_CANT_DEFINE_AUTOINITIALIZED_CPP_FLAGS_IN_C)
955 #endif
957 #ifndef NOBUG_LOG_LIMIT_ALPHA
958 # define NOBUG_LOG_LIMIT_ALPHA LOG_INFO
959 #endif
960 #ifndef NOBUG_LOG_LIMIT_BETA
961 # define NOBUG_LOG_LIMIT_BETA LOG_WARNING
962 #endif
963 #ifndef NOBUG_LOG_LIMIT_RELEASE
964 # define NOBUG_LOG_LIMIT_RELEASE LOG_CRIT
965 #endif
967 #ifndef NOBUG_LOG_LIMIT
968 # define NOBUG_LOG_LIMIT \
969 NOBUG_IF_ALPHA( NOBUG_LOG_LIMIT_ALPHA) \
970 NOBUG_IF_BETA( NOBUG_LOG_LIMIT_BETA) \
971 NOBUG_IF_RELEASE( NOBUG_LOG_LIMIT_RELEASE)
972 #endif
974 #ifndef NOBUG_LOG_TARGET_ALPHA
975 # define NOBUG_LOG_TARGET_ALPHA NOBUG_TARGET_CONSOLE
976 #endif
977 #ifndef NOBUG_LOG_TARGET_BETA
978 # define NOBUG_LOG_TARGET_BETA NOBUG_TARGET_FILE
979 #endif
980 #ifndef NOBUG_LOG_TARGET_RELEASE
981 # define NOBUG_LOG_TARGET_RELEASE NOBUG_TARGET_SYSLOG
982 #endif
984 #ifndef NOBUG_LOG_TARGET
985 # define NOBUG_LOG_TARGET \
986 NOBUG_IF_ALPHA( NOBUG_LOG_TARGET_ALPHA) \
987 NOBUG_IF_BETA( NOBUG_LOG_TARGET_BETA) \
988 NOBUG_IF_RELEASE( NOBUG_LOG_TARGET_RELEASE)
989 #endif
991 #define NOBUG_SET_LIMIT(flag, min) \
992 NOBUG_IF_NOT_RELEASE( NOBUG_FLAG(flag) = (min))
995 /*
996 //resourcemacros HEAD~ Resource tracking macros;;
997 //resourcemacros
998 //resourcemacros INDEX RESOURCE_LOGGING; RESOURCE_LOGGING; switch resource logging on and off
999 //resourcemacros INDEX RESOURCE_LOG_LEVEL; RESOURCE_LOG_LEVEL; select the log level for resource logging
1000 //resourcemacros
1001 //resourcemacros Unless the user defines `NOBUG_RESOURCE_LOGGING` to 0 each of the above macros
1002 //resourcemacros will emit a log message at `NOBUG_RESOURCE_LOG_LEVEL` which defaults to
1003 //resourcemacros `LOG_DEBUG`.
1004 //resourcemacros
1005 */
1006 #ifndef NOBUG_RESOURCE_LOGGING
1007 #define NOBUG_RESOURCE_LOGGING 1
1008 #endif
1010 #ifndef NOBUG_RESOURCE_LOG_LEVEL
1011 #define NOBUG_RESOURCE_LOG_LEVEL LOG_DEBUG
1012 #endif
1015 /*
1016 //resourcemacros PARA RESOURCE_HANDLE; RESOURCE_HANDLE; define resource handles
1017 //resourcemacros RESOURCE_HANDLE(name)
1018 //resourcemacros RESOURCE_HANDLE_INIT(name)
1019 //resourcemacros RESOURCE_USER(name)
1020 //resourcemacros RESOURCE_USER_INIT(name)
1021 //resourcemacros
1022 //resourcemacros Define and initialize handles for to track resources.
1023 //resourcemacros
1024 //resourcemacros `name`::
1025 //resourcemacros identifer to be used for the handle
1026 //resourcemacros
1027 //resourcemacros There are two kinds of handles, each resource itself is abstracted with a
1028 //resourcemacros `RESOURCE_HANDLE` and every access to this resources is tracked through a
1029 //resourcemacros `RESOURCE_USER` handle. These macros takes care that the declaration is optimized
1030 //resourcemacros out in the same manner as the rest of the resource tracker would be disabled.
1031 //resourcemacros You can still instantiate handles as `struct nobug_resource_record*` or
1032 //resourcemacros `struct nobug_resource_user*` in structures which must have a constant size
1033 //resourcemacros unconditional of the build level. The two `*_INIT` macros can be used to initialize
1034 //resourcemacros resource handles and are optimized out when the resource tracker gets disabled.
1035 //resourcemacros
1036 */
1037 #define NOBUG_RESOURCE_HANDLE(handle) \
1038 NOBUG_IF_ALPHA(struct nobug_resource_record* handle)
1040 #define NOBUG_RESOURCE_HANDLE_INIT(handle) NOBUG_IF_ALPHA(handle = NULL)
1042 #define NOBUG_RESOURCE_USER(handle) \
1043 NOBUG_IF_ALPHA(struct nobug_resource_user* handle)
1045 #define NOBUG_RESOURCE_USER_INIT(handle) NOBUG_IF_ALPHA(handle = NULL)
1048 /*
1049 //resourcemacros PARA RESOURCE_ANNOUNCE; RESOURCE_ANNOUNCE; publish new resources
1050 //resourcemacros RESOURCE_ANNOUNCE(flag, type, name, identifier, handle)
1051 //resourcemacros
1052 //resourcemacros Publishes resources.
1053 //resourcemacros
1054 //resourcemacros `flag`::
1055 //resourcemacros the NoBug flag which turns logging on for this macro
1056 //resourcemacros `type`::
1057 //resourcemacros a string which should denote the domain of the resource,
1058 //resourcemacros examples are "file", "mutex", "lock", "database" and so on
1059 //resourcemacros `name`::
1060 //resourcemacros the actual name of a named resource this as string which
1061 //resourcemacros together with type forms a unique identifier of the resource. `type` and
1062 //resourcemacros `name` must be available through the entire lifetime of the resource, using
1063 //resourcemacros literal strings is recommended
1064 //resourcemacros `identifier`::
1065 //resourcemacros a pointer which should be unique for this resource, any
1066 //resourcemacros kind of pointer will suffice, it is only used for identification. In
1067 //resourcemacros multithreaded applications the thread identifier becomes an additional
1068 //resourcemacros identifier
1069 //resourcemacros `handle`::
1070 //resourcemacros a `NOBUG_RESOURCE_HANDLE` which will be initialized to point to
1071 //resourcemacros the newly created resource.
1072 //resourcemacros
1073 //resourcemacros Resources must be unique, it is a fatal error when a resource it tried to be
1074 //resourcemacros announced more than one time.
1075 //resourcemacros
1076 */
1077 #define NOBUG_RESOURCE_ANNOUNCE(flag, type, name, ptr, handle) \
1078 NOBUG_RESOURCE_ANNOUNCE_RAW(&NOBUG_FLAG(flag), type, name, ptr, handle)
1080 #define NOBUG_RESOURCE_ANNOUNCE_RAW(flag, type, name, ptr, handle) \
1081 NOBUG_IF_ALPHA( do { \
1082 NOBUG_RESOURCE_LOCK; \
1084 NOBUG_IF(NOBUG_RESOURCE_LOGGING, \
1085 NOBUG_LOG_(flag, NOBUG_RESOURCE_LOG_LEVEL, \
1088 NOBUG_RESOURCE_ASSERT(handle = nobug_resource_announce (type, name, ptr, \
1092 NOBUG_RESOURCE_UNLOCK; \
1093 } while (0))
1096 /*
1097 //resourcemacros PARA RESOURCE_FORGET; RESOURCE_FORGET; remove resources
1098 //resourcemacros RESOURCE_FORGET(flag, handle)
1099 //resourcemacros
1100 //resourcemacros Removes resources that have become unavailable from the registry.
1101 //resourcemacros
1102 //resourcemacros `flag`::
1103 //resourcemacros the NoBug flag which turns logging on for this macro
1104 //resourcemacros `handle`::
1105 //resourcemacros the `NOBUG_RESOURCE_HANDLE` used to track this resource
1106 //resourcemacros
1107 //resourcemacros The resource must still exist and no users must be attached to it, else a fatal
1108 //resourcemacros error is raised.
1109 //resourcemacros
1110 */
1111 #define NOBUG_RESOURCE_FORGET(flag, handle) \
1112 NOBUG_RESOURCE_FORGET_RAW(&NOBUG_FLAG(flag), handle)
1114 #define NOBUG_RESOURCE_FORGET_RAW(flag, handle) \
1115 NOBUG_IF_ALPHA( do { \
1116 NOBUG_RESOURCE_LOCK; \
1117 NOBUG_IF(NOBUG_RESOURCE_LOGGING, \
1118 NOBUG_LOG_(flag, NOBUG_RESOURCE_LOG_LEVEL, NOBUG_LOCATION_INFO, \
1122 handle?handle->object_id:NULL);) \
1123 NOBUG_RESOURCE_ASSERT(nobug_resource_forget (handle), \
1127 handle?handle->object_id:NULL, \
1128 nobug_resource_error); \
1129 handle = NULL; \
1130 NOBUG_RESOURCE_UNLOCK; \
1131 } while (0))
1134 /*
1135 //resourcemacros PARA RESOURCE_ENTER; RESOURCE_ENTER; claim a resource
1136 //resourcemacros RESOURCE_ENTER(flag, announced, user, state, handle)
1137 //resourcemacros
1138 //resourcemacros Acquire a resource.
1139 //resourcemacros
1140 //resourcemacros `flag`::
1141 //resourcemacros nobug flag which turns logging on for this macro
1142 //resourcemacros `announced`::
1143 //resourcemacros the handle set by `RESOURCE_ANNOUNCE`
1144 //resourcemacros `user`::
1145 //resourcemacros a free-form identifier
1146 //resourcemacros `state`::
1147 //resourcemacros the initial state, one of `NOBUG_RESOURCE_WAITING`,
1148 //resourcemacros `NOBUG_RESOURCE_EXCLUSIVE`, `NOBUG_RESOURCE_RECURSIVE` or `NOBUG_RESOURCE_SHARED`
1149 //resourcemacros `handle`::
1150 //resourcemacros a `NOBUG_RESOURCE_HANDLE` which will be initialized to the
1151 //resourcemacros entering node
1152 //resourcemacros
1153 //resourcemacros
1154 */
1155 #define NOBUG_RESOURCE_ENTER(flag, resource, user, state, handle) \
1156 NOBUG_IF_ALPHA( \
1157 do { \
1160 NOBUG_RESOURCE_LOCK; \
1161 NOBUG_IF(NOBUG_RESOURCE_LOGGING, \
1162 NOBUG_LOG_(&NOBUG_FLAG(flag), NOBUG_RESOURCE_LOG_LEVEL, \
1167 resource?resource->object_id:NULL, \
1168 user, \
1169 nobug_resource_states[state]);) \
1170 NOBUG_RESOURCE_ASSERT(handle = \
1171 nobug_resource_enter (resource, \
1172 user, state, \
1178 resource?resource->object_id:NULL, \
1179 user, nobug_resource_states[state], \
1180 nobug_resource_error); \
1181 NOBUG_RESOURCE_UNLOCK; \
1182 } while(0))
1185 //resourcemacros PARA RESOURCE_WAIT; RESOURCE_WAIT; wait for a resource to become available
1186 //resourcemacros RESOURCE_WAIT(flag, resource, user, handle)
1187 //resourcemacros
1188 //resourcemacros This is just an alias for RESOURCE_ENTER(flag, resource, user, NOBUG_RESOURCE_WAITING, handle)
1189 //resourcemacros
1190 //resourcemacros .How to use it
1191 //resourcemacros [source,c]
1192 //resourcemacros ----
1193 //resourcemacros RESOURCE_WAIT(flag, resource, user, handle);
1194 //resourcemacros if (lock_my_resource() == ERROR)
1195 //resourcemacros NOBUG_RESOURCE_LEAVE(flag, handle);
1196 //resourcemacros else
1197 //resourcemacros RESOURCE_STATE(flag, NOBUG_RESOURCE_EXCLUSIVE, handle);
1198 //resourcemacros ----
1199 //resourcemacros
1200 #define NOBUG_RESOURCE_WAIT(flag, resource, user, handle) \
1201 NOBUG_RESOURCE_ENTER(flag, resource, user, NOBUG_RESOURCE_WAITING, handle)
1204 /*
1205 //resourcemacros PARA RESOURCE_STATE; RESOURCE_STATE; change the state of a resource
1206 //resourcemacros RESOURCE_STATE(flag, entered, state)
1207 //resourcemacros
1208 //resourcemacros Changes resource's state.
1209 //resourcemacros
1210 //resourcemacros `flag`::
1211 //resourcemacros is nobug flag which turns logging on for this macro
1212 //resourcemacros `state`::
1213 //resourcemacros the new state Note that only certain state transitions are
1214 //resourcemacros allowed, see discussion/diagram above
1215 //resourcemacros `entered`::
1216 //resourcemacros the handle set by `RESOURCE_ENTER`
1217 //resourcemacros
1218 */
1219 #define NOBUG_RESOURCE_STATE(flag, state, entered) \
1220 NOBUG_RESOURCE_STATE_RAW(&NOBUG_FLAG(flag), state, entered)
1222 #define NOBUG_RESOURCE_STATE_RAW(flag, nstate, entered) \
1223 NOBUG_IF_ALPHA( \
1224 do { \
1225 NOBUG_RESOURCE_LOCK; \
1226 NOBUG_IF(NOBUG_RESOURCE_LOGGING, \
1227 NOBUG_LOG_(flag, NOBUG_RESOURCE_LOG_LEVEL, NOBUG_LOCATION_INFO, \
1233 nobug_resource_states[entered?entered->state \
1234 :NOBUG_RESOURCE_INVALID], \
1235 nobug_resource_states[nstate]); \
1236 ) \
1237 NOBUG_RESOURCE_ASSERT(nobug_resource_state (entered, nstate), \
1244 nobug_resource_states[entered?entered->state \
1245 :NOBUG_RESOURCE_INVALID], \
1246 nobug_resource_states[nstate], \
1247 nobug_resource_error); \
1248 NOBUG_RESOURCE_UNLOCK; \
1249 } while (0))
1252 /*
1253 //resourcemacros PARA RESOURCE_LEAVE; RESOURCE_LEAVE; relinquish a claimed resource
1254 //resourcemacros RESOURCE_LEAVE(flag, handle)
1255 //resourcemacros
1256 //resourcemacros Disconnect from a resource identified with its handle.
1257 //resourcemacros
1258 //resourcemacros `flag`::
1259 //resourcemacros nobug flag which turns logging on for this macro
1260 //resourcemacros `handle`::
1261 //resourcemacros the handle you got while entering the resource
1262 //resourcemacros
1263 //resourcemacros 'RESOURCE_LEAVE()' acts like the head of a C loop statement, it ties to the following
1264 //resourcemacros (block-) statement. Leaving and the user defined following statement are atomic.
1265 //resourcemacros This statement must not be left by break, return or any other kind of jump. NoBug does
1266 //resourcemacros not assert this (for for Performance reasons).
1267 //resourcemacros
1268 //resourcemacros .How to use it
1269 //resourcemacros [source,c]
1270 //resourcemacros ----
1271 //resourcemacros NOBUG_RESOURCE_LEAVE(flag, handle)
1272 //resourcemacros {
1273 //resourcemacros unlock_my_resource();
1274 //resourcemacros }
1275 //resourcemacros ----
1276 //resourcemacros
1277 */
1278 #define NOBUG_RESOURCE_LEAVE(flag, handle) \
1279 NOBUG_RESOURCE_LEAVE_RAW(&NOBUG_FLAG(flag), handle)
1281 #define NOBUG_RESOURCE_LEAVE_RAW(flag, handle) \
1282 NOBUG_IF_ALPHA( \
1283 for ( \
1284 int nobug_locked_ = (NOBUG_RESOURCE_LOCK, 1); \
1285 nobug_locked_; \
1286 ({ \
1287 NOBUG_IF(NOBUG_RESOURCE_LOGGING, \
1288 NOBUG_LOG_(flag, NOBUG_RESOURCE_LOG_LEVEL, NOBUG_LOCATION_INFO, \
1294 nobug_resource_states[handle?handle->state \
1295 :NOBUG_RESOURCE_INVALID]); \
1296 ) \
1297 NOBUG_RESOURCE_ASSERT(nobug_resource_leave (handle), \
1304 nobug_resource_states[handle?handle->state \
1305 :NOBUG_RESOURCE_INVALID], \
1306 nobug_resource_error); \
1307 handle = NULL; \
1308 NOBUG_RESOURCE_UNLOCK; \
1309 nobug_locked_ = 0; \
1310 })))
1313 /*
1314 //resourcemacros PARA RESOURCE_ASSERT_STATE; RESOURCE_ASSERT_STATE; assert the state of a resource
1315 //resourcemacros RESOURCE_ASSERT_STATE(resource, state)
1316 //resourcemacros RESOURCE_ASSERT_STATE_IF(when, resource, state)
1317 //resourcemacros
1318 //resourcemacros Assert that we have a resource in a given state. For multithreaded programms the topmost
1319 //resourcemacros state of the calling thread is checked, for non threadeded programs the most recent state on
1320 //resourcemacros resource is used.
1321 //resourcemacros
1322 //resourcemacros `when`::
1323 //resourcemacros Condition which must be true for testing the assertion
1324 //resourcemacros `resource`::
1325 //resourcemacros Resource handle
1326 //resourcemacros `state`::
1327 //resourcemacros The expected state
1328 //resourcemacros
1329 */
1330 #define NOBUG_RESOURCE_ASSERT_STATE(resource, state) \
1331 do { \
1332 enum nobug_resource_state mystate = nobug_resource_mystate (resource); \
1333 NOBUG_RESOURCE_ASSERT(mystate == state, \
1336 resource, nobug_resource_states[mystate], nobug_resource_states[state]); \
1337 } while (0)
1340 #define NOBUG_RESOURCE_ASSERT_STATE_IF(when, resource, state) \
1341 NOBUG_IF_ALPHA (NOBUG_WHEN(when, NOBUG_RESOURCE_ASSERT_STATE (resource, state))
1344 /* assertion which dumps all resources */
1345 #define NOBUG_RESOURCE_ASSERT(expr, what, location, ...) \
1346 NOBUG_IF_ALPHA( \
1347 NOBUG_WHEN (!(expr), \
1348 NOBUG_LOG_( &nobug_flag_NOBUG_ON, LOG_EMERG, \
1349 location, what, \
1350 ## __VA_ARGS__); \
1351 nobug_resource_dump_all (&(struct nobug_resource_dump_context) \
1352 {&nobug_flag_NOBUG_ON, \
1353 LOG_EMERG, \
1354 NOBUG_LOCATION_ARGS}); \
1355 NOBUG_BACKTRACE; \
1356 NOBUG_ABORT))
1359 /*
1360 //resourcemacros PARA RESOURCE_DUMP; RESOURCE_DUMP; dump the state of a single resource
1361 //resourcemacros NOBUG_RESOURCE_DUMP(flag, handle)
1362 //resourcemacros NOBUG_RESOURCE_DUMP_IF(when, flag, handle)
1363 //resourcemacros
1364 //resourcemacros Dump the state of a single resource.
1365 //resourcemacros
1366 //resourcemacros `when`::
1367 //resourcemacros Condition which must be true to dump the resource
1368 //resourcemacros `flag`::
1369 //resourcemacros Nobug flag for the log channel
1370 //resourcemacros `handle`::
1371 //resourcemacros handle of the resource to be dumped
1372 //resourcemacros
1373 */
1374 #define NOBUG_RESOURCE_DUMP(flag, handle) \
1375 NOBUG_IF_ALPHA( \
1376 do { \
1377 NOBUG_RESOURCE_LOCK; \
1378 nobug_resource_dump (handle, &(struct nobug_resource_dump_context) \
1379 {&NOBUG_FLAG(flag), \
1380 NOBUG_RESOURCE_LOG_LEVEL, \
1381 NOBUG_LOCATION_ARGS}); \
1382 NOBUG_RESOURCE_UNLOCK; \
1383 } while (0))
1385 #define NOBUG_RESOURCE_DUMP_IF(when, flag, handle) \
1386 NOBUG_IF_ALPHA( \
1387 NOBUG_WHEN(when, NOBUG_RESOURCE_LOCK; \
1388 nobug_resource_dump (handle, &(struct nobug_resource_dump_context) \
1389 {&NOBUG_FLAG(flag), \
1390 NOBUG_RESOURCE_LOG_LEVEL, \
1391 NOBUG_LOCATION_ARGS}); \
1392 NOBUG_RESOURCE_UNLOCK))
1395 /*
1396 //resourcemacros PARA RESOURCE_DUMPALL; RESOURCE_DUMPALL; dump the state of all resources
1397 //resourcemacros NOBUG_RESOURCE_DUMPALL(flag)
1398 //resourcemacros NOBUG_RESOURCE_DUMPALL_IF(when, flag)
1399 //resourcemacros
1400 //resourcemacros Dump the state of all resources.
1401 //resourcemacros
1402 //resourcemacros `when`::
1403 //resourcemacros Condition which must be true to dump the resources
1404 //resourcemacros `flag`::
1405 //resourcemacros Nobug flag for the log channel
1406 //resourcemacros
1407 */
1408 #define NOBUG_RESOURCE_DUMPALL(flag) \
1409 NOBUG_IF_ALPHA( \
1410 do { \
1411 NOBUG_RESOURCE_LOCK; \
1412 nobug_resource_dump_all (&(struct nobug_resource_dump_context) \
1413 {&NOBUG_FLAG(flag), \
1414 NOBUG_RESOURCE_LOG_LEVEL, \
1415 NOBUG_LOCATION_ARGS}); \
1416 NOBUG_RESOURCE_UNLOCK; \
1417 } while (0))
1420 #define NOBUG_RESOURCE_DUMPALL_IF(when, flag) \
1421 NOBUG_IF_ALPHA( \
1422 NOBUG_WHEN(when, \
1423 NOBUG_RESOURCE_LOCK; \
1424 nobug_resource_dump_all (&(struct nobug_resource_dump_context) \
1425 {&NOBUG_FLAG(flag), \
1426 NOBUG_RESOURCE_LOG_LEVEL, \
1427 NOBUG_LOCATION_ARGS}); \
1428 NOBUG_RESOURCE_UNLOCK))
1430 /*
1431 //resourcemacros PARA RESOURCE_LIST; RESOURCE_LIST; enumerate all registered resources
1432 //resourcemacros NOBUG_RESOURCE_LIST(flag)
1433 //resourcemacros NOBUG_RESOURCE_LIST_IF(when, flag)
1434 //resourcemacros
1435 //resourcemacros List all registered resources.
1436 //resourcemacros
1437 //resourcemacros `when`::
1438 //resourcemacros Condition which must be true to list the resources
1439 //resourcemacros `flag`::
1440 //resourcemacros Nobug flag for the log channel
1441 //resourcemacros
1442 */
1443 #define NOBUG_RESOURCE_LIST(flag) \
1444 NOBUG_IF_ALPHA( \
1445 do { \
1446 NOBUG_RESOURCE_LOCK; \
1447 nobug_resource_list (&(struct nobug_resource_dump_context) \
1448 {&NOBUG_FLAG(flag), \
1449 NOBUG_RESOURCE_LOG_LEVEL, \
1450 NOBUG_LOCATION_ARGS}); \
1451 NOBUG_RESOURCE_UNLOCK; \
1452 } while (0))
1455 #define NOBUG_RESOURCE_LIST_IF(when, flag) \
1456 NOBUG_IF_ALPHA( \
1457 NOBUG_WHEN(when, \
1458 NOBUG_RESOURCE_LOCK; \
1459 nobug_resource_list (&(struct nobug_resource_dump_context) \
1460 {&NOBUG_FLAG(flag), \
1461 NOBUG_RESOURCE_LOG_LEVEL, \
1462 NOBUG_LOCATION_ARGS}); \
1463 NOBUG_RESOURCE_UNLOCK))
1466 /*
1467 threading support
1468 */
1469 #if NOBUG_USE_PTHREAD
1470 #define NOBUG_THREAD_ID_SET(name) nobug_thread_id_set(name)
1472 #define NOBUG_THREAD_ID_COMMA , NOBUG_THREAD_ID_GET
1473 #define NOBUG_THREAD_ID_GET nobug_thread_id_get()
1475 #else
1476 #define NOBUG_THREAD_ID_SET(name)
1478 #define NOBUG_THREAD_ID_COMMA
1480 #endif
1482 #define NOBUG_THREAD_DATA (*nobug_thread_data())
1484 /*
1485 Source location
1486 */
1487 #define NOBUG_LOCATION_ARGS NOBUG_BASENAME(__FILE__), __LINE__, __func__
1488 #define NOBUG_LOCATION_INFO (NOBUG_LOCATION_ARGS)
1490 #define NOBUG_LOCATION_FILE(file, _1, _2) file
1491 #define NOBUG_LOCATION_LINE(_1, line, _2) line
1492 #define NOBUG_LOCATION_FUNC(_1, _2, func) func
1495 /*
1496 Debuggers
1497 */
1499 #define NOBUG_DBG_NONE 0
1500 #define NOBUG_DBG_GDB 1
1501 #define NOBUG_DBG_VALGRIND 2
1503 #define NOBUG_ACTIVE_DBG \
1504 NOBUG_IF(NOBUG_USE_VALGRIND, (RUNNING_ON_VALGRIND?2:0)) \
1505 NOBUG_IFNOT(NOBUG_USE_VALGRIND, 0)
1507 /*
1508 //toolmacros HEAD- Tool Macros;;
1509 //toolmacros
1510 //toolmacros PARA NOBUG_FLAG_RAW; NOBUG_FLAG_RAW; pass direct flag pointer
1511 //toolmacros NOBUG_FLAG_RAW(ptr)
1512 //toolmacros
1513 //toolmacros Using this macro one can pass a direct pointer to a flag where a name would
1514 //toolmacros be expected. This is sometimes convinient when flag pointers are passed around
1515 //toolmacros in management strutures and one wants to tie logging to dynamic targets.
1516 //toolmacros
1517 //toolmacros [source,c]
1518 //toolmacros ----
1519 //toolmacros NOBUG_DEFINE_FLAG(myflag);
1520 //toolmacros ...
1521 //toolmacros struct nobug_flag* ptr = &NOBUG_FLAG(myflag);
1522 //toolmacros TRACE(NOBUG_FLAG_RAW(ptr), "Passed flag by pointer")
1523 //toolmacros ----
1524 //toolmacros
1525 */
1526 #define nobug_flag_NOBUG_FLAG_RAW(name) *name
1528 /*
1529 //toolmacros PARA Backtraces; BACKTRACE; generate a backtrace
1530 //toolmacros BACKTRACE
1531 //toolmacros
1532 //toolmacros The backtrace macro logs a stacktrace using the NoBug facilities.
1533 //toolmacros This is automatically called when NoBug finds an error and is due
1534 //toolmacros to abort. But one might call it manually too.
1535 //toolmacros
1536 */
1537 #define NOBUG_BACKTRACE \
1538 NOBUG_IF_ALPHA( \
1539 switch (NOBUG_ACTIVE_DBG) { \
1540 case NOBUG_DBG_VALGRIND: \
1541 NOBUG_BACKTRACE_VALGRIND; \
1542 break; \
1543 default: \
1544 NOBUG_BACKTRACE_GLIBC; \
1545 }) \
1546 NOBUG_IF_NOT_ALPHA (NOBUG_BACKTRACE_GLIBC)
1548 #define NOBUG_BACKTRACE_DBG \
1549 NOBUG_IF_NOT_RELEASE( \
1550 switch (NOBUG_ACTIVE_DBG) { \
1551 case NOBUG_DBG_VALGRIND: \
1552 NOBUG_BACKTRACE_VALGRIND; \
1553 break; \
1554 })
1558 #define NOBUG_BACKTRACE_VALGRIND \
1559 NOBUG_IF(NOBUG_USE_VALGRIND, \
1560 NOBUG_LOGGING_LOCK; \
1562 NOBUG_LOCATION_ARGS); \
1563 NOBUG_LOGGING_UNLOCK)
1566 #ifndef NOBUG_BACKTRACE_DEPTH
1567 #define NOBUG_BACKTRACE_DEPTH 256
1568 #endif
1570 #define NOBUG_BACKTRACE_GLIBC \
1571 NOBUG_IF_NOT_RELEASE( \
1572 NOBUG_IF(NOBUG_USE_EXECINFO, do { \
1574 NOBUG_LOGGING_LOCK; \
1575 nobug_backtrace_glibc (); \
1576 NOBUG_LOGGING_UNLOCK; \
1577 } while (0)))
1580 #ifndef NOBUG_TAB
1582 #endif
1584 //toolmacros PARA Aborting; ABORT; abort the program
1585 //toolmacros NOBUG_ABORT_
1586 //toolmacros
1587 //toolmacros This is the default implementation for aborting the program, it first syncs all ringbuffers to disk, then
1588 //toolmacros calls the abort callback if defined and then `abort()`.
1589 //toolmacros
1590 //toolmacros NOBUG_ABORT
1591 //toolmacros
1592 //toolmacros If not overridden, evaluates to `NOBUG_ABORT_`. One can override this before including
1593 //toolmacros `nobug.h` to customize abortion behaviour. This will be local to the translation unit then.
1594 //toolmacros
1595 #define NOBUG_ABORT_ \
1596 do { \
1597 nobug_ringbuffer_allsync (); \
1598 if (nobug_abort_callback) \
1599 nobug_abort_callback (nobug_callback_data); \
1600 abort(); \
1601 } while(0)
1603 #ifndef NOBUG_ABORT
1604 #define NOBUG_ABORT NOBUG_ABORT_
1605 #endif
1607 /*
1608 init and other function wrapers
1609 */
1610 #define NOBUG_INIT nobug_init()
1613 /*
1614 short macros without NOBUG_
1615 */
1616 #ifndef NOBUG_DISABLE_SHORTNAMES
1617 #ifndef REQUIRE
1618 #define REQUIRE NOBUG_REQUIRE
1619 #endif
1620 #ifndef REQUIRE_DBG
1621 #define REQUIRE_DBG NOBUG_REQUIRE_DBG
1622 #endif
1623 #ifndef REQUIRE_IF
1624 #define REQUIRE_IF NOBUG_REQUIRE_IF
1625 #endif
1626 #ifndef REQUIRE_IF_DBG
1627 #define REQUIRE_IF_DBG NOBUG_REQUIRE_IF_DBG
1628 #endif
1629 #ifndef ENSURE
1630 #define ENSURE NOBUG_ENSURE
1631 #endif
1632 #ifndef ENSURE_DBG
1633 #define ENSURE_DBG NOBUG_ENSURE_DBG
1634 #endif
1635 #ifndef ENSURE_IF
1636 #define ENSURE_IF NOBUG_ENSURE_IF
1637 #endif
1638 #ifndef ENSURE_IF_DBG
1639 #define ENSURE_IF_DBG NOBUG_ENSURE_IF_DBG
1640 #endif
1641 #ifndef ASSERT
1642 #define ASSERT NOBUG_ASSERT
1643 #endif
1644 #ifndef ASSERT_DBG
1645 #define ASSERT_DBG NOBUG_ASSERT_DBG
1646 #endif
1647 #ifndef ASSERT_IF
1648 #define ASSERT_IF NOBUG_ASSERT_IF
1649 #endif
1650 #ifndef ASSERT_IF_DBG
1651 #define ASSERT_IF_DBG NOBUG_ASSERT_IF_DBG
1652 #endif
1653 #ifndef CHECK
1654 #define CHECK NOBUG_CHECK
1655 #endif
1656 #ifndef CHECK
1657 #define CHECK NOBUG_CHECK
1658 #endif
1659 #ifndef INVARIANT
1660 #define INVARIANT NOBUG_INVARIANT
1661 #endif
1662 #ifndef INVARIANT_DBG
1663 #define INVARIANT_DBG NOBUG_INVARIANT_DBG
1664 #endif
1665 #ifndef INVARIANT_IF
1666 #define INVARIANT_IF NOBUG_INVARIANT_IF
1667 #endif
1668 #ifndef INVARIANT_IF_DBG
1669 #define INVARIANT_IF_DBG NOBUG_INVARIANT_IF_DBG
1670 #endif
1671 #ifndef INVARIANT_ASSERT
1672 #define INVARIANT_ASSERT NOBUG_INVARIANT_ASSERT
1673 #endif
1674 #ifndef DUMP
1675 #define DUMP NOBUG_DUMP
1676 #endif
1677 #ifndef DUMP_DBG
1678 #define DUMP_DBG NOBUG_DUMP_DBG
1679 #endif
1680 #ifndef DUMP_IF
1681 #define DUMP_IF NOBUG_DUMP_IF
1682 #endif
1683 #ifndef DUMP_IF_DBG
1684 #define DUMP_IF_DBG NOBUG_DUMP_IF_DBG
1685 #endif
1686 #ifndef DUMP_LOG
1687 #define DUMP_LOG NOBUG_DUMP_LOG
1688 #endif
1689 #ifndef DUMP_LOG_DBG
1690 #define DUMP_LOG_DBG NOBUG_DUMP_LOG_DBG
1691 #endif
1692 #ifndef DUMP_LOG_IF
1693 #define DUMP_LOG_IF NOBUG_DUMP_LOG_IF
1694 #endif
1695 #ifndef DUMP_LOG_IF_DBG
1696 #define DUMP_LOG_IF_DBG NOBUG_DUMP_LOG_IF_DBG
1697 #endif
1698 #ifndef LOG
1699 #define LOG NOBUG_LOG
1700 #endif
1701 #ifndef LOG_DBG
1702 #define LOG_DBG NOBUG_LOG_DBG
1703 #endif
1704 #ifndef LOG_IF
1705 #define LOG_IF NOBUG_LOG_IF
1706 #endif
1707 #ifndef LOG_IF_DBG
1708 #define LOG_IF_DBG NOBUG_LOG_IF_DBG
1709 #endif
1710 #ifndef ECHO
1711 #define ECHO NOBUG_ECHO
1712 #endif
1713 #ifndef ALERT
1714 #define ALERT NOBUG_ALERT
1715 #endif
1716 #ifndef ALERT_DBG
1717 #define ALERT_DBG NOBUG_ALERT_DBG
1718 #endif
1719 #ifndef ALERT_IF
1720 #define ALERT_IF NOBUG_ALERT_IF
1721 #endif
1722 #ifndef ALERT_IF_DBG
1723 #define ALERT_IF_DBG NOBUG_ALERT_IF_DBG
1724 #endif
1725 #ifndef CRITICAL
1726 #define CRITICAL NOBUG_CRITICAL
1727 #endif
1728 #ifndef CRITICAL_DBG
1729 #define CRITICAL_DBG NOBUG_CRITICAL_DBG
1730 #endif
1731 #ifndef CRITICAL_IF
1732 #define CRITICAL_IF NOBUG_CRITICAL_IF
1733 #endif
1734 #ifndef CRITICAL_IF_DBG
1735 #define CRITICAL_IF_DBG NOBUG_CRITICAL_IF_DBG
1736 #endif
1737 #ifndef ERROR
1738 #define ERROR NOBUG_ERROR
1739 #endif
1740 #ifndef ERROR_DBG
1741 #define ERROR_DBG NOBUG_ERROR_DBG
1742 #endif
1743 #ifndef ERROR_IF
1744 #define ERROR_IF NOBUG_ERROR_IF
1745 #endif
1746 #ifndef ERROR_IF_DBG
1747 #define ERROR_IF_DBG NOBUG_ERROR_IF_DBG
1748 #endif
1749 #ifndef WARN
1750 #define WARN NOBUG_WARN
1751 #endif
1752 #ifndef WARN_DBG
1753 #define WARN_DBG NOBUG_WARN_DBG
1754 #endif
1755 #ifndef WARN_IF
1756 #define WARN_IF NOBUG_WARN_IF
1757 #endif
1758 #ifndef WARN_IF_DBG
1759 #define WARN_IF_DBG NOBUG_WARN_IF_DBG
1760 #endif
1761 #ifndef INFO
1762 #define INFO NOBUG_INFO
1763 #endif
1764 #ifndef INFO_DBG
1765 #define INFO_DBG NOBUG_INFO_DBG
1766 #endif
1767 #ifndef INFO_IF
1768 #define INFO_IF NOBUG_INFO_IF
1769 #endif
1770 #ifndef INFO_IF_DBG
1771 #define INFO_IF_DBG NOBUG_INFO_IF_DBG
1772 #endif
1773 #ifndef NOTICE
1774 #define NOTICE NOBUG_NOTICE
1775 #endif
1776 #ifndef NOTICE_DBG
1777 #define NOTICE_DBG NOBUG_NOTICE_DBG
1778 #endif
1779 #ifndef NOTICE_IF
1780 #define NOTICE_IF NOBUG_NOTICE_IF
1781 #endif
1782 #ifndef NOTICE_IF_DBG
1783 #define NOTICE_IF_DBG NOBUG_NOTICE_IF_DBG
1784 #endif
1785 #ifndef TRACE
1786 #define TRACE NOBUG_TRACE
1787 #endif
1788 #ifndef TRACE_DBG
1789 #define TRACE_DBG NOBUG_TRACE_DBG
1790 #endif
1791 #ifndef TRACE_IF
1792 #define TRACE_IF NOBUG_TRACE_IF
1793 #endif
1794 #ifndef TRACE_IF_DBG
1795 #define TRACE_IF_DBG NOBUG_TRACE_IF_DBG
1796 #endif
1797 #ifndef BACKTRACE
1798 #define BACKTRACE NOBUG_BACKTRACE
1799 #endif
1800 #ifndef BACKTRACE_DBG
1801 #define BACKTRACE_DBG NOBUG_BACKTRACE_DBG
1802 #endif
1803 #ifndef DEPRECATED
1804 #define DEPRECATED NOBUG_DEPRECATED
1805 #endif
1806 #ifndef UNIMPLEMENTED
1807 #define UNIMPLEMENTED NOBUG_UNIMPLEMENTED
1808 #endif
1809 #ifndef FIXME
1810 #define FIXME NOBUG_FIXME
1811 #endif
1812 #ifndef TODO
1813 #define TODO NOBUG_TODO
1814 #endif
1815 #ifndef PLANNED
1816 #define PLANNED NOBUG_PLANNED
1817 #endif
1818 #ifndef NOTREACHED
1819 #define NOTREACHED NOBUG_NOTREACHED
1820 #endif
1821 #ifndef ELSE_NOTREACHED
1822 #define ELSE_NOTREACHED NOBUG_ELSE_NOTREACHED
1823 #endif
1824 #ifndef INJECT_GOODBAD
1825 #define INJECT_GOODBAD NOBUG_INJECT_GOODBAD
1826 #endif
1827 #ifndef INJECT_FAULT
1828 #define INJECT_FAULT NOBUG_INJECT_FAULT
1829 #endif
1830 #ifndef CLEANUP
1831 #define CLEANUP NOBUG_CLEANUP
1832 #endif
1833 #ifndef CHECKED
1834 #define CHECKED NOBUG_CHECKED
1835 #endif
1836 #ifndef UNCHECKED
1837 #define UNCHECKED NOBUG_UNCHECKED
1838 #endif
1839 #ifndef RESOURCE_ANNOUNCE
1840 #define RESOURCE_ANNOUNCE NOBUG_RESOURCE_ANNOUNCE
1841 #endif
1842 #ifndef RESOURCE_FORGET
1843 #define RESOURCE_FORGET NOBUG_RESOURCE_FORGET
1844 #endif
1845 #ifndef RESOURCE_ENTER
1846 #define RESOURCE_ENTER NOBUG_RESOURCE_ENTER
1847 #endif
1848 #ifndef RESOURCE_WAIT
1849 #define RESOURCE_WAIT NOBUG_RESOURCE_WAIT
1850 #endif
1851 #ifndef RESOURCE_STATE
1852 #define RESOURCE_STATE NOBUG_RESOURCE_STATE
1853 #endif
1854 #ifndef RESOURCE_LEAVE
1855 #define RESOURCE_LEAVE NOBUG_RESOURCE_LEAVE
1856 #endif
1857 #ifndef RESOURCE_LEAVE_LOOKUP
1858 #define RESOURCE_LEAVE_LOOKUP NOBUG_RESOURCE_LEAVE_LOOKUP
1859 #endif
1860 #ifndef RESOURCE_HANDLE
1861 #define RESOURCE_HANDLE NOBUG_RESOURCE_HANDLE
1862 #endif
1863 #ifndef RESOURCE_HANDLE_INIT
1864 #define RESOURCE_HANDLE_INIT NOBUG_RESOURCE_HANDLE_INIT
1865 #endif
1866 #ifndef RESOURCE_USER
1867 #define RESOURCE_USER NOBUG_RESOURCE_USER
1868 #endif
1869 #ifndef RESOURCE_ASSERT_STATE
1870 #define RESOURCE_ASSERT_STATE NOBUG_RESOURCE_ASSERT_STATE
1871 #endif
1872 #ifndef RESOURCE_ASSERT_STATE_IF
1873 #define RESOURCE_ASSERT_STATE_IF NOBUG_RESOURCE_ASSERT_STATE_IF
1874 #endif
1875 #ifndef RESOURCE_USER_INIT
1876 #define RESOURCE_USER_INIT NOBUG_RESOURCE_USER_INIT
1877 #endif
1878 #ifndef RESOURCE_DUMP
1879 #define RESOURCE_DUMP NOBUG_RESOURCE_DUMP
1880 #endif
1881 #ifndef RESOURCE_DUMP_IF
1882 #define RESOURCE_DUMP_IF NOBUG_RESOURCE_DUMP_IF
1883 #endif
1884 #ifndef RESOURCE_DUMPALL
1885 #define RESOURCE_DUMPALL NOBUG_RESOURCE_DUMPALL
1886 #endif
1887 #ifndef RESOURCE_DUMPALL_IF
1888 #define RESOURCE_DUMPALL_IF NOBUG_RESOURCE_DUMPALL_IF
1889 #endif
1890 #ifndef RESOURCE_LIST
1891 #define RESOURCE_LIST NOBUG_RESOURCE_LIST
1892 #endif
1893 #ifndef RESOURCE_LIST_IF
1894 #define RESOURCE_LIST_IF NOBUG_RESOURCE_LIST_IF
1895 #endif
1899 /*
1900 Tool macros
1901 */
1902 #ifdef __GNUC__
1903 #define NOBUG_CLEANUP(fn) NOBUG_IF_ALPHA(__attribute__((cleanup(fn))))
1904 #define NOBUG_ATTR_PRINTF(fmt, ell) __attribute__ ((format (printf, fmt, ell)))
1905 #else
1906 #define NOBUG_CLEANUP(fn)
1907 #define NOBUG_ATTR_PRINTF(fmt, ell)
1908 #endif
1910 /*
1911 //toolmacros PARA NOBUG_ALPHA_COMMA; NOBUG_ALPHA_COMMA; append something after a comma in *ALPHA* builds
1912 //toolmacros NOBUG_ALPHA_COMMA(something)
1913 //toolmacros NOBUG_ALPHA_COMMA_NULL
1914 //toolmacros
1915 //toolmacros Sometimes it is useful to have initializer code only in *ALPHA* builds, for example when you
1916 //toolmacros conditionally include resource handles only in *ALPHA* versions. An initializer can then
1917 //toolmacros use this macros to append a comman and something else only in *ALPHA* builds as in:
1918 //toolmacros struct foo = {"foo", "bar" NOBUG_ALPHA_COMMA_NULL };
1919 //toolmacros
1920 */
1921 #define NOBUG_COMMA ,
1922 #define NOBUG_ALPHA_COMMA(something) NOBUG_IF_ALPHA(NOBUG_COMMA something)
1923 #define NOBUG_ALPHA_COMMA_NULL NOBUG_ALPHA_COMMA(NULL)
1925 #define NOBUG_ONCE(code) \
1926 do { \
1927 static volatile int NOBUG_CAT(nobug_once_,__LINE__) = 0; \
1928 if (NOBUG_EXPECT_FALSE(!NOBUG_CAT(nobug_once_,__LINE__))) \
1929 { \
1930 NOBUG_CAT(nobug_once_,__LINE__) = 1; \
1931 code; \
1932 } \
1933 } while (0)
1935 #if __GNUC__
1936 #define NOBUG_EXPECT_FALSE(x) __builtin_expect(!!(x),0)
1937 #else
1938 #define NOBUG_EXPECT_FALSE(x) x
1939 #endif
1941 #define NOBUG_WHEN(when, ...) \
1942 do{ if (NOBUG_EXPECT_FALSE(when)){ __VA_ARGS__;}} while(0)
1944 /*
1945 //toolmacros PARA NOBUG_IF_*; NOBUG_IF; include code conditionally on build level
1946 //toolmacros NOBUG_IF_ALPHA(...)
1947 //toolmacros NOBUG_IF_NOT_ALPHA(...)
1948 //toolmacros NOBUG_IF_BETA(...)
1949 //toolmacros NOBUG_IF_NOT_BETA(...)
1950 //toolmacros NOBUG_IF_RELEASE(...)
1951 //toolmacros NOBUG_IF_NOT_RELEASE(...)
1952 //toolmacros
1953 //toolmacros This macros allow one to conditionally include the code in '(...)' only if the
1954 //toolmacros criteria on the build level is met. If not, nothing gets substituted. Mostly used
1955 //toolmacros internally, but can also be used for custom things.
1956 //toolmacros
1957 */
1958 #define NOBUG_IF_ALPHA(...) \
1959 NOBUG_IF(NOBUG_MODE_ALPHA, __VA_ARGS__) \
1961 #define NOBUG_IF_NOT_ALPHA(...) \
1962 NOBUG_IFNOT(NOBUG_MODE_ALPHA, __VA_ARGS__) \
1964 #define NOBUG_IF_BETA(...) \
1965 NOBUG_IF(NOBUG_MODE_BETA, __VA_ARGS__) \
1967 #define NOBUG_IF_NOT_BETA(...) \
1968 NOBUG_IFNOT(NOBUG_MODE_BETA, __VA_ARGS__) \
1970 #define NOBUG_IF_RELEASE(...) \
1971 NOBUG_IF(NOBUG_MODE_RELEASE, __VA_ARGS__) \
1973 #define NOBUG_IF_NOT_RELEASE(...) \
1974 NOBUG_IFNOT(NOBUG_MODE_RELEASE, __VA_ARGS__) \
1976 /*
1977 preprocessor hacks/metaprogramming
1978 */
1980 #define NOBUG_IF(bool, ...) NOBUG_CAT(NOBUG_IF_,bool)(__VA_ARGS__)
1981 #define NOBUG_IF_1(...) __VA_ARGS__
1982 #define NOBUG_IF_0(...)
1984 #define NOBUG_IFNOT(bool, ...) NOBUG_CAT(NOBUG_IF_, NOBUG_NOT(bool))(__VA_ARGS__)
1986 #define NOBUG_NOT(bool) NOBUG_CAT(NOBUG_NOT_, bool)
1987 #define NOBUG_NOT_1 0
1988 #define NOBUG_NOT_0 1
1990 #define NOBUG_AND(a,b) NOBUG_CAT3(NOBUG_AND_, a, b)
1991 #define NOBUG_AND_00 0
1992 #define NOBUG_AND_01 0
1993 #define NOBUG_AND_10 0
1994 #define NOBUG_AND_11 1
1996 #define NOBUG_OR(a,b) NOBUG_CAT3(NOBUG_OR_, a, b)
1997 #define NOBUG_OR_00 0
1998 #define NOBUG_OR_01 1
1999 #define NOBUG_OR_10 1
2000 #define NOBUG_OR_11 1
2002 #define NOBUG_XOR(a,b) NOBUG_CAT( NOBUG_XOR_, NOBUG_CAT(a,b))
2003 #define NOBUG_XOR_00 0
2004 #define NOBUG_XOR_01 1
2005 #define NOBUG_XOR_10 1
2006 #define NOBUG_XOR_11 0
2008 #define NOBUG_CAT(a,b) NOBUG_CAT_(a,b)
2009 #define NOBUG_CAT_(a,b) a##b
2011 #define NOBUG_CAT3(a,b,c) NOBUG_CAT3_(a,b,c)
2012 #define NOBUG_CAT3_(a,b,c) a##b##c
2014 #define NOBUG_HEAD(head, ...) head
2015 #define NOBUG_TAIL(_, ...) , ## __VA_ARGS__
2017 #define NOBUG_STRINGIZE(s) NOBUG_STRINGIZE_(s)
2018 #define NOBUG_STRINGIZE_(s) #s
2021 /*
2022 LIBNOBUG DECLARATIONS
2023 */
2024 #ifdef __cplusplus
2026 #elif 0
2028 #endif
2030 #ifndef LLIST_DEFINED
2031 #define LLIST_DEFINED
2032 struct llist_struct
2033 {
2036 };
2037 #endif
2039 /*
2040 envvar control
2041 */
2042 enum nobug_log_targets
2043 {
2044 NOBUG_TARGET_RINGBUFFER,
2045 NOBUG_TARGET_CONSOLE,
2046 NOBUG_TARGET_FILE,
2047 NOBUG_TARGET_SYSLOG,
2048 NOBUG_TARGET_APPLICATION
2049 };
2051 struct nobug_flag
2052 {
2060 };
2062 int
2063 nobug_env_parse_flag (const char* env, struct nobug_flag* flag, int default_target, int default_limit);
2065 int
2069 /*
2070 ringbuffer
2071 */
2072 struct nobug_ringbuffer
2073 {
2080 };
2082 enum nobug_ringbuffer_flags
2083 {
2084 NOBUG_RINGBUFFER_DEFAULT, /* Default is to overwrite file and delete it on nobug_ringbuffer_destroy */
2088 };
2090 /*
2091 Note: some flags conflict (TEMP with KEEP) nobug_ringbuffer will not error on these but continue gracefully
2092 with sane (but undefined) semantics.
2093 */
2104 void
2107 void
2110 void
2113 int
2116 int
2128 int
2131 int
2137 void
2141 /*
2142 multithreading extras
2143 */
2144 #if NOBUG_USE_PTHREAD
2146 struct nobug_tls_data
2147 {
2151 };
2169 #endif
2174 /*
2175 resource registry
2176 */
2178 #if NOBUG_USE_PTHREAD
2179 #define NOBUG_RESOURCE_LOCK pthread_mutex_lock (&nobug_resource_mutex)
2180 #define NOBUG_RESOURCE_UNLOCK pthread_mutex_unlock (&nobug_resource_mutex)
2181 #define NOBUG_LOGGING_LOCK pthread_mutex_lock (&nobug_logging_mutex)
2182 #define NOBUG_LOGGING_UNLOCK pthread_mutex_unlock (&nobug_logging_mutex)
2184 /*
2185 Note: errors are all fatal, we dont unlock the mutex when returning an error,
2186 this should be handled better in future but does not hurt
2187 */
2188 #else
2189 #define NOBUG_RESOURCE_LOCK
2190 #define NOBUG_RESOURCE_UNLOCK
2191 #define NOBUG_LOGGING_LOCK
2192 #define NOBUG_LOGGING_UNLOCK
2193 #endif
2195 enum nobug_resource_state
2196 {
2197 NOBUG_RESOURCE_INVALID,
2198 NOBUG_RESOURCE_WAITING,
2199 NOBUG_RESOURCE_EXCLUSIVE,
2200 NOBUG_RESOURCE_RECURSIVE,
2201 NOBUG_RESOURCE_SHARED
2202 };
2205 struct nobug_resource_header
2206 {
2210 };
2215 struct nobug_resource_record
2216 {
2223 #if NOBUG_USE_PTHREAD
2225 #endif
2226 };
2229 struct nobug_resource_node
2230 {
2236 struct llist_struct childs; /* down the tree, all nodes pointing to here (TODO make this a slist) */
2238 };
2241 struct nobug_resource_user
2242 {
2248 #if NOBUG_USE_PTHREAD
2251 #endif
2252 };
2260 void
2263 void
2268 nobug_resource_announce (const char* type, const char* name, const void* object_id, const char* extra);
2270 int
2280 int
2284 unsigned
2288 unsigned
2292 #if NOBUG_USE_PTHREAD
2293 unsigned
2295 #endif
2298 struct nobug_resource_dump_context
2299 {
2305 };
2307 enum nobug_resource_state
2310 void
2311 nobug_resource_dump (struct nobug_resource_record* resource, struct nobug_resource_dump_context* context);
2313 void
2316 int
2321 void
2325 /*
2326 global config, data and defaults
2327 */
2330 /*
2331 the destroy function is optional, since nobug should stay alive for the whole application lifetime
2332 (and destroying is global!) it is only provided for the nobug testsuite itself
2333 */
2336 void
2339 void
2350 //callbacks HEAD- Callbacks;;
2351 //callbacks
2352 //callbacks NoBug provides callbacks, applications can use these
2353 //callbacks to present logging information in some custom way or hook some special processing in.
2354 //callbacks The callbacks are initialized to NULL and never modified by NoBug, its the solve responsibility
2355 //callbacks of the user to manage them.
2356 //callbacks
2357 //callbacks CAUTION: There are certain constraints what and what not can be done in callbacks
2358 //callbacks documented below which must be followed.
2359 //callbacks
2360 //callbacks PARA type of logging callbacks; logging_cb; type of a logging callback function
2361 typedef void (*nobug_logging_cb)(const struct nobug_flag* flag, int priority, const char *log, void* data); //callbacks VERBATIM;
2362 //callbacks
2363 //callbacks used for the logging callbacks
2364 //callbacks
2365 //callbacks `flag`::
2366 //callbacks Flag structure which defines the logging configuration for this event
2367 //callbacks `priority`::
2368 //callbacks Log level of the current event
2369 //callbacks `log`::
2370 //callbacks Pointing to the current log line in the ringbuffer or `NULL`
2371 //callbacks `data`::
2372 //callbacks Global pointer defined by the user, passed arround (see below)
2373 //callbacks
2375 //callbacks PARA type of abort callback; abort_cb; type of a abort callback function
2377 //callbacks
2378 //callbacks used for the abort callback
2379 //callbacks
2380 //callbacks `data`::
2381 //callbacks Global data defined by the user, passed arround (see below)
2382 //callbacks
2384 //callbacks PARA passing data to callbacks; callback_data; data to be passed to callbacks
2385 extern
2387 //callbacks
2388 //callbacks This global variable is initialized to `NULL` and will never be touched by NoBug. One can use it
2389 //callbacks to pass extra data to the callback functions.
2390 //callbacks
2392 //callbacks PARA callback when logging; logging_callback; hook when something get logged
2393 extern
2395 //callbacks
2396 //callbacks This callback gets called when something gets logged.
2397 //callbacks NoBug will still hold its mutexes when calling this hook, calling NoBug logging or resource tracking
2398 //callbacks functions from here recursively will deadlock and must be avoided.
2399 //callbacks The `log` parameter points to the logging message in the ringbuffer.
2400 //callbacks Unlike other logging targets it is not automatically limited to the log level configured
2401 //callbacks in the flag but called unconditionally. The callback should implement its own limiting.
2402 //callbacks
2403 //callbacks When one wants to do complex calls which may include recursion into logging and resource tracking
2404 //callbacks functions, the intended way is to pass contextual information possibly including a __copy__ of the
2405 //callbacks `log` parameter in xref:THREAD_DATA[NOBUG_THREAD_DATA] to the postlogging callback (see below).
2406 //callbacks Other internal NoBug facilties, like the ringbuffer etc, are protected by the mutexes and may be accessed
2407 //callbacks from this function.
2408 //callbacks
2410 //callbacks PARA callback after logging; postlogging_callback; hook after something get logged
2411 extern
2413 //callbacks
2414 //callbacks This callback gets called after something got logged. The `log` parameter is always NULL and all
2415 //callbacks NoBug mutexes are released. This means that this function may call any complex things, including
2416 //callbacks calling logging and resource tracking, but may not call internal NoBug facilities.
2417 //callbacks Contextual created in the `nobug_logging_callback` and stored in xref:THREAD_DATA[NOBUG_THREAD_DATA] can be
2418 //callbacks retrieved here and may need to be cleaned up here.
2419 //callbacks
2421 //callbacks PARA callback for aborting; abort_callback; hook to handle a termination
2422 extern
2424 //callbacks
2425 //callbacks This callback gets called when the application shall be terminated due an error.
2426 //callbacks It can be used to hook exceptions or similar things in. When it returns, `abort()`
2427 //callbacks is called.
2428 //callbacks
2429 //callbacks IMPORTANT: Errors detected by NoBug are always fatal. If one handles and possible
2430 //callbacks throws an exception here, the application must shut down as soon as possible.
2431 //callbacks Most causes for aborts are optimitzed out in `RELEASE` builds.
2432 //callbacks
2434 #ifdef __cplusplus
2436 #endif
2438 #ifndef NOBUG_LIBNOBUG_C
2440 /*
2441 tag this translation unit as unchecked in ALPHA and BETA builds
2442 */
2446 #endif