dump.h File Reference

#include <stdio.h>
#include <string.h>
#include <derive-c/core/attributes.h>
#include <derive-c/core/namespace.h>
#include <derive-c/core/debug/fmt.h>

Go to the source code of this file.

Macros
#define	_DC_DEBUG_MAX_CAPACITY   4096
#define	DC_DEBUG(DEBUG_FN, DEBUG_PTR)

Functions
static DC_INTERNAL FILE *	_dc_debug_dump_start (void)
static DC_INTERNAL char const *	_dc_debug_dump_end (FILE *mem_stream)
static DC_PUBLIC void	dc_debug_dump_reset (void)

Variables
static const char *	_dc_debug_trailing_space = "..."
	A no-alloc, debug dump utility for use in asserts.
static DC_THREAD_LOCAL char	_dc_debug_dump_buf [_DC_DEBUG_MAX_CAPACITY+4] = {}
static DC_THREAD_LOCAL size_t	_dc_debug_dump_head = 0
static DC_THREAD_LOCAL size_t	_dc_debug_dump_start_pos = 0

Macro Definition Documentation

_DC_DEBUG_MAX_CAPACITY

#define _DC_DEBUG_MAX_CAPACITY   4096

Definition at line 15 of file dump.h.

DC_DEBUG

#define DC_DEBUG	(		DEBUG_FN,
			DEBUG_PTR )

Value:

({                                                                                             \
    FILE* stream = _dc_debug_dump_start();                                                     \
    char const* result;                                                                        \
    if (stream == NULL) {                                                                      \
        result = _dc_debug_trailing_space;                                                     \
    } else {                                                                                   \
        DEBUG_FN(DEBUG_PTR, dc_debug_fmt_new(), stream);                                       \
        result = _dc_debug_dump_end(stream);                                                   \
    }                                                                                          \
    result;                                                                                    \
})

Examples

complex/employees.c, complex/prime_sieve.c, container/arena.c, container/bitset.c, container/map.c, container/queue.c, container/set.c, container/vector.c, utils/log.c, utils/option.c, and utils/result.c.

Definition at line 92 of file dump.h.

#define DC_DEBUG(DEBUG_FN, DEBUG_PTR)                                                              \
    ({                                                                                             \
        FILE* stream = _dc_debug_dump_start();                                                     \
        char const* result;                                                                        \
        if (stream == NULL) {                                                                      \
            result = _dc_debug_trailing_space;                                                     \
        } else {                                                                                   \
            DEBUG_FN(DEBUG_PTR, dc_debug_fmt_new(), stream);                                       \
            result = _dc_debug_dump_end(stream);                                                   \
        }                                                                                          \
        result;                                                                                    \
    })

Function Documentation

_dc_debug_dump_end()

DC_INTERNAL char const * _dc_debug_dump_end ( FILE * mem_stream )

static

Definition at line 39 of file dump.h.

                                                                    {
    if (mem_stream == NULL) {
        return _dc_debug_trailing_space;
    }
 
    fflush(mem_stream);
    long used_long = ftell(mem_stream);
    fclose(mem_stream);
 
    if (used_long < 0) {
        return _dc_debug_trailing_space;
    }
 
    size_t used = (size_t)used_long;
 
    size_t start = _dc_debug_dump_start_pos;
    size_t available = _DC_DEBUG_MAX_CAPACITY - start;
    size_t trailing_len = strlen(_dc_debug_trailing_space);
 
    if (used > available) {
        size_t content_size = available - trailing_len;
 
        for (size_t i = 0; i < trailing_len; i++) {
            _dc_debug_dump_buf[start + content_size + i] = _dc_debug_trailing_space[i];
        }
        _dc_debug_dump_buf[start + content_size + trailing_len] = '\0';
 
        _dc_debug_dump_head = start + content_size + trailing_len + 1;
        return &_dc_debug_dump_buf[start];
    }
    _dc_debug_dump_buf[start + used] = '\0';
    _dc_debug_dump_head = start + used + 1;
    return &_dc_debug_dump_buf[start];
}

_dc_debug_dump_start()

DC_INTERNAL FILE * _dc_debug_dump_start ( void )

static

Definition at line 20 of file dump.h.

                                                    {
    // JUSTIFY: Single static buffer
    //  - Thread local required for thread safety
    //  - The returned strings must outlive the function call (e.g. to be used in a printf)
    //  - Multiple prints are possible.
    //  A single thread local buffer suits this task well.
 
    if (_dc_debug_dump_head >= _DC_DEBUG_MAX_CAPACITY) {
        return NULL;
    }
 
    _dc_debug_dump_start_pos = _dc_debug_dump_head;
    size_t available = _DC_DEBUG_MAX_CAPACITY - _dc_debug_dump_start_pos;
    size_t writable = available + 1;
 
    FILE* mem_stream = fmemopen(_dc_debug_dump_buf + _dc_debug_dump_start_pos, writable, "w");
    return mem_stream;
}

dc_debug_dump_reset()

DC_PUBLIC void dc_debug_dump_reset ( void )

static

Definition at line 77 of file dump.h.

                                                {
    _dc_debug_dump_head = 0;
    _dc_debug_dump_start_pos = 0;
 
    // JUSTIFY: For easier debugging in coredumps from unit tests, clear the buffer.
    memset(_dc_debug_dump_buf, 0, sizeof(_dc_debug_dump_buf));
}

Variable Documentation

_dc_debug_dump_buf

DC_THREAD_LOCAL char _dc_debug_dump_buf[_DC_DEBUG_MAX_CAPACITY+4] = {}

static

Definition at line 16 of file dump.h.

{};

_dc_debug_dump_head

DC_THREAD_LOCAL size_t _dc_debug_dump_head = 0

static

Definition at line 17 of file dump.h.

_dc_debug_dump_start_pos

DC_THREAD_LOCAL size_t _dc_debug_dump_start_pos = 0

static

Definition at line 18 of file dump.h.

_dc_debug_trailing_space

const char* _dc_debug_trailing_space = "..."

static

A no-alloc, debug dump utility for use in asserts.

• Writes debug formatted data to a static buffer, so stable & static-lifetime references can be used with string formatting.
• No heap allocation, so no leaking on format.

Definition at line 14 of file dump.h.