blob: 62af700873b806eda2c2703c4a13d5c5a2aaa8f5 [file] [log] [blame]
Radek Krejci0af5f5d2018-09-07 15:00:30 +02001/**
2 * @file context.c
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief Context implementations
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
Radek Krejci7ada9a02018-09-07 15:34:05 +020015#define _DEFAULT_SOURCE
16#define _BSD_SOURCE
Radek Krejci0af5f5d2018-09-07 15:00:30 +020017#include <errno.h>
Radek Krejci7ada9a02018-09-07 15:34:05 +020018#include <limits.h>
19#include <stdlib.h>
20#include <string.h>
Radek Krejci0e212402018-09-20 11:29:38 +020021#include <sys/stat.h>
22#include <sys/types.h>
Radek Krejci0af5f5d2018-09-07 15:00:30 +020023#include <unistd.h>
24
Radek Krejci0af5f5d2018-09-07 15:00:30 +020025#include "context.h"
Radek Krejciad573502018-09-07 15:26:55 +020026#include "common.h"
27
28#include "libyang.h"
Radek Krejci0af5f5d2018-09-07 15:00:30 +020029
30#define LY_INTERNAL_MODS_COUNT 0 /* TODO 6 when parser available */
31
32#define IETF_YANG_METADATA_PATH "../models/ietf-yang-metadata@2016-08-05.h"
33#define YANG_PATH "../models/yang@2017-02-20.h"
34#define IETF_INET_TYPES_PATH "../models/ietf-inet-types@2013-07-15.h"
35#define IETF_YANG_TYPES_PATH "../models/ietf-yang-types@2013-07-15.h"
36#define IETF_DATASTORES "../models/ietf-datastores@2017-08-17.h"
37#define IETF_YANG_LIB_PATH "../models/ietf-yang-library@2018-01-17.h"
38#define IETF_YANG_LIB_REV "2018-01-17"
39
40#if LY_INTERNAL_MODS_COUNT
41#include IETF_YANG_METADATA_PATH
42#include YANG_PATH
43#include IETF_INET_TYPES_PATH
44#include IETF_YANG_TYPES_PATH
45#include IETF_DATASTORES
46#include IETF_YANG_LIB_PATH
Radek Krejci0af5f5d2018-09-07 15:00:30 +020047
48static struct internal_modules_s {
49 const char *name;
50 const char *revision;
51 const char *data;
52 uint8_t implemented;
53 LYS_INFORMAT format;
54} internal_modules[LY_INTERNAL_MODS_COUNT] = {
Radek Krejci0af5f5d2018-09-07 15:00:30 +020055 {"ietf-yang-metadata", "2016-08-05", (const char*)ietf_yang_metadata_2016_08_05_yin, 0, LYS_IN_YIN},
56 {"yang", "2017-02-20", (const char*)yang_2017_02_20_yin, 1, LYS_IN_YIN},
57 {"ietf-inet-types", "2013-07-15", (const char*)ietf_inet_types_2013_07_15_yin, 0, LYS_IN_YIN},
58 {"ietf-yang-types", "2013-07-15", (const char*)ietf_yang_types_2013_07_15_yin, 0, LYS_IN_YIN},
59 /* ietf-datastores and ietf-yang-library must be right here at the end of the list! */
60 {"ietf-datastores", "2017-08-17", (const char*)ietf_datastores_2017_08_17_yin, 0, LYS_IN_YIN},
61 {"ietf-yang-library", IETF_YANG_LIB_REV, (const char*)ietf_yang_library_2018_01_17_yin, 1, LYS_IN_YIN}
Radek Krejci0af5f5d2018-09-07 15:00:30 +020062};
Radek Krejciad573502018-09-07 15:26:55 +020063#endif
Radek Krejci0af5f5d2018-09-07 15:00:30 +020064
65API LY_ERR
66ly_ctx_set_searchdir(struct ly_ctx *ctx, const char *search_dir)
67{
Radek Krejci0e212402018-09-20 11:29:38 +020068 struct stat st;
Radek Krejci0af5f5d2018-09-07 15:00:30 +020069 char *new_dir = NULL;
70 LY_ERR rc = LY_ESYS;
Radek Krejci0e212402018-09-20 11:29:38 +020071 unsigned int u;
Radek Krejci0af5f5d2018-09-07 15:00:30 +020072
73 LY_CHECK_ARG_RET(ctx, ctx, LY_EINVAL);
74
75 if (search_dir) {
Radek Krejci0e212402018-09-20 11:29:38 +020076 LY_CHECK_ERR_RET(access(search_dir, R_OK | X_OK),
77 LOGERR(ctx, LY_ESYS, "Unable to use search directory \"%s\" (%s)", search_dir, strerror(errno)),
78 LY_EINVAL);
79 LY_CHECK_ERR_RET(stat(search_dir, &st),
80 LOGERR(ctx, LY_ESYS, "stat() failed for \"%s\" (%s)", search_dir, strerror(errno)),
81 LY_ESYS);
82 LY_CHECK_ERR_RET(!S_ISDIR(st.st_mode),
83 LOGERR(ctx, LY_ESYS, "Given search directory \"%s\" is not a directory.", search_dir),
84 LY_EINVAL);
Radek Krejci0af5f5d2018-09-07 15:00:30 +020085 new_dir = realpath(search_dir, NULL);
86 LY_CHECK_ERR_GOTO(!new_dir,
87 LOGERR(ctx, LY_ESYS, "realpath() call failed for \"%s\" (%s).", search_dir, strerror(errno)),
88 cleanup);
Radek Krejci0e212402018-09-20 11:29:38 +020089 /* avoid path duplication */
90 for (u = 0; u < ctx->search_paths.count; ++u) {
91 if (!strcmp(new_dir, ctx->search_paths.objs[0])) {
92 free(new_dir);
93 return LY_SUCCESS;
94 }
95 }
96 if (ly_set_add(&ctx->search_paths, new_dir, LY_SET_OPT_USEASLIST) == -1) {
Radek Krejci0af5f5d2018-09-07 15:00:30 +020097 free(new_dir);
98 return LY_EMEM;
99 }
100
Radek Krejci0e212402018-09-20 11:29:38 +0200101 return LY_SUCCESS;
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200102 } else {
103 /* consider that no change is not actually an error */
104 return LY_SUCCESS;
105 }
106
107cleanup:
108 free(new_dir);
109 return rc;
110}
111
112API const char * const *
113ly_ctx_get_searchdirs(const struct ly_ctx *ctx)
114{
115 LY_CHECK_ARG_RET(ctx, ctx, NULL);
116 return (const char * const *)ctx->search_paths.objs;
117}
118
119API LY_ERR
120ly_ctx_unset_searchdirs(struct ly_ctx *ctx, int index)
121{
Michal Vaskob34480a2018-09-17 10:34:45 +0200122 if (!ctx->search_paths.count) {
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200123 return LY_SUCCESS;
124 }
125
126 if (index >= 0) {
127 /* remove specific search directory */
Radek Krejciad573502018-09-07 15:26:55 +0200128 return ly_set_rm_index(&ctx->search_paths, index);
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200129 } else {
130 /* remove them all */
Radek Krejcia40f21b2018-09-18 10:42:08 +0200131 ly_set_erase(&ctx->search_paths, free);
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200132 memset(&ctx->search_paths, 0, sizeof ctx->search_paths);
133 }
134
135 return LY_SUCCESS;
136}
137
138API LY_ERR
139ly_ctx_new(const char *search_dir, int options, struct ly_ctx **new_ctx)
140{
141 struct ly_ctx *ctx = NULL;
142 struct lys_module *module;
143 char *search_dir_list;
144 char *sep, *dir;
145 LY_ERR rc = LY_SUCCESS;
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200146
147 ctx = calloc(1, sizeof *ctx);
Radek Krejciad573502018-09-07 15:26:55 +0200148 LY_CHECK_ERR_RET(!ctx, LOGMEM(NULL), LY_EMEM);
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200149
150 /* dictionary */
151 lydict_init(&ctx->dict);
152
Radek Krejciad573502018-09-07 15:26:55 +0200153#if 0 /* TODO when plugins implemented */
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200154 /* plugins */
155 ly_load_plugins();
Radek Krejciad573502018-09-07 15:26:55 +0200156#endif
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200157
158 /* initialize thread-specific key */
Radek Krejciad573502018-09-07 15:26:55 +0200159 while ((pthread_key_create(&ctx->errlist_key, ly_err_free)) == EAGAIN);
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200160
161 /* models list */
162 ctx->flags = options;
163 if (search_dir) {
164 search_dir_list = strdup(search_dir);
165 LY_CHECK_ERR_GOTO(!search_dir_list, LOGMEM(NULL); rc = LY_EMEM, error);
166
167 for (dir = search_dir_list; (sep = strchr(dir, ':')) != NULL && rc == LY_SUCCESS; dir = sep + 1) {
168 *sep = 0;
169 rc = ly_ctx_set_searchdir(ctx, dir);
170 }
171 if (*dir && rc == LY_SUCCESS) {
172 rc = ly_ctx_set_searchdir(ctx, dir);
173 }
174 free(search_dir_list);
175
176 /* If ly_ctx_set_searchdir() failed, the error is already logged. Just exit */
177 if (rc != LY_SUCCESS) {
178 goto error;
179 }
180 }
181 ctx->module_set_id = 1;
182
Radek Krejciad573502018-09-07 15:26:55 +0200183#if 0 /* TODO when parser implemented */
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200184 /* load internal modules */
185 for (i = 0; i < (options & LY_CTX_NOYANGLIBRARY) ? LY_INTERNAL_MODS_COUNT - 2 : LY_INTERNAL_MODS_COUNT; i++) {
186 module = (struct lys_module *)lys_parse_mem(ctx, internal_modules[i].data, internal_modules[i].format);
187 LY_CHECK_GOTO(!module, error);
188 module->parsed->implemented = internal_modules[i].implemented;
189 }
Radek Krejciad573502018-09-07 15:26:55 +0200190#endif
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200191
192 *new_ctx = ctx;
193 return rc;
194
195error:
196 ly_ctx_destroy(ctx, NULL);
197 return rc;
198}
199
200API void
201ly_ctx_set_disable_searchdirs(struct ly_ctx *ctx)
202{
203 LY_CHECK_ARG_RET(ctx, ctx,);
204 ctx->flags |= LY_CTX_DISABLE_SEARCHDIRS;
205}
206
207API void
208ly_ctx_unset_disable_searchdirs(struct ly_ctx *ctx)
209{
210 LY_CHECK_ARG_RET(ctx, ctx,);
211 ctx->flags &= ~LY_CTX_DISABLE_SEARCHDIRS;
212}
213
214API void
215ly_ctx_set_disable_searchdir_cwd(struct ly_ctx *ctx)
216{
217 LY_CHECK_ARG_RET(ctx, ctx,);
218 ctx->flags |= LY_CTX_DISABLE_SEARCHDIR_CWD;
219}
220
221API void
222ly_ctx_unset_disable_searchdir_cwd(struct ly_ctx *ctx)
223{
224 LY_CHECK_ARG_RET(ctx, ctx,);
225 ctx->flags &= ~LY_CTX_DISABLE_SEARCHDIR_CWD;
226}
227
228API void
229ly_ctx_set_prefer_searchdirs(struct ly_ctx *ctx)
230{
231 LY_CHECK_ARG_RET(ctx, ctx,);
232 ctx->flags |= LY_CTX_PREFER_SEARCHDIRS;
233}
234
235API void
236ly_ctx_unset_prefer_searchdirs(struct ly_ctx *ctx)
237{
238 LY_CHECK_ARG_RET(ctx, ctx,);
239 ctx->flags &= ~LY_CTX_PREFER_SEARCHDIRS;
240}
241
242API void
243ly_ctx_set_allimplemented(struct ly_ctx *ctx)
244{
245 LY_CHECK_ARG_RET(ctx, ctx,);
246 ctx->flags |= LY_CTX_ALLIMPLEMENTED;
247}
248
249API void
250ly_ctx_unset_allimplemented(struct ly_ctx *ctx)
251{
252 LY_CHECK_ARG_RET(ctx, ctx,);
253 ctx->flags &= ~LY_CTX_ALLIMPLEMENTED;
254}
255
256API void
257ly_ctx_set_trusted(struct ly_ctx *ctx)
258{
259 LY_CHECK_ARG_RET(ctx, ctx,);
260 ctx->flags |= LY_CTX_TRUSTED;
261}
262
263API void
264ly_ctx_unset_trusted(struct ly_ctx *ctx)
265{
266 LY_CHECK_ARG_RET(ctx, ctx,);
267 ctx->flags &= ~LY_CTX_TRUSTED;
268}
269
270API int
271ly_ctx_get_options(struct ly_ctx *ctx)
272{
273 return ctx->flags;
274}
275
276API uint16_t
277ly_ctx_get_module_set_id(const struct ly_ctx *ctx)
278{
279 return ctx->module_set_id;
280}
281
282API void
Radek Krejciad573502018-09-07 15:26:55 +0200283ly_ctx_destroy(struct ly_ctx *ctx, void (*private_destructor)(const struct lysc_node *node, void *priv))
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200284{
285 LY_CHECK_ARG_RET(ctx, ctx,);
286
287 /* models list */
Michal Vaskob34480a2018-09-17 10:34:45 +0200288 for (; ctx->list.count; ctx->list.count--) {
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200289 /* remove the module */
290#if 0 /* TODO when parser implemented */
Michal Vaskob34480a2018-09-17 10:34:45 +0200291 lys_free(ctx->list[ctx->list.count - 1], private_destructor, 1, 0);
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200292#endif
293 }
294 free(ctx->list.objs);
295
296 /* search paths list */
Radek Krejcia40f21b2018-09-18 10:42:08 +0200297 ly_set_erase(&ctx->search_paths, free);
Radek Krejci0af5f5d2018-09-07 15:00:30 +0200298
299 /* clean the error list */
300 ly_err_clean(ctx, 0);
301 pthread_key_delete(ctx->errlist_key);
302
303 /* dictionary */
304 lydict_clean(&ctx->dict);
305
306#if 0 /* TODO when plugins implemented */
307 /* plugins - will be removed only if this is the last context */
308 ly_clean_plugins();
309#endif
310
311 free(ctx);
312}