diff options
| author | John Estabrook <jestabro@vyos.io> | 2025-09-10 08:15:29 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-09-10 08:15:29 -0500 |
| commit | d11434953bb62c52405f28771e7325b68db15684 (patch) | |
| tree | 024bd78a1bd379cb6718b4cd2e4753373aeeb301 | |
| parent | 41eae8e050fc9afeec7c645ee33da8fdb342056c (diff) | |
| parent | 6ad118257738883010559012f54b18412f5f0195 (diff) | |
| download | vyos-1x-d11434953bb62c52405f28771e7325b68db15684.tar.gz vyos-1x-d11434953bb62c52405f28771e7325b68db15684.zip | |
Merge pull request #4703 from c-po/integrate-libvyosconfig
T7793: Integrate libvyosconfig repository into vyos-1x
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | .gitmodules | 4 | ||||
| -rw-r--r-- | Makefile | 26 | ||||
| -rw-r--r-- | debian/control | 10 | ||||
| -rw-r--r-- | debian/libvyosconfig0.install | 2 | ||||
| -rw-r--r-- | debian/libvyosconfig0.links | 5 | ||||
| -rw-r--r-- | debian/libvyosconfig0.postinst | 3 | ||||
| -rwxr-xr-x | debian/rules | 31 | ||||
| m--------- | libvyosconfig | 26 | ||||
| -rw-r--r-- | libvyosconfig/.gitignore | 1 | ||||
| -rw-r--r-- | libvyosconfig/LICENSE | 505 | ||||
| -rw-r--r-- | libvyosconfig/Makefile | 84 | ||||
| -rw-r--r-- | libvyosconfig/README.md | 27 | ||||
| -rw-r--r-- | libvyosconfig/lib/apply_bindings.ml | 3 | ||||
| -rw-r--r-- | libvyosconfig/lib/bindings.ml | 338 | ||||
| -rw-r--r-- | libvyosconfig/stub/init.c | 9 | ||||
| -rw-r--r-- | libvyosconfig/stub_generator/generate.ml | 30 |
17 files changed, 1052 insertions, 53 deletions
diff --git a/.gitignore b/.gitignore index ed0f4eead..c277fd29c 100644 --- a/.gitignore +++ b/.gitignore @@ -115,6 +115,7 @@ debian/files debian/tmp debian/debhelper-build-stamp debian/.debhelper/ +debian/libvyosconfig0 debian/vyos-1x debian/vyos-1x-vmware debian/vyos-1x-smoketest diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 05eaf619f..000000000 --- a/.gitmodules +++ /dev/null @@ -1,4 +0,0 @@ -[submodule "libvyosconfig"] - path = libvyosconfig - url = ../../vyos/libvyosconfig - branch = current @@ -7,34 +7,28 @@ LIBS := -lzmq CFLAGS := BUILD_ARCH := $(shell dpkg-architecture -q DEB_BUILD_ARCH) J2LINT := $(shell command -v j2lint 2> /dev/null) -LIBVYOSCONFIG_BUILD_PATH := /tmp/libvyosconfig/_build/libvyosconfig.so -LIBVYOSCONFIG_STATUS := $(shell git submodule status) config_xml_src = $(wildcard interface-definitions/*.xml.in) config_xml_obj = $(config_xml_src:.xml.in=.xml) op_xml_src = $(wildcard op-mode-definitions/*.xml.in) op_xml_obj = $(op_xml_src:.xml.in=.xml) +.PHONY: libvyosconfig +libvyosconfig: + @if [ ! -f /usr/lib/libvyosconfig.so.0 ]; then \ + make -C libvyosconfig clean ; \ + make -C libvyosconfig all ; \ + sudo make -C libvyosconfig install ; \ + fi + %.xml: %.xml.in @echo Generating $(BUILD_DIR)/$@ from $< mkdir -p $(BUILD_DIR)/$(dir $@) $(CURDIR)/scripts/transclude-template $< > $(BUILD_DIR)/$@ -.PHONY: libvyosconfig -.ONESHELL: -libvyosconfig: - if test ! -f $(LIBVYOSCONFIG_BUILD_PATH); then - if ! echo $(firstword $(LIBVYOSCONFIG_STATUS))|grep -Eq '^[a-z0-9]'; then - git submodule sync; git submodule update --init --remote - fi - rm -rf /tmp/libvyosconfig && mkdir /tmp/libvyosconfig - cp -r libvyosconfig /tmp && cd /tmp/libvyosconfig && \ - eval $$(opam env --root=/opt/opam --set-root) && ./build.sh || exit 1 - fi - .PHONY: interface_definitions .ONESHELL: -interface_definitions: $(config_xml_obj) libvyosconfig +interface_definitions: $(config_xml_obj) mkdir -p $(TMPL_DIR) $(CURDIR)/scripts/override-default $(BUILD_DIR)/interface-definitions @@ -88,7 +82,7 @@ vyshim: $(MAKE) -C $(SHIM_DIR) .PHONY: all -all: clean copyright pylint libvyosconfig interface_definitions op_mode_definitions test j2lint vyshim generate-configd-include-json +all: clean copyright libvyosconfig pylint interface_definitions op_mode_definitions test j2lint vyshim generate-configd-include-json .PHONY: copyright copyright: diff --git a/debian/control b/debian/control index 1d152c18b..e36e20ebe 100644 --- a/debian/control +++ b/debian/control @@ -10,6 +10,9 @@ Build-Depends: iproute2, libzmq3-dev, python3 (>= 3.10), +# For libvyosconfig + libpcre2-dev, + libffi-dev, # For QA/Lint pylint, python3-vici (>= 5.7.2), @@ -392,6 +395,13 @@ Depends: Description: VyOS configuration scripts and data VyOS configuration scripts, interface definitions, and everything +Package: libvyosconfig0 +Architecture: any +Depends: ${shlibs:Depends}, + ${misc:Depends} +Description: VyConf config tree manipulation library + VyConf config tree parsing and manipulation library + Package: vyos-1x-aws Architecture: all Depends: diff --git a/debian/libvyosconfig0.install b/debian/libvyosconfig0.install new file mode 100644 index 000000000..db337b486 --- /dev/null +++ b/debian/libvyosconfig0.install @@ -0,0 +1,2 @@ +libvyosconfig/usr/* /usr +libvyosconfig/etc/* /etc diff --git a/debian/libvyosconfig0.links b/debian/libvyosconfig0.links new file mode 100644 index 000000000..b511a1ff4 --- /dev/null +++ b/debian/libvyosconfig0.links @@ -0,0 +1,5 @@ +/usr/libexec/vyos/vyconf/vyconf_cli /usr/libexec/vyos/vyconf/bin/vy_set +/usr/libexec/vyos/vyconf/vyconf_cli /usr/libexec/vyos/vyconf/bin/vy_delete +/usr/libexec/vyos/vyconf/vyconf_cli /usr/libexec/vyos/vyconf/bin/vy_discard +/usr/libexec/vyos/vyconf/vyconf_cli /usr/libexec/vyos/vyconf/bin/vy_show +/usr/libexec/vyos/vyconf/vyconf_cli /usr/libexec/vyos/vyconf/bin/vy_session_changed diff --git a/debian/libvyosconfig0.postinst b/debian/libvyosconfig0.postinst new file mode 100644 index 000000000..93efa1c89 --- /dev/null +++ b/debian/libvyosconfig0.postinst @@ -0,0 +1,3 @@ +ldconfig +chown -R root:vyattacfg /usr/libexec/vyos/vyconf/session +chmod -R 775 /usr/libexec/vyos/vyconf/session diff --git a/debian/rules b/debian/rules index 83091a88a..2cb32b839 100755 --- a/debian/rules +++ b/debian/rules @@ -2,16 +2,26 @@ DIR := debian/tmp DIR_AWS := $(DIR)/vyos-1x-aws +DIR_LIBVYOSCONFIG := $(DIR)/libvyosconfig VYOS_SBIN_DIR := usr/sbin VYOS_BIN_DIR := usr/bin +VYOS_LIB_DIR := usr/lib VYOS_LIBEXEC_DIR := usr/libexec/vyos VYOS_DATA_DIR := usr/share/vyos VYOS_CFG_TMPL_DIR := opt/vyatta/share/vyatta-cfg/templates VYOS_OP_TMPL_DIR := opt/vyatta/share/vyatta-op/templates VYOS_MIBS_DIR := usr/share/snmp/mibs VYOS_LOCALUI_DIR := srv/localui + +VYCONF := usr/libexec/vyos/vyconf +VYCONF_CONF := $(VYCONF)/config +VYCONF_SESSION := $(VYCONF)/session +VYCONF_DATA := usr/share/vyos/vyconf +VYCONF_DEF := etc/vyos VYCONF_REFTREE_DIR := $(VYOS_LIBEXEC_DIR)/vyconf/reftree +OCAML_DIR := /opt/opam/${OCAML_VERSION} + MIGRATION_SCRIPTS_DIR := opt/vyatta/etc/config-migrate/migrate ACTIVATION_SCRIPTS_DIR := usr/libexec/vyos/activate SYSTEM_SCRIPTS_DIR := usr/libexec/vyos/system @@ -19,12 +29,6 @@ SERVICES_DIR := usr/libexec/vyos/services DEB_TARGET_ARCH := $(shell dpkg-architecture -qDEB_TARGET_ARCH) -# Base version prefix from debian/changelog -BASE_VERSION := 999.0 -COMMIT_ID := $(shell echo -n g && git rev-parse --short HEAD) -COMMIT_COUNT := $(shell git rev-list HEAD --count) -DIRTY_FLAG := $(shell ! git diff --quiet || ! git diff --cached --quiet && echo -dirty || echo) - %: dh $@ --with python3, --with quilt @@ -33,7 +37,7 @@ DIRTY_FLAG := $(shell ! git diff --quiet || ! git diff --cached --quiet && echo override_dh_strip_nondeterminism: override_dh_gencontrol: - dh_gencontrol -- -v$(BASE_VERSION)-$(COMMIT_COUNT)-$(COMMIT_ID)$(DIRTY_FLAG) + dh_gencontrol -- -v$(shell (git describe --tags --long --match 'vyos/*' --match '1.4.*' --dirty 2>/dev/null || echo 0.0-no.git.tag) | sed -E 's%vyos/%%' | sed -E 's%-dirty%+dirty%') override_dh_auto_build: make all @@ -168,6 +172,19 @@ override_dh_auto_install: mkdir -p $(DIR_AWS)/usr/share/vyos/templates mv $(DIR)/usr/share/vyos/templates/aws/ $(DIR_AWS)/usr/share/vyos/templates + # libvyosconfig package + mkdir -p $(DIR_LIBVYOSCONFIG)/$(VYOS_LIB_DIR) + mkdir -p $(DIR_LIBVYOSCONFIG)/$(VYCONF_CONF) + mkdir -p $(DIR_LIBVYOSCONFIG)/$(VYCONF_SESSION) + mkdir -p $(DIR_LIBVYOSCONFIG)/$(VYCONF_DATA) + mkdir -p $(DIR_LIBVYOSCONFIG)/$(VYCONF_DEF) + + cp $(OCAML_DIR)/share/vyconf/vyconf.proto $(DIR_LIBVYOSCONFIG)/$(VYCONF_DATA) + cp $(OCAML_DIR)/share/vyconf/vyconfd.conf $(DIR_LIBVYOSCONFIG)/$(VYCONF_DEF) + cp $(OCAML_DIR)/bin/vyconfd $(DIR_LIBVYOSCONFIG)/$(VYCONF) + cp $(OCAML_DIR)/bin/vyconf_cli $(DIR_LIBVYOSCONFIG)/$(VYCONF) + cp libvyosconfig/_build/libvyosconfig.so $(DIR_LIBVYOSCONFIG)/$(VYOS_LIB_DIR)/libvyosconfig.so.0 + override_dh_installsystemd: dh_installsystemd -pvyos-1x --name vyos-router vyos-router.service dh_installsystemd -pvyos-1x --name vyos vyos.target diff --git a/libvyosconfig b/libvyosconfig deleted file mode 160000 -Subproject 08d29aba337bbe8c5da876fa8d6f362b943d680 diff --git a/libvyosconfig/.gitignore b/libvyosconfig/.gitignore new file mode 100644 index 000000000..88f9974bd --- /dev/null +++ b/libvyosconfig/.gitignore @@ -0,0 +1 @@ +_build/* diff --git a/libvyosconfig/LICENSE b/libvyosconfig/LICENSE new file mode 100644 index 000000000..40c8ae627 --- /dev/null +++ b/libvyosconfig/LICENSE @@ -0,0 +1,505 @@ +GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +(This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.) + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random + Hacker. + + {signature of Ty Coon}, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + diff --git a/libvyosconfig/Makefile b/libvyosconfig/Makefile new file mode 100644 index 000000000..8006db1ad --- /dev/null +++ b/libvyosconfig/Makefile @@ -0,0 +1,84 @@ +BUILDDIR=_build +VPATH=$(BUILDDIR) +OCAMLDIR=$(shell eval $$(opam env --root=/opt/opam --set-root); ocamlopt -where) +$(shell mkdir -p $(BUILDDIR) $(BUILDDIR)/stub $(BUILDDIR)/lib $(BUILDDIR)/stub_generator $(BUILDDIR)/test $(BUILDDIR)/generated) +PACKAGES=vyos1x-config,vyconf.vyconfd-config,vyconf.vycall-client,re,ctypes.stubs,ctypes.foreign + +GENERATOR_FILES=$(BUILDDIR)/lib/bindings.cmx \ + $(BUILDDIR)/stub_generator/generate.cmx + +LIBFILES=$(BUILDDIR)/lib/bindings.cmx \ + $(BUILDDIR)/generated/vyosconfig_bindings.cmx \ + $(BUILDDIR)/lib/apply_bindings.cmx \ + $(BUILDDIR)/generated/vyosconfig.o + +CAML_INIT=$(BUILDDIR)/stub/init.o +CAML_CTYPES:=$(shell eval $$(opam env --root=/opt/opam --set-root); ocamlfind query ctypes) +CAML_STDLIB:=$(shell eval $$(opam env --root=/opt/opam --set-root); ocamlfind ocamlc -config | awk '/^standard_library_default:/ {print $$2}') + +# The files that we'll generate +GENERATED=$(BUILDDIR)/generated/vyosconfig.h \ + $(BUILDDIR)/generated/vyosconfig.c \ + $(BUILDDIR)/generated/vyosconfig_bindings.ml + +OSTYPE:=$(shell eval $$(opam env --root=/opt/opam --set-root); ocamlfind ocamlc -config | awk '/^os_type:/ {print $$2}') +SYSTEM:=$(shell eval $$(opam env --root=/opt/opam --set-root); ocamlfind ocamlc -config | awk '/^system:/ {print $$2}') +EXTDLL:=$(shell eval $$(opam env --root=/opt/opam --set-root); ocamlfind ocamlc -config | awk '/^ext_dll:/ {print $$2}') + +CC:= $(shell eval $$(opam env --root=/opt/opam --set-root); ocamlfind ocamlc -config | awk '/^bytecomp_c_compiler/ {for(i=2;i<=NF;i++) printf "%s " ,$$i}') + +LIBNAME:=libvyosconfig.so.0 + +ifeq ($(OSTYPE),$(filter $(OSTYPE),Win32 Cygwin)) +EXTEXE=.exe +else +EXTEXE= +endif + +GENERATOR=$(BUILDDIR)/generate$(EXTEXE) + +all: sharedlib + +PHONY: depends +depends: + sudo sh -c 'eval $$(opam env --root=/opt/opam --set-root) ;\ + opam pin add vyos1x-config https://github.com/vyos/vyos1x-config.git#b53326dce7dd2dabad2677ad82de4fcd4ea85524 -y ; \ + opam pin add vyconf https://github.com/vyos/vyconf.git#2da0981501a9bec8b69d29f1e52c10db90571aa4 -y' + +sharedlib: depends $(BUILDDIR)/libvyosconfig$(EXTDLL) + +ifeq ($(OSTYPE),$(filter $(OSTYPE),Win32 Cygwin)) +$(BUILDDIR)/libvyosconfig$(EXTDLL): $(CAML_INIT) $(LIBFILES) + ocamlfind opt -o $@ -linkpkg -output-obj -verbose -package $(PACKAGES) $^ +else ifeq ($(SYSTEM),$(filter $(SYSTEM),macosx)) +$(BUILDDIR)/libvyosconfig$(EXTDLL): $(CAML_INIT) $(LIBFILES) + ocamlfind opt -o $@ -linkpkg -runtime-variant _pic -verbose -ccopt -dynamiclib -package $(PACKAGES) $^ +else +$(BUILDDIR)/libvyosconfig$(EXTDLL): $(CAML_INIT) $(LIBFILES) + eval $$(opam env --root=/opt/opam --set-root); ocamlfind opt -o $@ -linkpkg -output-obj -runtime-variant _pic -verbose -thread -package $(PACKAGES) -ccopt "-Wl,-soname,$(LIBNAME)" $^ +endif + +stubs: $(GENERATED) + +$(BUILDDIR)/stub/%.o: + eval $$(opam env --root=/opt/opam --set-root); ocamlc -g -c stub/init.c + mv init.o $@ + +$(GENERATED): $(GENERATOR) + $(GENERATOR) $(BUILDDIR)/generated + +$(BUILDDIR)/%.o: %.c + $(CC) -c -o $@ -fPIC -I $(CAML_CTYPES) -I $(CAML_STDLIB) -I $(OCAMLDIR) -I $(OCAMLDIR)/../ctypes $< + +$(BUILDDIR)/%.cmx: %.ml + eval $$(opam env --root=/opt/opam --set-root); ocamlfind opt -c -o $@ -I $(BUILDDIR)/generated -I $(BUILDDIR)/lib -thread -package $(PACKAGES) $< + +$(GENERATOR): $(GENERATOR_FILES) + eval $$(opam env --root=/opt/opam --set-root); ocamlfind opt -o $@ -I $(BUILDDIR)/lib -linkpkg -thread -package $(PACKAGES) $^ + +install: sharedlib + @mkdir -p /usr/lib + @cp $(BUILDDIR)/libvyosconfig$(EXTDLL) /usr/lib/$(LIBNAME) + +clean: + rm -rf $(BUILDDIR) diff --git a/libvyosconfig/README.md b/libvyosconfig/README.md new file mode 100644 index 000000000..7c3fd1d85 --- /dev/null +++ b/libvyosconfig/README.md @@ -0,0 +1,27 @@ +libvyosconfig +============= + +This library mixes the multiway tree manipulation libraries from [vyconf](https://github.com/vyos/vyconf) +with a parser and a formatter for VyOS 1.x config format, and is meant to be used in config migration scripts +and analysis/conversion tools. + +The main purpose is to provide bindings for Python, so using this library directly from C is strongly +discouraged: not just the interface is not guaranteed to be stable, it's written to be a bridge between +two high level languages so it would be very inconvenient to use from C. + +## Building + +You need to install OPAM and then use it to install OCaml (4.08 or later, latest 4.12 works fine). + + +``` +# Clone and install the vyos1x-config library +git clone https://github.com/vyos/vyos1x-config +opam pin add vyos1x-config . + +# Install build deps +opam install ctypes ctypes-foreign ctypes-build + +# Build the Debian package +dpkg-buildpackage -b -us -uc -tc +``` diff --git a/libvyosconfig/lib/apply_bindings.ml b/libvyosconfig/lib/apply_bindings.ml new file mode 100644 index 000000000..3d8838856 --- /dev/null +++ b/libvyosconfig/lib/apply_bindings.ml @@ -0,0 +1,3 @@ +(** Apply the Stubs functor to the generated bindings to link the generated + code into the library. *) +include Bindings.Stubs(Vyosconfig_bindings) diff --git a/libvyosconfig/lib/bindings.ml b/libvyosconfig/lib/bindings.ml new file mode 100644 index 000000000..2b222fb0b --- /dev/null +++ b/libvyosconfig/lib/bindings.ml @@ -0,0 +1,338 @@ +open Ctypes +open Foreign + +open Vyos1x +open Vyconfd_config +open Commitd_client + +module CT = Config_tree +module CD = Config_diff +module RT = Reference_tree +module TA = Tree_alg +module CM = Commit +module VC = Vycall_client + +module I = Internal.Make(Config_tree) +module IR = Internal.Make(Reference_tree) + +let error_message = ref "" + +let make_syntax_error pos err = + match pos with + | None -> Printf.sprintf "Syntax error: %s" err + | Some (l, c) -> + Printf.sprintf "Syntax error on line %d, character %d: %s" l c err + +let to_json_str = fun s -> `String s + +let split_on_whitespace s = Re.split (Re.Perl.compile_pat "\\s+") s + +let make_config_tree name = Ctypes.Root.create (CT.make name) + +let destroy c_ptr = + Root.release c_ptr + +let equal c_ptr_l c_ptr_r = + (Root.get c_ptr_l) = (Root.get c_ptr_r) + +let from_string s = + try + error_message := ""; + let config = Parser.from_string s in + Ctypes.Root.create config + with + | Failure s -> error_message := s; Ctypes.null + | Util.Syntax_error (pos, err) -> + let msg = make_syntax_error pos err in + error_message := msg; Ctypes.null + | _ -> error_message := "Parse error"; Ctypes.null + +let get_error () = !error_message + +let render_config c_ptr ord_val = + CT.render_config ~ord_val:ord_val (Root.get c_ptr) + +let render_json c_ptr = + CT.render_json (Root.get c_ptr) + +let render_json_ast c_ptr = + CT.render_json_ast (Root.get c_ptr) + +let render_commands c_ptr op = + match op with + | "delete" -> + CT.render_commands ~op:CT.Delete (Root.get c_ptr) [] + | _ -> + CT.render_commands ~op:CT.Set (Root.get c_ptr) [] + +let read_internal file = + try + error_message := ""; + let ct = I.read_internal file in + Ctypes.Root.create ct + with Internal.Read_error msg -> + error_message := msg; Ctypes.null + +let write_internal c_ptr file = + try + error_message := ""; + let ct = Root.get c_ptr in + I.write_internal ct file + with Internal.Write_error msg -> + error_message := msg + +let create_node c_ptr path = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + try + let new_ct = CT.create_node ct path in + Root.set c_ptr new_ct; + 0 (* return 0 *) + with CT.Useless_set -> 1 + +let set_add_value c_ptr path value = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + try + let new_ct = CT.set ct path (Some value) CT.AddValue in + Root.set c_ptr new_ct; + 0 (* return 0 *) + with CT.Duplicate_value -> 1 + +let set_replace_value c_ptr path value = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + let new_ct = Config_tree.set ct path (Some value) Config_tree.ReplaceValue in + Root.set c_ptr new_ct; + 0 (* return 0 *) + +let set_valueless c_ptr path = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + try + let new_ct = Config_tree.set ct path None CT.AddValue in + Root.set c_ptr new_ct; + 0 (* return 0 *) + with CT.Useless_set -> 1 + +let delete_value c_ptr path value = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + try + let new_ct = CT.delete ct path (Some value) in + Root.set c_ptr new_ct; + 0 (* return 0 *) + with + | Vytree.Nonexistent_path -> 1 + | CT.No_such_value -> 2 + +let delete_node c_ptr path = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + if not (Vytree.exists ct path) then 1 else + let new_ct = Config_tree.delete ct path None in + Root.set c_ptr new_ct; + 0 (* return 0 *) + +let rename_node c_ptr path newname = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + if not (Vytree.exists ct path) then 1 else + let new_ct = Vytree.rename ct path newname in + Root.set c_ptr new_ct; + 0 (* return 0 *) + +let set_tag c_ptr path value = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + try + Root.set c_ptr (CT.set_tag ct path value); + 0 (* return 0 *) + with _ -> 1 + +let is_tag c_ptr path = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + if (CT.is_tag ct path) then 1 else 0 + +let set_leaf c_ptr path value = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + try + Root.set c_ptr (CT.set_leaf ct path value); + 0 (* return 0 *) + with _ -> 1 + +let is_leaf c_ptr path = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + CT.is_leaf ct path + +let get_subtree c_ptr path with_node = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + let subt = CT.get_subtree ~with_node:with_node ct path in + Ctypes.Root.create subt + +let exists c_ptr path = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + if (Vytree.exists ct path) then 1 else 0 + +let list_nodes c_ptr path = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + try + let nodes = Vytree.children_of_path ct path in + let nodes_json = `List (List.map to_json_str nodes) in + Yojson.Safe.to_string nodes_json + with _ -> Yojson.Safe.to_string `Null + +let return_value c_ptr path = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + try + Yojson.Safe.to_string (`String (CT.get_value ct path)) + with + | CT.Node_has_no_value -> Yojson.Safe.to_string (`String "") + | _ -> Yojson.Safe.to_string `Null + +let return_values c_ptr path = + let ct = Root.get c_ptr in + let path = split_on_whitespace path in + let to_json_str = fun s -> `String s in + try + let values = CT.get_values ct path in + let values_json = `List (List.map to_json_str values) in + Yojson.Safe.to_string values_json + with _ -> Yojson.Safe.to_string `Null + +let copy_node c_ptr old_path new_path = + let ct = Root.get c_ptr in + let old_path_str = old_path in + let old_path = split_on_whitespace old_path in + let new_path = split_on_whitespace new_path in + try + let new_ct = Vytree.copy ct old_path new_path in + Root.set c_ptr new_ct; + 0 + with + | Vytree.Nonexistent_path -> + let s = Printf.sprintf "Non-existent path \'%s\'" old_path_str in + error_message := s; 1 + | Vytree.Insert_error s -> error_message := s; 1 + +let diff_tree path c_ptr_l c_ptr_r = + let path = split_on_whitespace path in + let ct_l = Root.get c_ptr_l in + let ct_r = Root.get c_ptr_r in + try + let ct_ret = CD.diff_tree path ct_l ct_r in + Ctypes.Root.create ct_ret + with + | CD.Incommensurable -> error_message := "Incommensurable"; Ctypes.null + | CD.Empty_comparison -> error_message := "Empty comparison"; Ctypes.null + +let show_diff cmds path c_ptr_l c_ptr_r = + let path = split_on_whitespace path in + let ct_l = Root.get c_ptr_l in + let ct_r = Root.get c_ptr_r in + try + CD.show_diff ~cmds:cmds path ct_l ct_r + with + | CD.Incommensurable -> error_message := "Incommensurable"; "#1@" + | CD.Empty_comparison -> error_message := "Empty comparison"; "#1@" + +let tree_union c_ptr_l c_ptr_r = + let ct_l = Root.get c_ptr_l in + let ct_r = Root.get c_ptr_r in + try + let ct_ret = CD.tree_union ct_l ct_r in + Ctypes.Root.create ct_ret + with + | TA.Nonexistent_child -> error_message := "Nonexistent child"; Ctypes.null + | TA.Incompatible_union -> error_message := "Trees must have equivalent root"; Ctypes.null + +let tree_merge destructive c_ptr_l c_ptr_r = + let ct_l = Root.get c_ptr_l in + let ct_r = Root.get c_ptr_r in + try + let ct_ret = CD.tree_merge ~destructive:destructive ct_l ct_r in + Ctypes.Root.create ct_ret + with + | TA.Nonexistent_child -> error_message := "Nonexistent child"; Ctypes.null + | TA.Incompatible_union -> error_message := "Trees must have equivalent root"; Ctypes.null + +let reference_tree_to_json internal_cache from_dir to_file = + try + Generate.reference_tree_to_json ~internal_cache:internal_cache from_dir to_file; 0 + with + | Generate.Load_error msg -> + let s = Printf.sprintf "Load_error \'%s\'" msg in + error_message := s; 1 + | Generate.Write_error msg -> + let s = Printf.sprintf "Write_error \'%s\'" msg in + error_message := s; 1 + +let mask_tree c_ptr_l c_ptr_r = + let ct_l = Root.get c_ptr_l in + let ct_r = Root.get c_ptr_r in + try + let ct_ret = CD.mask_tree ct_l ct_r in + Ctypes.Root.create ct_ret + with + | CD.Incommensurable -> error_message := "Incommensurable"; Ctypes.null + | CD.Empty_comparison -> error_message := "Empty comparison"; Ctypes.null + +let validate_tree_filter c_ptr rt_cache_path validator_dir = + let ct = Root.get c_ptr in + try + let rt = IR.read_internal rt_cache_path + in + let ct_ret, out = + RT.validate_tree_filter validator_dir rt ct + in + error_message := out; Ctypes.Root.create ct_ret + with Internal.Read_error msg -> + error_message := msg; c_ptr + + +module Stubs(I : Cstubs_inverted.INTERNAL) = +struct + + let () = I.internal "make" (string @-> returning (ptr void)) make_config_tree + let () = I.internal "destroy" ((ptr void) @-> returning void) destroy + let () = I.internal "equal" ((ptr void) @-> (ptr void) @-> returning bool) equal + let () = I.internal "from_string" (string @-> returning (ptr void)) from_string + let () = I.internal "get_error" (void @-> returning string) get_error + let () = I.internal "to_string" ((ptr void) @-> bool @-> returning string) render_config + let () = I.internal "to_json" ((ptr void) @-> returning string) render_json + let () = I.internal "to_json_ast" ((ptr void) @-> returning string) render_json_ast + let () = I.internal "to_commands" ((ptr void) @-> string @-> returning string) render_commands + let () = I.internal "read_internal" (string @-> returning (ptr void)) read_internal + let () = I.internal "write_internal" ((ptr void) @-> string @-> returning void) write_internal + let () = I.internal "create_node" ((ptr void) @-> string @-> returning int) create_node + let () = I.internal "set_add_value" ((ptr void) @-> string @-> string @-> returning int) set_add_value + let () = I.internal "set_replace_value" ((ptr void) @-> string @-> string @-> returning int) set_replace_value + let () = I.internal "set_valueless" ((ptr void) @-> string @-> returning int) set_valueless + let () = I.internal "delete_value" ((ptr void) @-> string @-> string @-> returning int) delete_value + let () = I.internal "delete_node" ((ptr void) @-> string @-> returning int) delete_node + let () = I.internal "rename_node" ((ptr void) @-> string @-> string @-> returning int) rename_node + let () = I.internal "copy_node" ((ptr void) @-> string @-> string @-> returning int) copy_node + let () = I.internal "set_tag" ((ptr void) @-> string @-> bool @-> returning int) set_tag + let () = I.internal "is_tag" ((ptr void) @-> string @-> returning int) is_tag + let () = I.internal "set_leaf" ((ptr void) @-> string @-> bool @-> returning int) set_leaf + let () = I.internal "is_leaf" ((ptr void) @-> string @-> returning bool) is_leaf + let () = I.internal "get_subtree" ((ptr void) @-> string @-> bool @-> returning (ptr void)) get_subtree + let () = I.internal "exists" ((ptr void) @-> string @-> returning int) exists + let () = I.internal "list_nodes" ((ptr void) @-> string @-> returning string) list_nodes + let () = I.internal "return_value" ((ptr void) @-> string @-> returning string) return_value + let () = I.internal "return_values" ((ptr void) @-> string @-> returning string) return_values + let () = I.internal "diff_tree" (string @-> (ptr void) @-> (ptr void) @-> returning (ptr void)) diff_tree + let () = I.internal "show_diff" (bool @-> string @-> (ptr void) @-> (ptr void) @-> returning string) show_diff + let () = I.internal "tree_union" ((ptr void) @-> (ptr void) @-> returning (ptr void)) tree_union + let () = I.internal "tree_merge" (bool @-> (ptr void) @-> (ptr void) @-> returning (ptr void)) tree_merge + let () = I.internal "reference_tree_to_json" (string @-> string @-> string @-> returning int) reference_tree_to_json + let () = I.internal "mask_tree" ((ptr void) @-> (ptr void) @-> returning (ptr void)) mask_tree + let () = I.internal "validate_tree_filter" ((ptr void) @-> string @-> string @-> returning (ptr void)) validate_tree_filter +end diff --git a/libvyosconfig/stub/init.c b/libvyosconfig/stub/init.c new file mode 100644 index 000000000..20508b8a9 --- /dev/null +++ b/libvyosconfig/stub/init.c @@ -0,0 +1,9 @@ +#include <caml/callback.h> + +__attribute__ ((__constructor__)) +void +init(void) +{ + char *caml_argv[1] = { NULL }; + caml_startup(caml_argv); +} diff --git a/libvyosconfig/stub_generator/generate.ml b/libvyosconfig/stub_generator/generate.ml new file mode 100644 index 000000000..48ac707db --- /dev/null +++ b/libvyosconfig/stub_generator/generate.ml @@ -0,0 +1,30 @@ +(** A driver for stub generation. Build OCaml and C code from the + Bindings.Stubs functor. *) + +let generate dirname = + let prefix = "vyosconfig" in + let path basename = Filename.concat dirname basename in + let ml_fd = open_out (path "vyosconfig_bindings.ml") in + let c_fd = open_out (path "vyosconfig.c") in + let h_fd = open_out (path "vyosconfig.h") in + let stubs = (module Bindings.Stubs : Cstubs_inverted.BINDINGS) in + begin + (* Generate the ML module that links in the generated C. *) + Cstubs_inverted.write_ml + (Format.formatter_of_out_channel ml_fd) ~prefix stubs; + + (* Generate the C source file that exports OCaml functions. *) + Format.fprintf (Format.formatter_of_out_channel c_fd) + "#include \"vyosconfig.h\"@\n%a" + (Cstubs_inverted.write_c ~prefix) stubs; + + (* Generate the C header file that exports OCaml functions. *) + Cstubs_inverted.write_c_header + (Format.formatter_of_out_channel h_fd) ~prefix stubs; + + end; + close_out h_fd; + close_out c_fd; + close_out ml_fd + +let () = generate (Sys.argv.(1)) |
