[*] Initial commit

.clang-tidy

@@ -0,0 +1 @@
+Checks:           'clang-*,-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling'

.gitignore

@@ -0,0 +1,51 @@
+# meson build directory
+build/
+
+# exclude test data folders
+test/*/
+
+# external projects, if any
+subprojects/*/
+
+# hidden files
+.*
+!.clang-format
+!.clang-tidy
+!.gitignore
+!.gitmodules
+
+# KDevelop projects
+*.kdev4
+
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app

COPYING.GPL

@@ -0,0 +1,675 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, 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
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If 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 convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU 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
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
+

COPYING.LESSER

@@ -0,0 +1,166 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  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 that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU 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 as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

README.md

@@ -0,0 +1,60 @@
+µbgpsuite -- Micro BGP Suite and Utility library
+================================================
+
+# Introduction
+
+`µbgpsuite`, the Micro BGP Suite and Utility library, is a project
+aiming to provide a low level library and utilities for
+high-performance and flexible network analysis, with special
+focus on the Border Gateway Protocol (BGP).
+The purpose of this suite is establishing a friendly environment
+for research and experimentation of useful data study
+techniques to improve network health.
+
+# lonetix -- Low-overhead Networking programming Interface
+
+The project is centered around `lonetix`, a low overhead and
+low level networking library written in C.
+It provides a set of general functionality to implement the suite utilities.
+`lonetix` principles are:
+- efficiency: `lonetix` has to be fast and versatile;
+- predictability: data structures and functions should be predictable
+  and reflect the actual protocol, abstraction should not degenerate
+  into alienation;
+- zero copy and zero overhead: be friendly to your target CPU and cache,
+  you never know just how fast or poweful the target platform will be,
+  ideally `lonetix` should be capable of performing useful work on embedded
+  systems as well as full fledged power systems alike;
+- lean: try to be self-contained and only introduce dependencies when strictly
+  necessary.
+
+Extensive documentation of `lonetix` and its API is available.
+
+# Utilities
+
+`lonetix` is the building block of `bgpgrep`, this far our single
+utility -- but more of them are coming, right?
+
+`bgpgrep` performs fast and reliable analysis of MRT dumps
+collected by most Route Collecting projects. It takes a different
+turn compared to most similar tools, in that it provides extensive
+filtering utilities, in order to extrapolate only relevant data
+out of each MRT dump (and incidentally save quite some time).
+In-depth documentation of `bgpgrep` is available in its man page.
+
+# License
+
+The Micro BGP Suite is free software.
+You can redistribute the `lonetix` library and/or modify it under the terms of the
+GNU Lesser General Public License.
+You can redistribute any utility and/or modify it under the terms of the
+GNU General Public License.
+
+The Micro BGP Suite 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 license terms for
+more details.
+
+See `COPYING.LESSER` for the GNU Lesser General Public License terms,
+and `COPYING.GPL` for the GNU General Public License terms.
+

doc/HISTORY.md

