blob: dddebf57becaf0ba12f8b188af5e5f571a6f143c [file] [log] [blame]
Václav Kubernát0d4db442018-07-18 17:18:43 +02001/*
2 * Copyright (C) 2018 CESNET, https://photonics.cesnet.cz/
3 * Copyright (C) 2018 FIT CVUT, https://fit.cvut.cz/
4 *
5 * Written by Václav Kubernát <kubervac@fit.cvut.cz>
6 *
7*/
8
9#include <libyang/Libyang.hpp>
Václav Kubernátc31bd602019-03-07 11:44:48 +010010#include <libyang/Tree_Data.hpp>
Václav Kubernát0d4db442018-07-18 17:18:43 +020011#include <libyang/Tree_Schema.hpp>
12#include <string_view>
Václav Kubernát26b56082020-02-03 18:28:56 +010013#include "UniqueResource.hpp"
Václav Kubernát0d4db442018-07-18 17:18:43 +020014#include "utils.hpp"
15#include "yang_schema.hpp"
16
17class YangLoadError : public std::runtime_error {
18public:
19 using std::runtime_error::runtime_error;
20 ~YangLoadError() override = default;
21};
22
23class UnsupportedYangTypeException : public std::runtime_error {
24public:
25 using std::runtime_error::runtime_error;
26 ~UnsupportedYangTypeException() override = default;
27};
28
29class InvalidSchemaQueryException : public std::runtime_error {
30public:
31 using std::runtime_error::runtime_error;
32 ~InvalidSchemaQueryException() override = default;
33};
34
Václav Kubernát2eaceb82018-10-08 19:56:30 +020035template <typename T>
36std::string pathToYangAbsSchemPath(const T& path)
Václav Kubernát0d4db442018-07-18 17:18:43 +020037{
38 std::string res = "/";
39 std::string currentModule;
40
41 for (const auto& it : path.m_nodes) {
42 const auto name = nodeToSchemaString(it);
43
44 if (it.m_suffix.type() == typeid(module_)) {
45 currentModule = name;
46 continue;
47 } else {
48 res += currentModule + ":";
49 res += name + "/";
50 }
51 }
52
53 return res;
54}
55
56YangSchema::YangSchema()
Václav Kubernáta6c5fff2018-09-07 15:16:25 +020057 : m_context(std::make_shared<libyang::Context>(nullptr, LY_CTX_DISABLE_SEARCHDIRS | LY_CTX_DISABLE_SEARCHDIR_CWD))
Václav Kubernát0d4db442018-07-18 17:18:43 +020058{
Václav Kubernát0d4db442018-07-18 17:18:43 +020059}
60
Václav Kubernát1d50a5b2020-02-03 16:44:22 +010061YangSchema::YangSchema(std::shared_ptr<libyang::Context> lyCtx)
62 : m_context(lyCtx)
63{
64
65}
66
Václav Kubernát0d4db442018-07-18 17:18:43 +020067YangSchema::~YangSchema() = default;
68
69void YangSchema::addSchemaString(const char* schema)
70{
71 if (!m_context->parse_module_mem(schema, LYS_IN_YANG)) {
72 throw YangLoadError("Couldn't load schema");
73 }
74}
75
76void YangSchema::addSchemaDirectory(const char* directoryName)
77{
78 if (m_context->set_searchdir(directoryName)) {
79 throw YangLoadError("Couldn't add schema search directory");
80 }
81}
82
83void YangSchema::addSchemaFile(const char* filename)
84{
85 if (!m_context->parse_module_path(filename, LYS_IN_YANG)) {
86 throw YangLoadError("Couldn't load schema");
87 }
88}
89
Václav Kubernát75877de2019-11-20 17:43:02 +010090bool YangSchema::isModule(const std::string& name) const
Václav Kubernát0d4db442018-07-18 17:18:43 +020091{
92 const auto set = modules();
93 return set.find(name) != set.end();
94}
95
Václav Kubernát2eaceb82018-10-08 19:56:30 +020096bool YangSchema::isContainer(const schemaPath_& location, const ModuleNodePair& node) const
Václav Kubernát0d4db442018-07-18 17:18:43 +020097{
98 const auto schemaNode = getSchemaNode(location, node);
99 return schemaNode && schemaNode->nodetype() == LYS_CONTAINER;
100}
101
Václav Kubernát2eaceb82018-10-08 19:56:30 +0200102bool YangSchema::isLeaf(const schemaPath_& location, const ModuleNodePair& node) const
Václav Kubernát0d4db442018-07-18 17:18:43 +0200103{
104 const auto schemaNode = getSchemaNode(location, node);
105 return schemaNode && schemaNode->nodetype() == LYS_LEAF;
106}
107
Václav Kubernát2eaceb82018-10-08 19:56:30 +0200108bool YangSchema::isList(const schemaPath_& location, const ModuleNodePair& node) const
Václav Kubernát0d4db442018-07-18 17:18:43 +0200109{
110 const auto schemaNode = getSchemaNode(location, node);
111 return schemaNode && schemaNode->nodetype() == LYS_LIST;
112}
113
Václav Kubernát2eaceb82018-10-08 19:56:30 +0200114bool YangSchema::isPresenceContainer(const schemaPath_& location, const ModuleNodePair& node) const
Václav Kubernát0d4db442018-07-18 17:18:43 +0200115{
116 if (!isContainer(location, node))
117 return false;
Jan Kundrát4ed0e9f2018-08-23 16:56:58 +0200118 return libyang::Schema_Node_Container(getSchemaNode(location, node)).presence();
Václav Kubernát0d4db442018-07-18 17:18:43 +0200119}
120
Václav Kubernát2eaceb82018-10-08 19:56:30 +0200121bool YangSchema::leafEnumHasValue(const schemaPath_& location, const ModuleNodePair& node, const std::string& value) const
Václav Kubernát0d4db442018-07-18 17:18:43 +0200122{
Václav Kubernát989b5de2019-02-20 16:28:35 +0100123 auto enums = enumValues(location, node);
124
125 return std::any_of(enums.begin(), enums.end(), [=](const auto& x) { return x == value; });
126}
127
128const std::set<std::string> YangSchema::enumValues(const schemaPath_& location, const ModuleNodePair& node) const
129{
Václav Kubernát0d4db442018-07-18 17:18:43 +0200130 if (!isLeaf(location, node) || leafType(location, node) != yang::LeafDataTypes::Enum)
Václav Kubernát989b5de2019-02-20 16:28:35 +0100131 return {};
Václav Kubernát0d4db442018-07-18 17:18:43 +0200132
Jan Kundrát4ed0e9f2018-08-23 16:56:58 +0200133 libyang::Schema_Node_Leaf leaf(getSchemaNode(location, node));
Václav Kubernát6a713d62018-10-03 18:47:34 +0200134 auto type = leaf.type();
135 auto enm = type->info()->enums()->enm();
136 // The enum can be a derived type and enm() only returns values,
137 // if that specific typedef changed the possible values. So we go
138 // up the hierarchy until we find a typedef that defined these values.
139 while (enm.empty()) {
140 type = type->der()->type();
141 enm = type->info()->enums()->enm();
142 }
Václav Kubernát0d4db442018-07-18 17:18:43 +0200143
Václav Kubernáta38d4172019-11-04 12:36:39 +0100144 std::vector<libyang::S_Type_Enum> enabled;
Václav Kubernát90de9502019-11-20 17:19:44 +0100145 std::copy_if(enm.begin(), enm.end(), std::back_inserter(enabled), [](const libyang::S_Type_Enum& it) {
Václav Kubernáta38d4172019-11-04 12:36:39 +0100146 auto iffeatures = it->iffeature();
Václav Kubernát90de9502019-11-20 17:19:44 +0100147 return std::all_of(iffeatures.begin(), iffeatures.end(), [](auto it) { return it->value(); });
Václav Kubernáta38d4172019-11-04 12:36:39 +0100148 });
149
Václav Kubernát989b5de2019-02-20 16:28:35 +0100150 std::set<std::string> enumSet;
Václav Kubernáta38d4172019-11-04 12:36:39 +0100151 std::transform(enabled.begin(), enabled.end(), std::inserter(enumSet, enumSet.end()), [](auto it) { return it->name(); });
Václav Kubernát989b5de2019-02-20 16:28:35 +0100152 return enumSet;
Václav Kubernát0d4db442018-07-18 17:18:43 +0200153}
154
Václav Kubernáteeb38842019-03-20 19:46:05 +0100155const std::set<std::string> YangSchema::validIdentities(const schemaPath_& location, const ModuleNodePair& node, const Prefixes prefixes) const
156{
157 if (!isLeaf(location, node) || leafType(location, node) != yang::LeafDataTypes::IdentityRef)
158 return {};
159
160 std::set<std::string> identSet;
161
162 auto topLevelModule = location.m_nodes.empty() ? node.first.get() : location.m_nodes.front().m_prefix.get().m_name;
163 auto insertToSet = [&identSet, prefixes, topLevelModule](auto module, auto name) {
164 std::string stringIdent;
165 if (prefixes == Prefixes::Always || topLevelModule != module) {
166 stringIdent += module;
167 stringIdent += ":";
168 }
169 stringIdent += name;
170 identSet.emplace(stringIdent);
171 };
172
173 auto leaf = std::make_shared<libyang::Schema_Node_Leaf>(getSchemaNode(location, node));
174 auto info = leaf->type()->info();
175 for (auto base : info->ident()->ref()) { // Iterate over all bases
176 insertToSet(base->module()->name(), base->name());
177 // Iterate over derived identities (this is recursive!)
178 for (auto derived : base->der()->schema()) {
179 insertToSet(derived->module()->name(), derived->name());
180 }
181 }
182
183 return identSet;
184}
185
186bool YangSchema::leafIdentityIsValid(const schemaPath_& location, const ModuleNodePair& node, const ModuleValuePair& value) const
187{
188 auto identities = validIdentities(location, node, Prefixes::Always);
189
190 auto topLevelModule = location.m_nodes.empty() ? node.first.get() : location.m_nodes.front().m_prefix.get().m_name;
191 auto identModule = value.first ? value.first.value() : topLevelModule;
Václav Kubernát1bf704e2019-04-12 13:30:50 +0200192 return std::any_of(identities.begin(), identities.end(), [toFind = identModule + ":" + value.second](const auto& x) { return x == toFind; });
Václav Kubernáteeb38842019-03-20 19:46:05 +0100193}
194
Václav Kubernát2eaceb82018-10-08 19:56:30 +0200195bool YangSchema::listHasKey(const schemaPath_& location, const ModuleNodePair& node, const std::string& key) const
Václav Kubernát0d4db442018-07-18 17:18:43 +0200196{
197 if (!isList(location, node))
198 return false;
199 const auto keys = listKeys(location, node);
200 return keys.find(key) != keys.end();
201}
202
Václav Kubernát47a3f672019-11-08 15:42:43 +0100203libyang::S_Schema_Node YangSchema::impl_getSchemaNode(const std::string& node) const
Václav Kubernát0d4db442018-07-18 17:18:43 +0200204{
Václav Kubernátf2b91e02019-04-11 15:36:48 +0200205 // If no node is found find_path prints an error message, so we have to
206 // disable logging
207 // https://github.com/CESNET/libyang/issues/753
208 {
209 int oldOptions;
210 auto logBlocker = make_unique_resource(
211 [&oldOptions]() {
212 oldOptions = libyang::set_log_options(0);
213 },
214 [&oldOptions]() {
215 libyang::set_log_options(oldOptions);
216 });
Václav Kubernát47a3f672019-11-08 15:42:43 +0100217 return m_context->get_node(nullptr, node.c_str());
Václav Kubernátf2b91e02019-04-11 15:36:48 +0200218 }
Václav Kubernát0d4db442018-07-18 17:18:43 +0200219}
220
Václav Kubernát47a3f672019-11-08 15:42:43 +0100221
222libyang::S_Schema_Node YangSchema::getSchemaNode(const std::string& node) const
223{
224 return impl_getSchemaNode(node);
225}
226
227libyang::S_Schema_Node YangSchema::getSchemaNode(const schemaPath_& location, const ModuleNodePair& node) const
228{
Václav Kubernátefcac932020-01-10 15:26:32 +0100229 std::string absPath = joinPaths(pathToSchemaString(location, Prefixes::Always), fullNodeName(location, node));
Václav Kubernát47a3f672019-11-08 15:42:43 +0100230
231 return impl_getSchemaNode(absPath);
232}
233
Václav Kubernát2eaceb82018-10-08 19:56:30 +0200234const std::set<std::string> YangSchema::listKeys(const schemaPath_& location, const ModuleNodePair& node) const
Václav Kubernát0d4db442018-07-18 17:18:43 +0200235{
236 std::set<std::string> keys;
237 if (!isList(location, node))
238 return keys;
Jan Kundrát4ed0e9f2018-08-23 16:56:58 +0200239 libyang::Schema_Node_List list(getSchemaNode(location, node));
Jan Kundrát4030b772018-08-23 15:54:56 +0200240 const auto& keysVec = list.keys();
Václav Kubernát0d4db442018-07-18 17:18:43 +0200241
Václav Kubernát90de9502019-11-20 17:19:44 +0100242 std::transform(keysVec.begin(), keysVec.end(), std::inserter(keys, keys.begin()), [](const auto& it) { return it->name(); });
Václav Kubernát0d4db442018-07-18 17:18:43 +0200243 return keys;
244}
245
Václav Kubernát6a8d1d92019-04-24 20:30:36 +0200246yang::LeafDataTypes lyTypeToLeafDataTypes(LY_DATA_TYPE type)
Václav Kubernát0d4db442018-07-18 17:18:43 +0200247{
Václav Kubernát6a8d1d92019-04-24 20:30:36 +0200248 switch (type) {
Václav Kubernát0d4db442018-07-18 17:18:43 +0200249 case LY_TYPE_STRING:
250 return yang::LeafDataTypes::String;
251 case LY_TYPE_DEC64:
252 return yang::LeafDataTypes::Decimal;
253 case LY_TYPE_BOOL:
254 return yang::LeafDataTypes::Bool;
Ivona Oboňová88c78ca2019-07-02 18:40:07 +0200255 case LY_TYPE_INT8:
256 return yang::LeafDataTypes::Int8;
257 case LY_TYPE_INT16:
258 return yang::LeafDataTypes::Int16;
Václav Kubernát0d4db442018-07-18 17:18:43 +0200259 case LY_TYPE_INT32:
Ivona Oboňová88c78ca2019-07-02 18:40:07 +0200260 return yang::LeafDataTypes::Int32;
261 case LY_TYPE_INT64:
262 return yang::LeafDataTypes::Int64;
263 case LY_TYPE_UINT8:
264 return yang::LeafDataTypes::Uint8;
265 case LY_TYPE_UINT16:
266 return yang::LeafDataTypes::Uint16;
Václav Kubernát0d4db442018-07-18 17:18:43 +0200267 case LY_TYPE_UINT32:
Ivona Oboňová88c78ca2019-07-02 18:40:07 +0200268 return yang::LeafDataTypes::Uint32;
269 case LY_TYPE_UINT64:
270 return yang::LeafDataTypes::Uint64;
Václav Kubernát0d4db442018-07-18 17:18:43 +0200271 case LY_TYPE_ENUM:
272 return yang::LeafDataTypes::Enum;
Václav Kubernátab538992019-03-06 15:30:50 +0100273 case LY_TYPE_BINARY:
274 return yang::LeafDataTypes::Binary;
Václav Kubernáteeb38842019-03-20 19:46:05 +0100275 case LY_TYPE_IDENT:
276 return yang::LeafDataTypes::IdentityRef;
Václav Kubernát6a8d1d92019-04-24 20:30:36 +0200277 case LY_TYPE_LEAFREF:
278 return yang::LeafDataTypes::LeafRef;
Václav Kubernát0d4db442018-07-18 17:18:43 +0200279 default:
Václav Kubernát6a8d1d92019-04-24 20:30:36 +0200280 using namespace std::string_literals;
281 throw std::logic_error{"internal error: unsupported libyang data type "s + std::to_string(type)};
282 }
Václav Kubernát6a8d1d92019-04-24 20:30:36 +0200283}
284
285yang::LeafDataTypes YangSchema::leafType(const schemaPath_& location, const ModuleNodePair& node) const
286{
287 using namespace std::string_literals;
288 if (!isLeaf(location, node))
289 throw InvalidSchemaQueryException(fullNodeName(location, node) + " is not a leaf");
290
291 libyang::Schema_Node_Leaf leaf(getSchemaNode(location, node));
292 auto baseType{leaf.type()->base()};
293 try {
294 return lyTypeToLeafDataTypes(baseType);
Václav Kubernát90de9502019-11-20 17:19:44 +0100295 } catch (std::logic_error& ex) {
Václav Kubernát6a8d1d92019-04-24 20:30:36 +0200296 throw UnsupportedYangTypeException("the type of "s + fullNodeName(location, node) + " is not supported: " + ex.what());
297 }
298}
299
Václav Kubernát90de9502019-11-20 17:19:44 +0100300yang::LeafDataTypes YangSchema::leafrefBase(const schemaPath_& location, const ModuleNodePair& node) const
Václav Kubernát6a8d1d92019-04-24 20:30:36 +0200301{
302 using namespace std::string_literals;
303 libyang::Schema_Node_Leaf leaf(getSchemaNode(location, node));
304 try {
305 return lyTypeToLeafDataTypes(leaf.type()->info()->lref()->target()->type()->base());
Václav Kubernát90de9502019-11-20 17:19:44 +0100306 } catch (std::logic_error& ex) {
Václav Kubernát6a8d1d92019-04-24 20:30:36 +0200307 throw UnsupportedYangTypeException("the type of "s + fullNodeName(location, node) + " is not supported: " + ex.what());
Václav Kubernát0d4db442018-07-18 17:18:43 +0200308 }
309}
310
311std::set<std::string> YangSchema::modules() const
312{
Jan Kundrát4030b772018-08-23 15:54:56 +0200313 const auto& modules = m_context->get_module_iter();
Václav Kubernát0d4db442018-07-18 17:18:43 +0200314
315 std::set<std::string> res;
Václav Kubernát90de9502019-11-20 17:19:44 +0100316 std::transform(modules.begin(), modules.end(), std::inserter(res, res.end()), [](const auto module) { return module->name(); });
Václav Kubernát0d4db442018-07-18 17:18:43 +0200317 return res;
318}
319
Václav Kubernát2eaceb82018-10-08 19:56:30 +0200320std::set<std::string> YangSchema::childNodes(const schemaPath_& path, const Recursion recursion) const
Václav Kubernát0d4db442018-07-18 17:18:43 +0200321{
322 using namespace std::string_view_literals;
323 std::set<std::string> res;
Václav Kubernáte7d4aea2018-09-11 18:15:48 +0200324 std::vector<libyang::S_Schema_Node> nodes;
325
Václav Kubernát0d4db442018-07-18 17:18:43 +0200326 if (path.m_nodes.empty()) {
Václav Kubernáte7d4aea2018-09-11 18:15:48 +0200327 nodes = m_context->data_instantiables(0);
Václav Kubernát0d4db442018-07-18 17:18:43 +0200328 } else {
Václav Kubernátefcac932020-01-10 15:26:32 +0100329 const auto pathString = pathToSchemaString(path, Prefixes::Always);
330 const auto node = getSchemaNode(pathString);
Václav Kubernát47a3f672019-11-08 15:42:43 +0100331 nodes = node->child_instantiables(0);
Václav Kubernát0d4db442018-07-18 17:18:43 +0200332 }
Václav Kubernáte7d4aea2018-09-11 18:15:48 +0200333
334 for (const auto node : nodes) {
335 if (node->module()->name() == "ietf-yang-library"sv)
Václav Kubernát89728d82018-09-13 16:28:28 +0200336 continue;
Václav Kubernáte7d4aea2018-09-11 18:15:48 +0200337 if (recursion == Recursion::Recursive) {
338 for (auto it : node->tree_dfs()) {
339 res.insert(it->path(LYS_PATH_FIRST_PREFIX));
340 }
341 } else {
Václav Kubernát4f77a252019-02-19 16:51:30 +0100342 std::string toInsert;
343 if (path.m_nodes.empty() || path.m_nodes.front().m_prefix.get().m_name != node->module()->name()) {
344 toInsert += node->module()->name();
345 toInsert += ":";
346 }
347 toInsert += node->name();
348 res.insert(toInsert);
Václav Kubernáte7d4aea2018-09-11 18:15:48 +0200349 }
350 }
351
Václav Kubernát0d4db442018-07-18 17:18:43 +0200352 return res;
353}
Václav Kubernáta6c5fff2018-09-07 15:16:25 +0200354
Václav Kubernát9456b5c2019-10-02 21:14:52 +0200355std::set<std::string> YangSchema::moduleNodes(const module_& module, const Recursion recursion) const
356{
357 std::set<std::string> res;
358 const auto yangModule = m_context->get_module(module.m_name.c_str());
359
360 std::vector<libyang::S_Schema_Node> nodes;
361
362 for (const auto node : yangModule->data_instantiables(0)) {
363 if (recursion == Recursion::Recursive) {
364 for (const auto it : node->tree_dfs()) {
365 res.insert(it->path(LYS_PATH_FIRST_PREFIX));
366 }
367 } else {
368 res.insert(module.m_name + ":" + node->name());
369 }
370 }
371
372 return res;
373}
374
Václav Kubernáta6c5fff2018-09-07 15:16:25 +0200375void YangSchema::loadModule(const std::string& moduleName)
376{
377 m_context->load_module(moduleName.c_str());
378}
379
Václav Kubernátbf9c6112019-11-04 16:03:35 +0100380void YangSchema::enableFeature(const std::string& moduleName, const std::string& featureName)
381{
382 m_context->get_module(moduleName.c_str())->feature_enable(featureName.c_str());
383}
384
Václav Kubernátb52dc252019-12-04 13:03:39 +0100385void YangSchema::registerModuleCallback(const std::function<std::string(const char*, const char*, const char*, const char*)>& clb)
Václav Kubernáta6c5fff2018-09-07 15:16:25 +0200386{
387 auto lambda = [clb](const char* mod_name, const char* mod_revision, const char* submod_name, const char* submod_revision) {
388 (void)submod_revision;
Václav Kubernátb52dc252019-12-04 13:03:39 +0100389 auto moduleSource = clb(mod_name, mod_revision, submod_name, submod_revision);
Václav Kubernáta6c5fff2018-09-07 15:16:25 +0200390 if (moduleSource.empty()) {
391 return libyang::Context::mod_missing_cb_return{LYS_IN_YANG, nullptr};
392 }
393 return libyang::Context::mod_missing_cb_return{LYS_IN_YANG, strdup(moduleSource.c_str())};
394 };
395
396 auto deleter = [](void* data) {
397 free(data);
398 };
399 m_context->add_missing_module_callback(lambda, deleter);
400}
Václav Kubernátc31bd602019-03-07 11:44:48 +0100401
402std::shared_ptr<libyang::Data_Node> YangSchema::dataNodeFromPath(const std::string& path, const std::optional<const std::string> value) const
403{
404 return std::make_shared<libyang::Data_Node>(m_context,
405 path.c_str(),
406 value ? value.value().c_str() : nullptr,
407 LYD_ANYDATA_CONSTSTRING,
Václav Kubernátab612e92019-11-26 19:51:31 +0100408 LYD_PATH_OPT_EDIT);
Václav Kubernátc31bd602019-03-07 11:44:48 +0100409}
410
411std::shared_ptr<libyang::Module> YangSchema::getYangModule(const std::string& name)
412{
413 return m_context->get_module(name.c_str(), nullptr, 0);
414}