| /** |
| * @file in.c |
| * @author Radek Krejci <rkrejci@cesnet.cz> |
| * @brief libyang input functions. |
| * |
| * Copyright (c) 2015 - 2020 CESNET, z.s.p.o. |
| * |
| * This source code is licensed under BSD 3-Clause License (the "License"). |
| * You may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * https://opensource.org/licenses/BSD-3-Clause |
| */ |
| |
| #define _GNU_SOURCE |
| #define _POSIX_C_SOURCE 200809L /* strdup, strndup */ |
| |
| #ifdef __APPLE__ |
| #define _DARWIN_C_SOURCE /* F_GETPATH */ |
| #endif |
| |
| #if defined (__NetBSD__) || defined (__OpenBSD__) |
| /* realpath */ |
| #define _XOPEN_SOURCE 1 |
| #define _XOPEN_SOURCE_EXTENDED 1 |
| #endif |
| |
| #include "in.h" |
| #include "in_internal.h" |
| |
| #include <errno.h> |
| #include <fcntl.h> |
| #include <limits.h> |
| #include <stdint.h> |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include <string.h> |
| #include <unistd.h> |
| |
| #include "common.h" |
| #include "compat.h" |
| #include "dict.h" |
| #include "log.h" |
| #include "parser_data.h" |
| #include "parser_internal.h" |
| #include "set.h" |
| #include "tree.h" |
| #include "tree_data.h" |
| #include "tree_data_internal.h" |
| #include "tree_schema.h" |
| #include "tree_schema_internal.h" |
| |
| LIBYANG_API_DEF LY_IN_TYPE |
| ly_in_type(const struct ly_in *in) |
| { |
| LY_CHECK_ARG_RET(NULL, in, LY_IN_ERROR); |
| return in->type; |
| } |
| |
| LIBYANG_API_DEF LY_ERR |
| ly_in_reset(struct ly_in *in) |
| { |
| LY_CHECK_ARG_RET(NULL, in, LY_EINVAL); |
| |
| in->current = in->func_start = in->start; |
| in->line = 1; |
| return LY_SUCCESS; |
| } |
| |
| LIBYANG_API_DEF LY_ERR |
| ly_in_new_fd(int fd, struct ly_in **in) |
| { |
| size_t length; |
| char *addr; |
| |
| LY_CHECK_ARG_RET(NULL, fd >= 0, in, LY_EINVAL); |
| |
| LY_CHECK_RET(ly_mmap(NULL, fd, &length, (void **)&addr)); |
| if (!addr) { |
| LOGERR(NULL, LY_EINVAL, "Empty input file."); |
| return LY_EINVAL; |
| } |
| |
| *in = calloc(1, sizeof **in); |
| LY_CHECK_ERR_RET(!*in, LOGMEM(NULL); ly_munmap(addr, length), LY_EMEM); |
| |
| (*in)->type = LY_IN_FD; |
| (*in)->method.fd = fd; |
| (*in)->current = (*in)->start = (*in)->func_start = addr; |
| (*in)->line = 1; |
| (*in)->length = length; |
| |
| return LY_SUCCESS; |
| } |
| |
| LIBYANG_API_DEF int |
| ly_in_fd(struct ly_in *in, int fd) |
| { |
| int prev_fd; |
| size_t length; |
| const char *addr; |
| |
| LY_CHECK_ARG_RET(NULL, in, in->type == LY_IN_FD, -1); |
| |
| prev_fd = in->method.fd; |
| |
| if (fd != -1) { |
| LY_CHECK_RET(ly_mmap(NULL, fd, &length, (void **)&addr), -1); |
| if (!addr) { |
| LOGERR(NULL, LY_EINVAL, "Empty input file."); |
| return -1; |
| } |
| |
| ly_munmap((char *)in->start, in->length); |
| |
| in->method.fd = fd; |
| in->current = in->start = addr; |
| in->line = 1; |
| in->length = length; |
| } |
| |
| return prev_fd; |
| } |
| |
| LIBYANG_API_DEF LY_ERR |
| ly_in_new_file(FILE *f, struct ly_in **in) |
| { |
| LY_CHECK_ARG_RET(NULL, f, in, LY_EINVAL); |
| |
| LY_CHECK_RET(ly_in_new_fd(fileno(f), in)); |
| |
| /* convert the LY_IN_FD input handler into the LY_IN_FILE */ |
| (*in)->type = LY_IN_FILE; |
| (*in)->method.f = f; |
| |
| return LY_SUCCESS; |
| } |
| |
| LIBYANG_API_DEF FILE * |
| ly_in_file(struct ly_in *in, FILE *f) |
| { |
| FILE *prev_f; |
| |
| LY_CHECK_ARG_RET(NULL, in, in->type == LY_IN_FILE, NULL); |
| |
| prev_f = in->method.f; |
| |
| if (f) { |
| /* convert LY_IN_FILE handler into LY_IN_FD to be able to update it via ly_in_fd() */ |
| in->type = LY_IN_FD; |
| in->method.fd = fileno(prev_f); |
| if (ly_in_fd(in, fileno(f)) == -1) { |
| in->type = LY_IN_FILE; |
| in->method.f = prev_f; |
| return NULL; |
| } |
| |
| /* if success, convert the result back */ |
| in->type = LY_IN_FILE; |
| in->method.f = f; |
| } |
| |
| return prev_f; |
| } |
| |
| LIBYANG_API_DEF LY_ERR |
| ly_in_new_memory(const char *str, struct ly_in **in) |
| { |
| LY_CHECK_ARG_RET(NULL, str, in, LY_EINVAL); |
| |
| *in = calloc(1, sizeof **in); |
| LY_CHECK_ERR_RET(!*in, LOGMEM(NULL), LY_EMEM); |
| |
| (*in)->type = LY_IN_MEMORY; |
| (*in)->start = (*in)->current = (*in)->func_start = str; |
| (*in)->line = 1; |
| |
| return LY_SUCCESS; |
| } |
| |
| LIBYANG_API_DEF const char * |
| ly_in_memory(struct ly_in *in, const char *str) |
| { |
| const char *data; |
| |
| LY_CHECK_ARG_RET(NULL, in, in->type == LY_IN_MEMORY, NULL); |
| |
| data = in->current; |
| |
| if (str) { |
| in->start = in->current = str; |
| in->line = 1; |
| } |
| |
| return data; |
| } |
| |
| LIBYANG_API_DEF LY_ERR |
| ly_in_new_filepath(const char *filepath, size_t len, struct ly_in **in) |
| { |
| LY_ERR ret; |
| char *fp; |
| int fd; |
| |
| LY_CHECK_ARG_RET(NULL, filepath, in, LY_EINVAL); |
| |
| if (len) { |
| fp = strndup(filepath, len); |
| } else { |
| fp = strdup(filepath); |
| } |
| |
| fd = open(fp, O_RDONLY); |
| LY_CHECK_ERR_RET(fd == -1, LOGERR(NULL, LY_ESYS, "Failed to open file \"%s\" (%s).", fp, strerror(errno)); free(fp), |
| LY_ESYS); |
| |
| LY_CHECK_ERR_RET(ret = ly_in_new_fd(fd, in), free(fp), ret); |
| |
| /* convert the LY_IN_FD input handler into the LY_IN_FILE */ |
| (*in)->type = LY_IN_FILEPATH; |
| (*in)->method.fpath.fd = fd; |
| (*in)->method.fpath.filepath = fp; |
| |
| return LY_SUCCESS; |
| } |
| |
| LIBYANG_API_DEF const char * |
| ly_in_filepath(struct ly_in *in, const char *filepath, size_t len) |
| { |
| int fd, prev_fd; |
| char *fp = NULL; |
| |
| LY_CHECK_ARG_RET(NULL, in, in->type == LY_IN_FILEPATH, filepath ? NULL : ((void *)-1)); |
| |
| if (!filepath) { |
| return in->method.fpath.filepath; |
| } |
| |
| if (len) { |
| fp = strndup(filepath, len); |
| } else { |
| fp = strdup(filepath); |
| } |
| |
| /* replace filepath */ |
| fd = open(fp, O_RDONLY); |
| LY_CHECK_ERR_RET(!fd, LOGERR(NULL, LY_ESYS, "Failed to open file \"%s\" (%s).", fp, strerror(errno)); free(fp), NULL); |
| |
| /* convert LY_IN_FILEPATH handler into LY_IN_FD to be able to update it via ly_in_fd() */ |
| in->type = LY_IN_FD; |
| prev_fd = ly_in_fd(in, fd); |
| LY_CHECK_ERR_RET(prev_fd == -1, in->type = LY_IN_FILEPATH; free(fp), NULL); |
| |
| /* and convert the result back */ |
| in->type = LY_IN_FILEPATH; |
| close(prev_fd); |
| free(in->method.fpath.filepath); |
| in->method.fpath.fd = fd; |
| in->method.fpath.filepath = fp; |
| |
| return NULL; |
| } |
| |
| void |
| lys_parser_fill_filepath(struct ly_ctx *ctx, struct ly_in *in, const char **filepath) |
| { |
| char path[PATH_MAX]; |
| |
| #ifndef __APPLE__ |
| char proc_path[32]; |
| int len; |
| #endif |
| |
| LY_CHECK_ARG_RET(NULL, ctx, in, filepath, ); |
| if (*filepath) { |
| /* filepath already set */ |
| return; |
| } |
| |
| switch (in->type) { |
| case LY_IN_FILEPATH: |
| if (realpath(in->method.fpath.filepath, path) != NULL) { |
| lydict_insert(ctx, path, 0, filepath); |
| } else { |
| lydict_insert(ctx, in->method.fpath.filepath, 0, filepath); |
| } |
| |
| break; |
| case LY_IN_FD: |
| #ifdef __APPLE__ |
| if (fcntl(in->method.fd, F_GETPATH, path) != -1) { |
| lydict_insert(ctx, path, 0, filepath); |
| } |
| #elif defined _WIN32 |
| HANDLE h = _get_osfhandle(in->method.fd); |
| FILE_NAME_INFO info; |
| if (GetFileInformationByHandleEx(h, FileNameInfo, &info, sizeof info)) { |
| char *buf = calloc(info.FileNameLength + 1 /* trailing NULL */, MB_CUR_MAX); |
| len = wcstombs(buf, info.FileName, info.FileNameLength * MB_CUR_MAX); |
| lydict_insert(ctx, buf, len, filepath); |
| } |
| #else |
| /* get URI if there is /proc */ |
| sprintf(proc_path, "/proc/self/fd/%d", in->method.fd); |
| if ((len = readlink(proc_path, path, PATH_MAX - 1)) > 0) { |
| lydict_insert(ctx, path, len, filepath); |
| } |
| #endif |
| break; |
| case LY_IN_MEMORY: |
| case LY_IN_FILE: |
| /* nothing to do */ |
| break; |
| default: |
| LOGINT(ctx); |
| break; |
| } |
| |
| } |
| |
| LIBYANG_API_DEF size_t |
| ly_in_parsed(const struct ly_in *in) |
| { |
| return in->current - in->func_start; |
| } |
| |
| LIBYANG_API_DEF void |
| ly_in_free(struct ly_in *in, ly_bool destroy) |
| { |
| if (!in) { |
| return; |
| } else if (in->type == LY_IN_ERROR) { |
| LOGINT(NULL); |
| return; |
| } |
| |
| if (destroy) { |
| if (in->type == LY_IN_MEMORY) { |
| free((char *)in->start); |
| } else { |
| ly_munmap((char *)in->start, in->length); |
| |
| if (in->type == LY_IN_FILE) { |
| fclose(in->method.f); |
| } else { |
| close(in->method.fd); |
| |
| if (in->type == LY_IN_FILEPATH) { |
| free(in->method.fpath.filepath); |
| } |
| } |
| } |
| } else if (in->type != LY_IN_MEMORY) { |
| ly_munmap((char *)in->start, in->length); |
| |
| if (in->type == LY_IN_FILEPATH) { |
| close(in->method.fpath.fd); |
| free(in->method.fpath.filepath); |
| } |
| } |
| |
| free(in); |
| } |
| |
| LY_ERR |
| ly_in_read(struct ly_in *in, void *buf, size_t count) |
| { |
| if (in->length && (in->length - (in->current - in->start) < count)) { |
| /* EOF */ |
| return LY_EDENIED; |
| } |
| |
| if (count) { |
| memcpy(buf, in->current, count); |
| } |
| in->current += count; |
| return LY_SUCCESS; |
| } |
| |
| LY_ERR |
| ly_in_skip(struct ly_in *in, size_t count) |
| { |
| if (in->length && (in->length - (in->current - in->start) < count)) { |
| /* EOF */ |
| return LY_EDENIED; |
| } |
| |
| in->current += count; |
| return LY_SUCCESS; |
| } |
| |
| void |
| lyd_ctx_free(struct lyd_ctx *lydctx) |
| { |
| ly_set_erase(&lydctx->node_types, NULL); |
| ly_set_erase(&lydctx->meta_types, NULL); |
| ly_set_erase(&lydctx->node_when, NULL); |
| ly_set_erase(&lydctx->ext_val, free); |
| } |
| |
| LY_ERR |
| lyd_parser_find_operation(const struct lyd_node *parent, uint32_t int_opts, struct lyd_node **op) |
| { |
| const struct lyd_node *iter; |
| |
| *op = NULL; |
| |
| if (!parent) { |
| /* no parent, nothing to look for */ |
| return LY_SUCCESS; |
| } |
| |
| /* we need to find the operation node if it already exists */ |
| for (iter = parent; iter; iter = lyd_parent(iter)) { |
| if (iter->schema && (iter->schema->nodetype & (LYS_RPC | LYS_ACTION | LYS_NOTIF))) { |
| break; |
| } |
| } |
| |
| if (!iter) { |
| /* no operation found */ |
| return LY_SUCCESS; |
| } |
| |
| if (!(int_opts & (LYD_INTOPT_RPC | LYD_INTOPT_ACTION | LYD_INTOPT_NOTIF | LYD_INTOPT_REPLY))) { |
| LOGERR(LYD_CTX(parent), LY_EINVAL, "Invalid parent %s \"%s\" node when not parsing any operation.", |
| lys_nodetype2str(iter->schema->nodetype), iter->schema->name); |
| return LY_EINVAL; |
| } else if ((iter->schema->nodetype == LYS_RPC) && !(int_opts & (LYD_INTOPT_RPC | LYD_INTOPT_REPLY))) { |
| LOGERR(LYD_CTX(parent), LY_EINVAL, "Invalid parent RPC \"%s\" node when not parsing RPC nor rpc-reply.", |
| iter->schema->name); |
| return LY_EINVAL; |
| } else if ((iter->schema->nodetype == LYS_ACTION) && !(int_opts & (LYD_INTOPT_ACTION | LYD_INTOPT_REPLY))) { |
| LOGERR(LYD_CTX(parent), LY_EINVAL, "Invalid parent action \"%s\" node when not parsing action nor rpc-reply.", |
| iter->schema->name); |
| return LY_EINVAL; |
| } else if ((iter->schema->nodetype == LYS_NOTIF) && !(int_opts & LYD_INTOPT_NOTIF)) { |
| LOGERR(LYD_CTX(parent), LY_EINVAL, "Invalid parent notification \"%s\" node when not parsing a notification.", |
| iter->schema->name); |
| return LY_EINVAL; |
| } |
| |
| *op = (struct lyd_node *)iter; |
| return LY_SUCCESS; |
| } |
| |
| LY_ERR |
| lyd_parser_check_schema(struct lyd_ctx *lydctx, const struct lysc_node *snode) |
| { |
| LY_ERR rc = LY_SUCCESS; |
| |
| LOG_LOCSET(snode, NULL, NULL, NULL); |
| |
| if (lydctx->int_opts & LYD_INTOPT_ANY) { |
| /* nothing to check, everything is allowed */ |
| goto cleanup; |
| } |
| |
| if ((lydctx->parse_opts & LYD_PARSE_NO_STATE) && (snode->flags & LYS_CONFIG_R)) { |
| LOGVAL(lydctx->data_ctx->ctx, LY_VCODE_UNEXPNODE, "state", snode->name); |
| rc = LY_EVALID; |
| goto cleanup; |
| } |
| |
| if (snode->nodetype == LYS_RPC) { |
| if (lydctx->int_opts & (LYD_INTOPT_RPC | LYD_INTOPT_REPLY)) { |
| if (lydctx->op_node) { |
| goto error_node_dup; |
| } |
| } else { |
| goto error_node_inval; |
| } |
| } else if (snode->nodetype == LYS_ACTION) { |
| if (lydctx->int_opts & (LYD_INTOPT_ACTION | LYD_INTOPT_REPLY)) { |
| if (lydctx->op_node) { |
| goto error_node_dup; |
| } |
| } else { |
| goto error_node_inval; |
| } |
| } else if (snode->nodetype == LYS_NOTIF) { |
| if (lydctx->int_opts & LYD_INTOPT_NOTIF) { |
| if (lydctx->op_node) { |
| goto error_node_dup; |
| } |
| } else { |
| goto error_node_inval; |
| } |
| } |
| |
| /* success */ |
| goto cleanup; |
| |
| error_node_dup: |
| LOGVAL(lydctx->data_ctx->ctx, LYVE_DATA, "Unexpected %s element \"%s\", %s \"%s\" already parsed.", |
| lys_nodetype2str(snode->nodetype), snode->name, lys_nodetype2str(lydctx->op_node->schema->nodetype), |
| lydctx->op_node->schema->name); |
| rc = LY_EVALID; |
| goto cleanup; |
| |
| error_node_inval: |
| LOGVAL(lydctx->data_ctx->ctx, LYVE_DATA, "Unexpected %s element \"%s\".", lys_nodetype2str(snode->nodetype), |
| snode->name); |
| rc = LY_EVALID; |
| |
| cleanup: |
| LOG_LOCBACK(1, 0, 0, 0); |
| return rc; |
| } |
| |
| LY_ERR |
| lyd_parser_create_term(struct lyd_ctx *lydctx, const struct lysc_node *schema, const void *value, size_t value_len, |
| ly_bool *dynamic, LY_VALUE_FORMAT format, void *prefix_data, uint32_t hints, struct lyd_node **node) |
| { |
| ly_bool incomplete; |
| |
| LY_CHECK_RET(lyd_create_term(schema, value, value_len, dynamic, format, prefix_data, hints, &incomplete, node)); |
| |
| if (incomplete && !(lydctx->parse_opts & LYD_PARSE_ONLY)) { |
| LY_CHECK_RET(ly_set_add(&lydctx->node_types, *node, 1, NULL)); |
| } |
| return LY_SUCCESS; |
| } |
| |
| LY_ERR |
| lyd_parser_create_meta(struct lyd_ctx *lydctx, struct lyd_node *parent, struct lyd_meta **meta, const struct lys_module *mod, |
| const char *name, size_t name_len, const void *value, size_t value_len, ly_bool *dynamic, LY_VALUE_FORMAT format, |
| void *prefix_data, uint32_t hints, const struct lysc_node *ctx_node) |
| { |
| ly_bool incomplete; |
| struct lyd_meta *first = NULL; |
| |
| if (meta && *meta) { |
| /* remember the first metadata */ |
| first = *meta; |
| } |
| |
| LY_CHECK_RET(lyd_create_meta(parent, meta, mod, name, name_len, value, value_len, dynamic, format, prefix_data, |
| hints, ctx_node, 0, &incomplete)); |
| |
| if (incomplete && !(lydctx->parse_opts & LYD_PARSE_ONLY)) { |
| LY_CHECK_RET(ly_set_add(&lydctx->meta_types, *meta, 1, NULL)); |
| } |
| |
| if (first) { |
| /* always return the first metadata */ |
| *meta = first; |
| } |
| |
| return LY_SUCCESS; |
| } |