@@ -0,0 +1,55 @@
+Micro BGP Suite history
+=======================
+
+This document summarizes a bit of history of the project, it tells you anything
+you didn't want to know about `ubgpsuite` and never cared to ask.
+
+`ubgpsuite` was created as an evolution over `bgpscanner` and its companion
+library, `isocore`. `bgpscanner` was originally developed by me starting in 2017
+as part of the Isolario Project, under the Institute of Informatics and
+Telematics of the Italian National Research Council
+[IIT-CNR](https://www.iit.cnr.it/).
+`bgpscanner` was covered by the MIT license terms and is still available
+(as of May 2021) at Isolario's
+[website](https://isolario.it/web_content/php/site_content/tools.php).
+Despite the fact that `bgpscanner` code was developed mostly by me, the
+help of the Isolario team, their patience, and their knowledge about BGP's
+nuts and bolts was invaluable to get it rolling.
+
+By mid 2019, my collaboration with IIT-CNR has ceased.
+In an attempt to further the concepts behind `bgpscanner` and keep experimenting
+with them, I started the `ubgpsuite` project. At this time I was involved with
+[Alpha Cogs](https://www.alphacogs.com), a company I co-founded, so I undertook
+`ubgpsuite` development and got it moving forward with its financial support.
+
+`ubgpsuite` was born by a partial rewrite of `bgpscanner`, taking advantage of
+the fact that there was no more interoperability constrain with a larger
+project -- `isocore` was originally intended to be used by other
+components inside the Isolario project as well, but that wasn't the
+case anymore. This allowed some minor improvement to the codebase, but the
+overall software architecture was unchanged. Though `ubgpsuite` was relicensed
+under the terms of LGPLv3+ for library code and GPLv3+ for utilities and tools.
+The choice was motivated by my intention to keep the project free
+(as in freedom) forever, considering that the only reason I was able to continue
+developing the code I authored at IIT-CNR and keep the project alive was
+its original open source license.
+
+Unfortunately a chronical lack of time, due to more pressing company priorities,
+has hit the fan during that year and most of 2020. But finally,
+by the end of 2020, I got the chance to dedicate some time to the project.
+As a matter of fact, I left Alpha Cogs and devoted a bit of myself to
+move `ubgpsuite` and other projects I cared about out of stagnation.
+`ubgpsuite` was then outside Alpha Cogs and became the first of
+DoubleFourteen Code Forge projects -- 1414° for short, an initiative I
+founded to research and develop free software, in the hope of improving
+the software ecosystem.
+
+On 2021, a total rewrite of `ubgpsuite` was complete and ready for release,
+with this document included. History of the project will thereafter remain
+unread.
+
+Keep developing the code you love and enjoy,
+
+---
+
+Lorenzo Cogotti

doc/css/custom.css

@@ -0,0 +1,3 @@
+:root {
+    --note-color-darker: #8e7618;
+}

doc/css/doxygen-awesome-sidebar-only.css

@@ -0,0 +1,108 @@
+/**
+
+Doxygen Awesome
+https://github.com/jothepro/doxygen-awesome-css
+
+MIT License
+
+Copyright (c) 2021 jothepro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+ */
+
+:root {
+    /* side nav width. MUST be = `TREEVIEW_WIDTH`.
+     * Make sure it is wide enought to contain the page title (logo + title + version)
+     */
+    --side-nav-fixed-width: 350px;
+    --menu-display: none;
+
+    --top-height: 120px;
+}
+
+
+@media screen and (min-width: 768px) {
+    :root {
+        --searchbar-background: var(--page-background-color);
+    }
+
+    #side-nav {
+        min-width: var(--side-nav-fixed-width);
+        max-width: var(--side-nav-fixed-width);
+        top: var(--top-height);
+    }
+
+    #nav-tree, #side-nav {
+        height: calc(100vh - var(--top-height)) !important;
+    }
+
+    #nav-tree {
+        padding: 0;
+    }
+
+    #top {
+        display: block;
+        border-bottom: none;
+        height: var(--top-height);
+        margin-bottom: calc(0px - var(--top-height));
+        max-width: var(--side-nav-fixed-width);
+        background: var(--side-nav-background);
+    }
+    #main-nav {
+        float: left;
+    }
+
+    .ui-resizable-handle {
+        cursor: default;
+        width: 1px !important;
+        box-shadow: 0 calc(-2 * var(--top-height)) 0 0 var(--separator-color);
+    }
+
+    #nav-path {
+        position: fixed;
+        right: 0;
+        left: var(--side-nav-fixed-width);
+        bottom: 0;
+        width: auto;
+    }
+
+    #doc-content {
+        height: calc(100vh - 31px) !important;
+        padding-bottom: calc(3 * var(--spacing-large));
+        padding-top: calc(var(--top-height) - 80px);
+        box-sizing: border-box;
+        margin-left: var(--side-nav-fixed-width) !important;
+    }
+
+    #MSearchBox {
+        width: calc(var(--side-nav-fixed-width) - calc(2 * var(--spacing-medium)));
+    }
+
+    #MSearchField {
+        width: calc(var(--side-nav-fixed-width) - calc(2 * var(--spacing-medium)) - 65px);
+    }
+
+    #MSearchResultsWindow {
+        left: var(--spacing-medium) !important;
+        right: auto;
+    }
+}
+
+

