libsel4debug/include/sel4debug/debug.h

/*
 * Copyright 2017, Data61, CSIRO (ABN 41 687 119 230)
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <autoconf.h>

#include <sel4/sel4.h>
#include <sel4/types.h>

/* An implementation of printf that you can safely call from within syscall
 * stubs.
 */
int
debug_safe_printf(const char *format, ...)
__attribute__((format(printf, 1, 2)))
__attribute__((no_instrument_function));

void debug_cap_identify(seL4_CPtr cap);

#ifdef CONFIG_DEBUG_BUILD
static inline int debug_cap_is_valid(seL4_CPtr cap)
{
#ifdef CONFIG_DEBUG_BUILD
    return (0 != seL4_DebugCapIdentify(cap));
#else
    return 0; /* fail check on non-debug kernels */
#endif
}

static inline int debug_cap_is_endpoint(seL4_CPtr cap)
{
#ifdef CONFIG_DEBUG_BUILD
    // there is kernel/generated/arch/object/structures_gen.h that defines
    // cap_endpoint_cap = 4, but we can't include it here
    return (4 == seL4_DebugCapIdentify(cap));
#else
    return 0; /* fail check on non-debug kernels */
#endif
}

static inline int debug_cap_is_notification(seL4_CPtr cap)
{
#ifdef CONFIG_DEBUG_BUILD
    // there is kernel/generated/arch/object/structures_gen.h that defines
    // cap_notification_cap = 6, but we can't include it here
    return (6 == seL4_DebugCapIdentify(cap));
#else
    return 0; /* fail check on non-debug kernels */
#endif
}
#endif /* CONFIG_DEBUG_BUILD */

void debug_print_bootinfo(seL4_BootInfo *info);