blob: e6cf5e549540d49a505f8b113f18026281c1d296 [file] [log] [blame]
Radek Krejci5aeea3a2018-09-05 13:29:36 +02001/**
2 * @file common.h
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief common internal definitions for libyang
5 *
6 * Copyright (c) 2015 - 2018 CESNET, z.s.p.o.
7 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef LY_COMMON_H_
16#define LY_COMMON_H_
17
18#include <stdint.h>
19#include <stdlib.h>
20
Radek Krejci2c22f122018-09-05 15:08:03 +020021#include "config.h"
Radek Krejciad573502018-09-07 15:26:55 +020022#include "log.h"
Radek Krejci5aeea3a2018-09-05 13:29:36 +020023
24#if __STDC_VERSION__ >= 201112 && !defined __STDC_NO_THREADS__
25# define THREAD_LOCAL _Thread_local
26#elif defined __GNUC__ || \
27 defined __SUNPRO_C || \
28 defined __xlC__
29# define THREAD_LOCAL __thread
30#else
31# error "Cannot define THREAD_LOCAL"
32#endif
33
34#define GETMACRO2(_1, _2, NAME, ...) NAME
35#define GETMACRO3(_1, _2, _3, NAME, ...) NAME
36#define GETMACRO4(_1, _2, _3, _4, NAME, ...) NAME
37
38/*
39 * logger
40 */
41
42/* internal logging options */
43enum int_log_opts {
44 ILO_LOG = 0, /* log normally */
45 ILO_STORE, /* only store any messages, they will be processed higher on stack */
46 ILO_IGNORE, /* completely ignore messages */
47 ILO_ERR2WRN, /* change errors to warnings */
48};
49
50extern THREAD_LOCAL enum int_log_opts log_opt;
51extern volatile uint8_t ly_log_level;
52extern volatile uint8_t ly_log_opts;
53
Radek Krejciad573502018-09-07 15:26:55 +020054void ly_err_free(void *ptr);
Radek Krejci5aeea3a2018-09-05 13:29:36 +020055void ly_log(const struct ly_ctx *ctx, LY_LOG_LEVEL level, LY_ERR no, const char *format, ...);
56
57#define LOGERR(ctx, errno, str, args...) ly_log(ctx, LY_LLERR, errno, str, ##args)
58#define LOGWRN(ctx, str, args...) ly_log(ctx, LY_LLWRN, 0, str, ##args)
59#define LOGVRB(str, args...) ly_log(NULL, LY_LLVRB, 0, str, ##args)
60
Radek Krejci4ab61562018-09-05 15:00:37 +020061#ifdef NDEBUG
62# define LOGDBG(dbg_group, str, args...)
63#else
64 void ly_log_dbg(int group, const char *format, ...);
65# define LOGDBG(dbg_group, str, args...) ly_log_dbg(dbg_group, str, ##args);
66#endif
67
Radek Krejci5aeea3a2018-09-05 13:29:36 +020068#define LOGMEM(CTX) LOGERR(CTX, LY_EMEM, "Memory allocation failed (%s()).", __func__)
69#define LOGINT(CTX) LOGERR(CTX, LY_EINT, "Internal error (%s:%d).", __FILE__, __LINE__)
70#define LOGARG(CTX, ARG) LOGERR(CTX, LY_EINVAL, "Invalid argument %s (%s()).", #ARG, __func__)
71
72/*
73 * Common code to check return value and perform appropriate action.
74 */
75#define LY_CHECK_GOTO(COND, GOTO) if (COND) {goto GOTO;}
76#define LY_CHECK_ERR_GOTO(COND, ERR, GOTO) if (COND) {ERR; goto GOTO;}
Michal Vaskob3d0d6b2018-09-07 10:17:33 +020077#define LY_CHECK_RET(COND, RETVAL) if (COND) {return RETVAL;}
78#define LY_CHECK_ERR_RET(COND, ERR, RETVAL) if (COND) {ERR; return RETVAL;}
Radek Krejci5aeea3a2018-09-05 13:29:36 +020079
Michal Vaskob3d0d6b2018-09-07 10:17:33 +020080#define LY_CHECK_ARG_GOTO1(CTX, ARG, GOTO) if (!ARG) {LOGARG(CTX, ARG);goto GOTO;}
81#define LY_CHECK_ARG_GOTO2(CTX, ARG1, ARG2, GOTO) LY_CHECK_ARG_GOTO1(CTX, ARG1, GOTO);LY_CHECK_ARG_GOTO1(CTX, ARG2, GOTO)
82#define LY_CHECK_ARG_GOTO3(CTX, ARG1, ARG2, ARG3, GOTO) LY_CHECK_ARG_GOTO2(CTX, ARG1, ARG2, GOTO);LY_CHECK_ARG_GOTO1(CTX, ARG3, GOTO)
83#define LY_CHECK_ARG_GOTO(CTX, ...) GETMACRO4(__VA_ARGS__, LY_CHECK_ARG_GOTO3, LY_CHECK_ARG_GOTO2, LY_CHECK_ARG_GOTO1)(CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +020084
Michal Vaskob3d0d6b2018-09-07 10:17:33 +020085#define LY_CHECK_ARG_RET1(CTX, ARG, RETVAL) if (!ARG) {LOGARG(CTX, ARG);return RETVAL;}
86#define LY_CHECK_ARG_RET2(CTX, ARG1, ARG2, RETVAL) LY_CHECK_ARG_RET1(CTX, ARG1, RETVAL);LY_CHECK_ARG_RET1(CTX, ARG2, RETVAL)
87#define LY_CHECK_ARG_RET3(CTX, ARG1, ARG2, ARG3, RETVAL) LY_CHECK_ARG_RET2(CTX, ARG1, ARG2, RETVAL);LY_CHECK_ARG_RET1(CTX, ARG3, RETVAL)
88#define LY_CHECK_ARG_RET(CTX, ...) GETMACRO4(__VA_ARGS__, LY_CHECK_ARG_RET3, LY_CHECK_ARG_RET2, LY_CHECK_ARG_RET1)(CTX, __VA_ARGS__)
Radek Krejci5aeea3a2018-09-05 13:29:36 +020089
90/*
91 * If the compiler supports attribute to mark objects as hidden, mark all
92 * objects as hidden and export only objects explicitly marked to be part of
93 * the public API.
94 */
95#define API __attribute__((visibility("default")))
96
Michal Vasko1324b6c2018-09-07 11:16:23 +020097/*
98 * Generic useful functions.
99 */
100
101/**
102 * @brief Wrapper for realloc() call. The only difference is that if it fails to
103 * allocate the requested memory, the original memory is freed as well.
104 *
105 * @param[in] ptr Memory to reallocate.
106 * @param[in] size New size of the memory block.
107 *
108 * @return Pointer to the new memory, NULL on error.
109 */
110void *ly_realloc(void *ptr, size_t size);
111
112/*
113 * Macros to work with lysp structures arrays.
114 *
115 * There is a byte allocated after the last item with value 0.
116 */
117#define LYSP_ARRAY_NEW_RET(CTX, ARRAY, NEW_ITEM, RETVAL) int _count; \
118 for (_count = 0; *(ARRAY) && *((uint8_t *)(*(ARRAY) + _count)); ++_count); \
119 if (!_count) *(ARRAY) = malloc(sizeof **(ARRAY) + 1); \
120 else *(ARRAY) = ly_realloc(*(ARRAY), (_count + 1) * sizeof **(ARRAY) + 1); \
121 LY_CHECK_ERR_RET(!*(ARRAY), LOGMEM(CTX), RETVAL); \
122 *((uint8_t *)(*(ARRAY) + _count + 1)) = 0; \
Michal Vasko50b70142018-09-07 13:26:29 +0200123 (NEW_ITEM) = (*(ARRAY)) + _count; \
124 memset(NEW_ITEM, 0, sizeof *(NEW_ITEM));
Michal Vasko1324b6c2018-09-07 11:16:23 +0200125
Radek Krejci5aeea3a2018-09-05 13:29:36 +0200126#endif /* LY_COMMON_H_ */