doc/meson.build

@@ -0,0 +1,21 @@
+cdata = configuration_data({
+    'TOP_SRCDIR':   meson.source_root(),
+    'TOP_BUILDDIR': meson.build_root(),
+    'OUTPUT_DIR':   meson.build_root() / 'doc',
+    'VERSION':      meson.project_version(),
+    'PROJECT_NAME': meson.project_name(),
+})
+
+doxyfile = configure_file(input : 'Doxyfile.in',
+                          output : 'Doxyfile',
+                          configuration : cdata,
+                          install : false)
+
+doc_target = custom_target('doc',
+                           build_by_default : false,
+                           build_always_stale : true,
+                           console : true,
+                           command : [ doxygen, doxyfile ],
+                           output : [ 'doc' ])
+
+alias_target('doc', doc_target)

lonetix/README.md

@@ -0,0 +1,170 @@
+Low-overhead Networking library Interface
+=============================================
+
+# Introdution and philosophy
+
+`lonetix` is a general, performance oriented, C networking library.
+Its field of application leans towards high-performance analysis of
+Border Gateway Protocol (BGP) data.
+
+`lonetix` is somewhat opinionated, its principles are:
+- efficiency: `lonetix` has to be fast and versatile;
+- predictability: data structures and functions should be predictable
+  and reflect the actual protocol, abstraction should not degenerate
+  into alienation;
+- zero copy and zero overhead: be friendly to your target CPU and cache,
+  you never know just how fast or poweful the target platform will be,
+  ideally `lonetix` should be capable of performing useful work on embedded
+  systems as well as full fledged power systems alike;
+- lean: try to be self-contained and only introduce dependencies when
+  necessary.
+
+Following sections further elaborate on these points.
+
+## Efficiency
+
+Network analysis is usually thought as a computationally intensive task,
+involving powerful machines capable of crunching large datasets.
+Fast prototyping is tipically preferred over carefully planned, optimized code
+and tools. Our belief is that careful optimizations, good algorithms and general
+libraries may empower scientific research to productively elaborate data faster.
+
+Efficient algorithms and tools make previously prohibitive tasks plausible.
+
+Some researchers have no access to powerful workstations, though devices
+commonly available to the general public are capable enough to perform
+interesting network analysis tasks.
+
+Good tools should not restrict research, they should encourage it.
+
+Efficiency should be a guiding principle behind `lonetix`, and the main
+reason for choosing C as a language.
+
+## Predictability
+
+`lonetix` is a relatively low-level C library. As such it deals with
+common software engineering problems. In contrast with common opinion, C has
+sufficient means to define a decent level of abstraction.
+Powerful abstractions have to be formalized, documented, explained and learned.
+Once this process is complete, powerful abstractions need to be used correctly.
+Therefore, powerful abstractions need expensive engineering and comprehensive
+documentation, they imply a learning curve and a period of practice.
+
+Abstraction is a key software engineering concept only valuable if worthwhile.
+
+Excessive abstraction may distract too much from the intent of a programming
+interface, making it more obfuscated, less obvious, thus less predictable.
+Additionally, it makes it harder for a programmer using them to guess or
+estimate their performance penalty -- a particularly undesirable feature
+in a scenario where such estimate could be crucial.
+Whenever possible an interface should be transparent to the programmer,
+essential, immediate in conveying its purpose and model, keep its field of
+application clear and confined.
+
+`lonetix` builds complex abstraction only in face of a sufficient gain.
+Simplicity is a virtue, and obvious solutions need less explaination.
+Oftentimes, solving a large problem with clear straight to the point code
+is testament of a solid approach.
+
+## Zero copy
+
+`lonetix` deals, for the most part, with BGP messages.
+Decoding them, ensuring their integrity and accessing their fields
+conveniently and efficiently is central to the usefulness of the library.
+
+Most libraries that read messages encoded in a particular protocol,
+take the common approach of introducing a decode phase upfront,
+with the intent of transforming its raw data into a more palatable
+representation for the library.
+The obvious advantages of this approach are:
+- an efficient resulting data structure that makes it easy to access every
+  message field when needed;
+- any data integrity error is detected upfront, during the transformation.
+
+Situation is specular for message writing.
+
+This approach comes with its own set of disadvantages, though:
+- an initial decoding phase implies the whole message is scanned at least
+  once to organize it in the new data structure, even when only a single field of
+  the entire message would be relevant to the user;
+- CPU architectures greatly benefit from cache reuse, introducing a decode
+  phase upfront that moves data around from a plain byte buffer to a complex
+  data structure is usually bad news to the CPU cache;
+- more data structures generally imply more memory allocations;
+- translating raw data to the target data structure and back may
+  require more complex API and implementation than providing equivalent
+  facilities to access raw data directly.
+
+These reasons motivated `lonetix` to explore a more trivial zero-copy approach:
+whenever possible `lonetix` should work with raw BGP messages and require no
+unnecessary data copy.
+
+Do note that this approach is not perfect either. We simply believe that the
+tradeoff is to `lonetix` advantage, and a zero copy approach fits better in
+a performance-oriented and predictable library.
+
+Same considerations apply to any portions of the library facing similar
+situations (MRT data, other network protocols, etc...).
+
+## Zero overhead
+
+`lonetix` provides comprehensive facilities for network analysis and additional
+utility functions for a wide variety of common tasks
+(including string utilities, text parsing, etc...).
+Library users should not be burdened with overhead for functionality they don't
+need.
+
+By design `lonetix` should be modular and require no runtime overhead
+(such as background threads, `atexit()` hooks, or static initialization)
+unless deemed as positively and unmistakably unavoidable.
+
+`lonetix` is a **static library**, making it possible for the compiler to
+strip any unused code from the resulting binary.
+
+Careful coding should always allow to compile the library with
+full optimizations on, including Link Time Optimization
+(whether the binary should be optimized for space or
+speed should be configurable by the user).
+
+## Lean
+
+No external dependency should be introduced unless strictly necessary.
+This helps improving portability and makes `lonetix` usable even under
+constrained environments.
+
+`lonetix` **does not pursue strict ABI or API stability**.
+
+Given that `lonetix` is a static library, keeping ABI stability is unnecessary.
+Strict API stability tends to clutter libraries with large amounts of
+legacy code, `lonetix` strives for incremental code improvement.
+This sometimes calls for changes to the API and minor interface variations.
+Users wishing for specific features from older versions that have been
+evicted or changed on current ones, may fetch the older versions and link to
+them.
+Though API stability is not guaranteed, it should not be broken deliberately,
+viable code migration paths should be offered when possible, for sensible use
+cases.
+
+# Documentation and examples
+
+Complete project documentation is currently work in progress.
+
+Extensive `Doxygen` API documentation is available for most of the library.
+We also believe code should be clear, understandable and idiomatic, so
+you can check out the code of any utility using `lonetix`
+(for example `bgpgrep`) as a reference of how to take advantage of the library.
+
+# License
+
+`lonetix` is free software. You can redistribute it and/or modify it under
+the terms of the GNU Lesser General Public License version 3 as published
+by the Free Software Foundation, or, at your choice, any subsequent version
+of the same license. `lonetix` 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 license terms for
+more details.
+
+See `COPYING.LESSER` under the Micro BGP Suite root project directory for the
+GNU Lesser General Public License terms, or see the
+[Free Software Foundation website](https://www.gnu.org/licenses/lgpl-3.0.txt).
+

lonetix/argv.c

@@ -0,0 +1,349 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+
+/**
+ * \file argv.c
+ *
+ * Portable command line argument parsing implementation.
+ *
+ * \copyright The DoubleFourteen Code Forge (C) All Rights Reserved
+ * \author    Lorenzo Cogotti
+ */
+
+#include "argv.h"
+
+#include "sys/con.h"
+#include "utf/utf.h"
+
+#include <assert.h>
+#include <stdlib.h>  // for getenv() on __GNUC__
+#include <string.h>
+
+const char *com_progName   = NULL;
+const char *com_synopsis   = NULL;
+const char *com_shortDescr = NULL;
+const char *com_longDescr  = NULL;
+
+#define OPT_ISLONLY(flag)    ((flag)->opt == '-')
+#define OPT_HASLONGNAM(flag) ((flag)->longopt != NULL)
+#define OPT_ARGNAME(flag)    (((flag)->argName) ? (flag)->argName : "arg")
+
+static void PrintHelpMessage(const char *prog, const Optflag *options)
+{
+	if (!prog)
+		return;  // quiet parsing
+
+	Sys_Printf(STDOUT, "Usage: %s", prog);
+	if (com_synopsis)
+		Sys_Printf(STDOUT, " %s", com_synopsis);
+
+	Sys_Print(STDOUT, "\n");
+	if (com_shortDescr)
+		Sys_Printf(STDOUT, "%s\n", com_shortDescr);
+
+	if (com_longDescr)
+		Sys_Printf(STDOUT, "\n%s\n\n", com_longDescr);
+
+	char buf[MAXUTF + 1];
+	size_t n;
+
+	for (const Optflag *flag = options; flag->opt != '\0'; flag++) {
+		Sys_Print(STDOUT, "  ");
+
+		// Single char option name
+		if (OPT_ISLONLY(flag)) {
+			// Long option only, leave 2 chars for alignment purposes
+			assert(flag->longopt);
+			Sys_Print(STDOUT, "  ");
+
+		} else {
+			// Write down single-char option first
+			n = runetochar(buf, flag->opt);
+			buf[n] = '\0';
+
+			Sys_Printf(STDOUT, "-%s", buf);
+		}
+
+		// Long name and (optional) argument
+		if (flag->longopt) {
+			// Write comma if necessary, or leave 2 spaces for alignment
+			Sys_Print(STDOUT, OPT_ISLONLY(flag) ? "  " : ", ");
+			Sys_Printf(STDOUT, "--%s", flag->longopt);
+
+			// Append argument with a leading = sign
+			switch (flag->hasArg) {
+			default:       assert(FALSE); break;
+			case ARG_NONE: break;
+			case ARG_OPT:  Sys_Printf(STDOUT, "[=%s]", OPT_ARGNAME(flag)); break;
+			case ARG_REQ:  Sys_Printf(STDOUT, "=%s", OPT_ARGNAME(flag));   break;
+			}
+		} else {
+			// Output argument, short options have no leading =
+			switch (flag->hasArg) {
+			default:       assert(FALSE); break;
+			case ARG_NONE: break;
+			case ARG_OPT:  Sys_Printf(STDOUT, " [%s]", OPT_ARGNAME(flag)); break;
+			case ARG_REQ:  Sys_Printf(STDOUT, " <%s>", OPT_ARGNAME(flag)); break;
+			}
+		}
+		if (flag->descr)
+			Sys_Printf(STDOUT, "\t%s", flag->descr);
+
+		Sys_Print(STDOUT, "\n");
+	}
+
+	// Append help options
+	Sys_Print(STDOUT, "  -h, --help\tPrint this help message\n");
+	Sys_Print(STDOUT, "  -?\tEquivalent to -h\n");
+}
+
+// If `prog` is not NULL, output an excess argument error (only called for long options).
+static void PrintExcessArgError(const char    *prog,
+                                const Optflag *flag,
+                                const char    *arg)
+{
+	if (!prog)
+		return;  // quiet parse
+
+	assert(flag->longopt);
+
+	Sys_Printf(STDERR, "%s: Option --%s takes no argument: --%s=%s", prog, flag->longopt, flag->longopt, arg);
+}
+
+static void PrintMissingArgError(const char *prog, const Optflag *flag, Boolean longName)
+{
+	if (!prog)
+		return;  // quiet parse
+
+	char buf[MAXUTF+1];
+	const char *nam = NULL;
+	const char *pfx = (longName) ? "--" : "-";
+
+	if (longName)
+		nam = flag->longopt;
+
+	else {
+		size_t n = runetochar(buf, flag->opt);
+		buf[n] = '\0';
+
+		nam = buf;
+	}
+
+	Sys_Printf(STDERR, "%s: Option", prog);
+	if (nam)
+		Sys_Printf(STDERR, " %s%s", pfx, nam);
+
+	Sys_Print(STDERR, " requires mandatory argument");
+	if (flag->argName)
+		Sys_Printf(STDERR, " <%s>", flag->argName);
+
+	Sys_Printf(STDERR, ": %s%s\n", pfx, nam);
+}
+
+CHECK_PRINTF(2, 0) static void PrintBadCmdLineError(const char *prog,
+                                                    const char *fmt,
+                                                    ...)
+{
+	if (!prog)
+		return;  // quiet parsing
+
+	va_list va;
+
+	va_start(va, fmt);
+	Sys_Printf(STDERR, "%s: ", prog);
+	Sys_VPrintf(STDERR, fmt, va);
+	Sys_Print(STDERR, "\n");
+	va_end(va);
+}
+
+static Optflag *FindLongFlag(const char *p, char **optarg, const char *prog, Optflag *options)
+{
+	char *arg = strchr(p, '=');
+
+	*optarg = arg;
+
+	char *name;
+	if (arg) {
+		size_t n = arg - p;
+		name     = (char *) alloca(n + 1);
+
+		memcpy(name, p, n);
+		name[n] = '\0';
+	} else
+		name = (char *) p;  // safe
+
+	for (Optflag *flag = options; flag->opt != '\0'; flag++) {
+		if (OPT_HASLONGNAM(flag) && strcmp(flag->longopt, name) == 0) {
+			flag->flagged = TRUE;
+			return flag;
+		}
+	}
+
+	if (prog)
+		Sys_Printf(STDERR, "%s: Unrecognized option: --%s\n", prog, name);
+
+	return NULL;
+}
+
+static Optflag *FindFlag(Rune r, const char *prog, Optflag *flags)
+{
+	for (Optflag *flag = flags; flag->opt != '\0'; flag++) {
+		// NOTE: options with long names are skipped (-- is end of argument list)
+		if (flag->opt == r) {
+			flag->flagged = TRUE;
+			return flag;
+		}
+	}
+
+	if (prog) {
+		char buf[MAXUTF + 1];
+
+		size_t n = runetochar(buf, r);
+		buf[n] = '\0';
+
+		Sys_Printf(STDERR, "%s: Unrecognized option: -%s\n", prog, buf);
+	}
+	return NULL;
+}
+
+#ifdef __GNUC__
+static void ReorderArgv(int argc, char **argv, const Optflag *options)
+{
+	if (getenv("POSIXLY_CORRECT"))
+		return;  // don't mess with argv is POSIX behavior is requested
+
+	USED(argc); USED(argv); USED(options);
+	// TODO
+}
+
+#endif
+
+int Com_ArgParse(int argc, char **argv, Optflag *options, unsigned flags)
+{
+	Optflag *flag;
+
+	char *p, *optarg;
+
+	// Initial setup
+	char *prog = NULL;  // FindFlag*() functions won't log on NULL `prog`
+	if ((flags & ARG_QUIET) == 0) {
+		// Extract program name, so parsing outputs meaningful messages
+		prog = (char *) com_progName;
+		if (!prog) {
+			// Generate from argv[0]
+			prog = argv[0];  // TODO: basename(argv[0]);
+		}
+	}
+
+#ifdef __GNUC__
+	/* GNU allows program options in any order with respect to program
+	 * arguments, for example:
+	 * ```c
+	 *   program file -cv
+	 * ```
+	 * According to POSIX both `file` and `-cv` are program arguments.
+	 * According to GNU `-cv` are options, `file` is a program argument.
+	 *
+	 * To do this GNU getopt() implicitly reorders `argv`.
+	 */
+	if ((flags & ARG_NOREORD) == 0)
+		ReorderArgv(argc, argv, options);
+#endif
+
+	// Parse argument list
+	int optind;
+	for (optind = 1; optind < argc; optind++) {
+		p = argv[optind];
+		if (strcmp(p, "--") == 0) {
+			optind++;
+			break;  // explicit end of command list
+		}
+
+		if (p[0] == '-' && p[1] == '-') {
+			// GNU style long option
+			p += 2;
+			if (strcmp(p, "help") == 0) {
+				PrintHelpMessage(prog, options);
+				return OPT_HELP;
+			}
+
+			flag = FindLongFlag(p, &optarg, prog, options);
+			if (!flag)
+				return OPT_UNKNOWN;
+
+			if (!optarg && flag->hasArg)
+				optarg = argv[++optind];  // fetch argument from `argv`
+
+			if (optarg && flag->hasArg == ARG_NONE) {
+				PrintExcessArgError(prog, flag, optarg);
+				return OPT_EXCESSARG;
+			}
+			if (!optarg && flag->hasArg == ARG_REQ) {
+				PrintMissingArgError(prog, flag, /*longName=*/TRUE);
+				return OPT_ARGMISS;
+			}
+
+			flag->optarg = optarg;
+
+		} else if (p[0] == '-' && p[1] != '\0') {
+			// Unix-style single char option
+			p++;
+
+			do {
+				Rune r;
+				p += chartorune(&r, p);
+				if (r == '-') {
+					/* This can happen in events like: -a-c
+					 * where a->hasArg == ARG_NONE
+					 *
+					 * There is no way to fix this ambiguity safely:
+					 * * if -c is an argument to -a then it is OPT_EXCESSARG error
+					 * * if -a -- -c problematic because it's counterintuitive
+					 *   for the user
+					 *   (one could get surprising -c program arguments)
+					 * * if we take it as -a --(force as option) -c it would be
+					 *   dangerous (sometimes -- is an option, sometimes an
+					 *   end of option list)
+					 *
+					 *   NOTE: getopt() appears to do the last, and it's
+					 *         horrific
+					 */
+					PrintBadCmdLineError(prog, "Ambiguous '-' in short options list: %s", argv[optind]);
+					return OPT_BADARGV;
+				}
+
+				// Handle single char help requests
+				if (r == '?' || r == 'h') {
+					PrintHelpMessage(prog, options);
+					return OPT_HELP;
+				}
+
+				flag = FindFlag(r, prog, options);
+				if (!flag)
+					return OPT_UNKNOWN;
+
+				optarg = NULL;
+				if (flag->hasArg)
+					optarg = (*p != '\0') ? p : argv[++optind];
+
+				if (!optarg && flag->hasArg == ARG_REQ) {
+					PrintMissingArgError(prog, flag, /*longName=*/FALSE);
+					return OPT_ARGMISS;
+				}
+
+				flag->optarg = optarg;
+
+			} while (*p != '\0');
+		}
+#if 0 && defined(_WIN32)  // TODO
+		else if (p[0] == '/' && p[1] != '\0') {
+			// DOS style option
+		}
+#endif
+		else {
+			// End of argument list, break the loop
+			break;
+		}
+	}
+
+	return optind;
+}

lonetix/bgp/bgp.c

@@ -0,0 +1,611 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+
+/**
+ * \file bgp/bgp.c
+ *
+ * BGP message decoding.
+ *
+ * \copyright The DoubleFourteen Code Forge (C) All Rights Reserved
+ * \author    Lorenzo Cogotti
+ */
+
+#include "bgp/bgp_local.h"
+#include "sys/sys_local.h"
+#include "sys/dbg.h"
+#include "sys/endian.h"
+#include "sys/ip.h"
+#include "sys/con.h"
+#include "argv.h"
+#include "numlib.h"
+
+#include <assert.h>
+#include <errno.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+static const Uint8 bgp_marker[] = {
+	0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+	0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
+};
+
+STATIC_ASSERT(sizeof(bgp_marker) == BGP_MARKER_LEN, "Malformed 'bgp_marker'");
+
+static THREAD_LOCAL BgpErrStat bgp_errs;
+
+const char *Bgp_ErrorString(BgpRet code)
+{