#define _GNU_SOURCE
#include "log.h"
#include <assert.h>
#include <inttypes.h>
#include <pthread.h>
#include <stdarg.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "compat.h"
#include "in_internal.h"
#include "ly_common.h"
#include "plugins_exts.h"
#include "plugins_internal.h"
#include "set.h"
#include "tree_data.h"
#include "tree_data_internal.h"
#include "tree_schema.h"
#include "tree_schema_internal.h"
ATOMIC_T ly_ll = (uint_fast32_t)LY_LLWRN;
ATOMIC_T ly_log_opts = (uint_fast32_t)(LY_LOLOG | LY_LOSTORE_LAST);
THREAD_LOCAL uint32_t *temp_ly_log_opts;
static ly_log_clb log_clb;
THREAD_LOCAL ly_log_clb temp_log_clb;
THREAD_LOCAL char last_msg[LY_LAST_MSG_SIZE];
#ifndef NDEBUG
ATOMIC_T ly_ldbg_groups = 0;
#endif
THREAD_LOCAL struct ly_log_location_s log_location = {0};
LIBYANG_API_DEF const char *
ly_strerr(LY_ERR err)
{
err &= ~LY_EPLUGIN;
switch (err) {
case LY_SUCCESS:
return "Success";
case LY_EMEM:
return "Out of memory";
case LY_ESYS:
return "System call failed";
case LY_EINVAL:
return "Invalid value";
case LY_EEXIST:
return "Already exists";
case LY_ENOTFOUND:
return "Not found";
case LY_EINT:
return "Internal error";
case LY_EVALID:
return "Validation failed";
case LY_EDENIED:
return "Operation denied";
case LY_EINCOMPLETE:
return "Operation incomplete";
case LY_ERECOMPILE:
return "Recompilation required";
case LY_ENOT:
return "Negative result";
case LY_EOTHER:
return "Another failure reason";
case LY_EPLUGIN:
break;
}
return "Unknown";
}
LIBYANG_API_DEF const char *
ly_strvecode(LY_VECODE vecode)
{
switch (vecode) {
case LYVE_SUCCESS:
return "Success";
case LYVE_SYNTAX:
return "General syntax error";
case LYVE_SYNTAX_YANG:
return "YANG syntax error";
case LYVE_SYNTAX_YIN:
return "YIN syntax error";
case LYVE_REFERENCE:
return "Reference error";
case LYVE_XPATH:
return "XPath error";
case LYVE_SEMANTICS:
return "Semantic error";
case LYVE_SYNTAX_XML:
return "XML syntax error";
case LYVE_SYNTAX_JSON:
return "JSON syntax error";
case LYVE_DATA:
return "YANG data error";
case LYVE_OTHER:
return "Another error";
}
return "Unknown";
}
LIBYANG_API_DEF const char *
ly_last_logmsg(void)
{
return last_msg;
}
LIBYANG_API_DEF LY_ERR
ly_err_new(struct ly_err_item **err, LY_ERR ecode, LY_VECODE vecode, char *data_path, char *apptag,
const char *err_format, ...)
{
char *msg = NULL;
struct ly_err_item *e;
if (!err || (ecode == LY_SUCCESS)) {
return ecode;
}
e = calloc(1, sizeof *e);
LY_CHECK_ERR_RET(!e, LOGMEM(NULL), LY_EMEM);
e->prev = (*err) ? (*err)->prev : e;
if (*err) {
(*err)->prev->next = e;
}
e->level = LY_LLERR;
e->err = ecode;
e->vecode = vecode;
e->data_path = data_path;
e->apptag = apptag;
if (err_format) {
va_list print_args;
va_start(print_args, err_format);
if (vasprintf(&msg, err_format, print_args) == -1) {
msg = NULL;
}
va_end(print_args);
}
e->msg = msg;
if (!(*err)) {
*err = e;
}
return e->err;
}
LIBYANG_API_DEF const struct ly_err_item *
ly_err_first(const struct ly_ctx *ctx)
{
struct ly_ctx_private_data *ctx_data;
LY_CHECK_ARG_RET(NULL, ctx, NULL);
ctx_data = ly_ctx_private_data_get_or_create(ctx);
LY_CHECK_RET(!ctx_data, NULL);
return ctx_data->errs;
}
LIBYANG_API_DEF const struct ly_err_item *
ly_err_last(const struct ly_ctx *ctx)
{
struct ly_ctx_private_data *ctx_data;
LY_CHECK_ARG_RET(NULL, ctx, NULL);
ctx_data = ly_ctx_private_data_get_or_create(ctx);
LY_CHECK_RET(!ctx_data, NULL);
return ctx_data->errs ? ctx_data->errs->prev : NULL;
}
LIBYANG_API_DEF void
ly_err_free(void *ptr)
{
struct ly_err_item *e, *next;
LY_LIST_FOR_SAFE(ptr, next, e) {
free(e->msg);
free(e->data_path);
free(e->schema_path);
free(e->apptag);
free(e);
}
}
LIBYANG_API_DEF void
ly_err_clean(const struct ly_ctx *ctx, struct ly_err_item *eitem)
{
struct ly_ctx_private_data *ctx_data;
struct ly_err_item *e;
if (!ctx) {
return;
}
ctx_data = ly_ctx_private_data_get_or_create(ctx);
if (ctx_data->errs == eitem) {
eitem = NULL;
}
if (!eitem) {
ly_err_free(ctx_data->errs);
ctx_data->errs = NULL;
} else {
for (e = ctx_data->errs; e && (e->next != eitem); e = e->next) {}
assert(e);
e->next = NULL;
ctx_data->errs->prev = e;
ly_err_free(eitem);
}
}
LIBYANG_API_DEF LY_LOG_LEVEL
ly_log_level(LY_LOG_LEVEL level)
{
LY_LOG_LEVEL prev = ATOMIC_LOAD_RELAXED(ly_ll);
ATOMIC_STORE_RELAXED(ly_ll, level);
return prev;
}
LIBYANG_API_DEF uint32_t
ly_log_options(uint32_t opts)
{
uint32_t prev = ATOMIC_LOAD_RELAXED(ly_log_opts);
ATOMIC_STORE_RELAXED(ly_log_opts, opts);
return prev;
}
LIBYANG_API_DEF uint32_t *
ly_temp_log_options(uint32_t *opts)
{
uint32_t *prev_lo = temp_ly_log_opts;
temp_ly_log_opts = opts;
return prev_lo;
}
LIBYANG_API_DEF uint32_t
ly_log_dbg_groups(uint32_t dbg_groups)
{
#ifndef NDEBUG
uint32_t prev = ATOMIC_LOAD_RELAXED(ly_ldbg_groups);
ATOMIC_STORE_RELAXED(ly_ldbg_groups, dbg_groups);
return prev;
#else
(void)dbg_groups;
return 0;
#endif
}
LIBYANG_API_DEF void
ly_set_log_clb(ly_log_clb clb)
{
log_clb = clb;
}
LIBYANG_API_DEF ly_log_clb
ly_get_log_clb(void)
{
return log_clb;
}
LIBYANG_API_DEF ly_log_clb
ly_temp_log_clb(ly_log_clb clb)
{
ly_log_clb prev_cb = temp_log_clb;
temp_log_clb = clb;
return prev_cb;
}
void
ly_log_location(const struct lysc_node *scnode, const char *path, const struct ly_in *in)
{
if (scnode) {
ly_set_add(&log_location.scnodes, (void *)scnode, 1, NULL);
}
if (path) {
char *s = strdup(path);
LY_CHECK_ERR_RET(!s, LOGMEM(NULL), );
ly_set_add(&log_location.paths, s, 1, NULL);
}
if (in) {
ly_set_add(&log_location.inputs, in, 1, NULL);
}
}
void
ly_log_location_revert(uint32_t scnode_steps, uint32_t path_steps, uint32_t in_steps)
{
uint32_t i;
for (i = scnode_steps; i && log_location.scnodes.count; i--) {
log_location.scnodes.count--;
}
for (i = path_steps; i && log_location.paths.count; i--) {
ly_set_rm_index(&log_location.paths, log_location.paths.count - 1, free);
}
for (i = in_steps; i && log_location.inputs.count; i--) {
log_location.inputs.count--;
}
if (scnode_steps && !log_location.scnodes.count) {
ly_set_erase(&log_location.scnodes, NULL);
}
if (path_steps && !log_location.paths.count) {
ly_set_erase(&log_location.paths, free);
}
if (in_steps && !log_location.inputs.count) {
ly_set_erase(&log_location.inputs, NULL);
}
}
static LY_ERR
log_store(const struct ly_ctx *ctx, LY_LOG_LEVEL level, LY_ERR err, LY_VECODE vecode, char *msg, char *data_path,
char *schema_path, uint64_t line, char *apptag)
{
struct ly_ctx_private_data *ctx_data;
struct ly_err_item *e, *last;
assert(ctx && (level < LY_LLVRB));
ctx_data = ly_ctx_private_data_get_or_create(ctx);
LY_CHECK_GOTO(!ctx_data, mem_fail);
e = ctx_data->errs;
if (!e) {
assert(msg);
e = calloc(1, sizeof *e);
LY_CHECK_GOTO(!e, mem_fail);
e->prev = e;
e->next = NULL;
ctx_data->errs = e;
} else if (!msg) {
assert(data_path || schema_path);
e = e->prev;
do {
if (e->level == LY_LLERR) {
if (data_path) {
free(e->data_path);
e->data_path = data_path;
} else {
free(e->schema_path);
e->schema_path = schema_path;
}
return LY_SUCCESS;
}
e = e->prev;
} while (e->prev->next);
assert(0);
} else if ((temp_ly_log_opts && ((*temp_ly_log_opts & LY_LOSTORE_LAST) == LY_LOSTORE_LAST)) ||
(!temp_ly_log_opts && ((ATOMIC_LOAD_RELAXED(ly_log_opts) & LY_LOSTORE_LAST) == LY_LOSTORE_LAST))) {
free(e->msg);
free(e->data_path);
free(e->schema_path);
free(e->apptag);
} else {
last = e->prev;
e->prev = calloc(1, sizeof *e);
LY_CHECK_GOTO(!e->prev, mem_fail);
e = e->prev;
e->prev = last;
e->next = NULL;
last->next = e;
}
e->level = level;
e->err = err;
e->vecode = vecode;
e->msg = msg;
e->data_path = data_path;
e->schema_path = schema_path;
e->line = line;
e->apptag = apptag;
return LY_SUCCESS;
mem_fail:
LOGMEM(NULL);
free(msg);
free(data_path);
free(schema_path);
free(apptag);
return LY_EMEM;
}
static void
log_stderr_path_line(const char *data_path, const char *schema_path, uint64_t line)
{
ly_bool par = 0;
if (data_path) {
fprintf(stderr, "%sdata path: %s", " (", data_path);
par = 1;
}
if (schema_path) {
fprintf(stderr, "%sschemadata path: %s", par ? ", " : " (", schema_path);
par = 1;
}
if (line) {
fprintf(stderr, "%sline: %" PRIu64, par ? ", " : " (", line);
par = 1;
}
fprintf(stderr, par ? ")\n" : "\n");
}
static ly_bool
log_is_noop(ly_bool *will_log, ly_bool *will_store)
{
ly_bool lolog, lostore;
if (temp_ly_log_opts) {
lolog = *temp_ly_log_opts & LY_LOLOG;
lostore = *temp_ly_log_opts & LY_LOSTORE;
} else {
lolog = ATOMIC_LOAD_RELAXED(ly_log_opts) & LY_LOLOG;
lostore = ATOMIC_LOAD_RELAXED(ly_log_opts) & LY_LOSTORE;
}
if (will_log) {
*will_log = lolog;
}
if (will_store) {
*will_store = lostore;
}
return !lolog && !lostore;
}
static void
log_vprintf(const struct ly_ctx *ctx, LY_LOG_LEVEL level, LY_ERR err, LY_VECODE vecode, char *data_path,
char *schema_path, uint64_t line, const char *apptag, const char *format, va_list args)
{
char *dyn_msg = NULL;
const char *msg;
ly_bool free_strs = 1, lolog, lostore;
if (log_is_noop(&lolog, &lostore)) {
goto cleanup;
}
if (err == LY_EMEM) {
vsnprintf(last_msg, LY_LAST_MSG_SIZE, format, args);
msg = last_msg;
} else {
if (vasprintf(&dyn_msg, format, args) == -1) {
LOGMEM(ctx);
goto cleanup;
}
msg = dyn_msg;
strncpy(last_msg, msg, LY_LAST_MSG_SIZE - 1);
}
if ((level <= ATOMIC_LOAD_RELAXED(ly_ll)) && (level < LY_LLVRB) && ctx && lostore && dyn_msg) {
free_strs = 0;
if (log_store(ctx, level, err, vecode, dyn_msg, data_path, schema_path, line, apptag ? strdup(apptag) : NULL)) {
goto cleanup;
}
}
if (lolog) {
if (temp_log_clb) {
temp_log_clb(level, msg, data_path, schema_path, line);
} else if (log_clb) {
log_clb(level, msg, data_path, schema_path, line);
} else if (level <= ATOMIC_LOAD_RELAXED(ly_ll)) {
fprintf(stderr, "libyang[%d]: ", level);
fprintf(stderr, "%s", msg);
log_stderr_path_line(data_path, schema_path, line);
}
}
cleanup:
if (free_strs) {
free(data_path);
free(schema_path);
free(dyn_msg);
}
}
#ifndef NDEBUG
void
ly_log_dbg(uint32_t group, const char *format, ...)
{
char *dbg_format;
const char *str_group;
va_list ap;
if (!(ATOMIC_LOAD_RELAXED(ly_ldbg_groups) & group)) {
return;
}
switch (group) {
case LY_LDGDICT:
str_group = "DICT";
break;
case LY_LDGXPATH:
str_group = "XPATH";
break;
case LY_LDGDEPSETS:
str_group = "DEPSETS";
break;
default:
LOGINT(NULL);
return;
}
if (asprintf(&dbg_format, "%s: %s", str_group, format) == -1) {
LOGMEM(NULL);
return;
}
va_start(ap, format);
log_vprintf(NULL, LY_LLDBG, 0, 0, NULL, NULL, 0, NULL, dbg_format, ap);
va_end(ap);
free(dbg_format);
}
#endif
void
ly_log(const struct ly_ctx *ctx, LY_LOG_LEVEL level, LY_ERR err, const char *format, ...)
{
va_list ap;
va_start(ap, format);
log_vprintf(ctx, level, err, 0, NULL, NULL, 0, NULL, format, ap);
va_end(ap);
}
static LY_ERR
ly_vlog_build_path_line(const struct ly_ctx *ctx, const struct lyd_node *lnode, const struct lysc_node *snode,
char **data_path, char **schema_path, uint64_t *line)
{
int r;
char *path;
*data_path = NULL;
*schema_path = NULL;
*line = 0;
if (lnode) {
*data_path = lyd_path(lnode, LYD_PATH_STD, NULL, 0);
LY_CHECK_ERR_RET(!*data_path, LOGMEM(ctx), LY_EMEM);
if (!snode && log_location.scnodes.count) {
snode = log_location.scnodes.objs[log_location.scnodes.count - 1];
}
if (snode && (!lnode || (lysc_data_parent(snode) == lnode->schema))) {
if (lyd_node_module(lnode) != snode->module) {
r = asprintf(&path, "%s/%s:%s", *data_path, snode->module->name, snode->name);
} else {
r = asprintf(&path, "%s/%s", *data_path, snode->name);
}
free(*data_path);
LY_CHECK_ERR_RET(r == -1, LOGMEM(ctx), LY_EMEM);
*data_path = path;
path = NULL;
}
} else if (snode) {
*schema_path = lysc_path(snode, LYSC_PATH_LOG, NULL, 0);
LY_CHECK_ERR_RET(!*schema_path, LOGMEM(ctx), LY_EMEM);
} else if (log_location.scnodes.count) {
*schema_path = lysc_path(log_location.scnodes.objs[log_location.scnodes.count - 1], LYSC_PATH_LOG, NULL, 0);
LY_CHECK_ERR_RET(!*schema_path, LOGMEM(ctx), LY_EMEM);
}
if (log_location.paths.count && ((const char *)(log_location.paths.objs[log_location.paths.count - 1]))[0]) {
if (*data_path) {
r = asprintf(&path, "%s%s", *data_path, (char *)log_location.paths.objs[log_location.paths.count - 1]);
} else if (*schema_path) {
r = asprintf(&path, "%s%s", *schema_path, (char *)log_location.paths.objs[log_location.paths.count - 1]);
} else {
r = asprintf(&path, "%s", (char *)log_location.paths.objs[log_location.paths.count - 1]);
}
LY_CHECK_ERR_RET(r == -1, LOGMEM(ctx), LY_EMEM);
if (*data_path) {
free(*data_path);
*data_path = path;
} else {
free(*schema_path);
*schema_path = path;
}
}
if (log_location.inputs.count) {
*line = ((struct ly_in *)log_location.inputs.objs[log_location.inputs.count - 1])->line;
}
return LY_SUCCESS;
}
void
ly_vlog(const struct ly_ctx *ctx, const char *apptag, const struct lyd_node *lnode, LY_VECODE code, const char *format, ...)
{
va_list ap;
char *data_path = NULL, *schema_path = NULL;
uint64_t line = 0;
if (ctx) {
ly_vlog_build_path_line(ctx, lnode, NULL, &data_path, &schema_path, &line);
}
va_start(ap, format);
log_vprintf(ctx, LY_LLERR, LY_EVALID, code, data_path, schema_path, line, apptag, format, ap);
va_end(ap);
}
static void
ly_ext_log(const struct ly_ctx *ctx, const char *plugin_name, LY_LOG_LEVEL level, LY_ERR err, char *data_path,
char *schema_path, uint64_t line, const char *format, va_list ap)
{
char *plugin_msg;
if (level > ATOMIC_LOAD_RELAXED(ly_ll)) {
return;
}
if (asprintf(&plugin_msg, "Ext plugin \"%s\": %s", plugin_name, format) == -1) {
LOGMEM(ctx);
return;
}
log_vprintf(ctx, level, (level == LY_LLERR ? LY_EPLUGIN : 0) | err, LYVE_OTHER, data_path, schema_path, line, NULL,
plugin_msg, ap);
free(plugin_msg);
}
LIBYANG_API_DEF void
lyplg_ext_parse_log(const struct lysp_ctx *pctx, const struct lysp_ext_instance *ext, LY_LOG_LEVEL level, LY_ERR err,
const char *format, ...)
{
va_list ap;
char *data_path, *schema_path;
uint64_t line;
ly_vlog_build_path_line(PARSER_CTX(pctx), NULL, NULL, &data_path, &schema_path, &line);
va_start(ap, format);
ly_ext_log(PARSER_CTX(pctx), LYSC_GET_EXT_PLG(ext->plugin_ref)->id, level, err, data_path, schema_path, line, format, ap);
va_end(ap);
}
LIBYANG_API_DEF void
lyplg_ext_compile_log(const struct lysc_ctx *cctx, const struct lysc_ext_instance *ext, LY_LOG_LEVEL level, LY_ERR err,
const char *format, ...)
{
va_list ap;
char *schema_path = NULL;
if (cctx && !(schema_path = strdup(cctx->path))) {
LOGMEM(cctx->ctx);
return;
}
va_start(ap, format);
ly_ext_log(ext->module->ctx, LYSC_GET_EXT_PLG(ext->def->plugin_ref)->id, level, err, NULL, schema_path, 0, format, ap);
va_end(ap);
}
LIBYANG_API_DEF void
lyplg_ext_compile_log_path(const char *path, const struct lysc_ext_instance *ext, LY_LOG_LEVEL level, LY_ERR err,
const char *format, ...)
{
va_list ap;
char *schema_path = NULL;
if (path && !(schema_path = strdup(path))) {
LOGMEM(ext->module->ctx);
return;
}
va_start(ap, format);
ly_ext_log(ext->module->ctx, LYSC_GET_EXT_PLG(ext->def->plugin_ref)->id, level, err, NULL, schema_path, 0, format, ap);
va_end(ap);
}
static void
_lyplg_ext_compile_log_err(const struct ly_err_item *eitem, const struct lysc_ext_instance *ext, ...)
{
va_list ap;
char *data_path = NULL, *schema_path = NULL;
if (eitem->data_path) {
data_path = strdup(eitem->data_path);
}
if (eitem->schema_path) {
schema_path = strdup(eitem->schema_path);
}
va_start(ap, ext);
ly_ext_log(ext->module->ctx, LYSC_GET_EXT_PLG(ext->def->plugin_ref)->id, eitem->level, eitem->err,
data_path, schema_path, eitem->line, "%s", ap);
va_end(ap);
}
LIBYANG_API_DEF void
lyplg_ext_compile_log_err(const struct ly_err_item *eitem, const struct lysc_ext_instance *ext)
{
_lyplg_ext_compile_log_err(eitem, ext, eitem->msg);
}
static void
_ly_err_print(const struct ly_ctx *ctx, const struct ly_err_item *eitem, char *data_path, char *schema_path,
uint64_t line, const char *format, ...)
{
va_list ap;
va_start(ap, format);
log_vprintf(ctx, eitem->level, eitem->err, eitem->vecode, data_path, schema_path, line, eitem->apptag, format, ap);
va_end(ap);
}
LIBYANG_API_DEF void
ly_err_print(const struct ly_ctx *ctx, const struct ly_err_item *eitem, const struct lyd_node *lnode,
const struct lysc_node *snode)
{
char *data_path = NULL, *schema_path = NULL;
uint64_t line = 0;
LY_CHECK_ARG_RET(ctx, eitem, );
if (eitem->level > ATOMIC_LOAD_RELAXED(ly_ll)) {
return;
}
ly_vlog_build_path_line(ctx, lnode, snode, &data_path, &schema_path, &line);
_ly_err_print(ctx, eitem, data_path, schema_path, line, "%s", eitem->msg);
}