diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1631641 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,19 @@ +# This is a good default: files that are auto-detected by git to be text are +# converted to the platform-native line ending (LF on Unix, CRLF on Windows) +# in the working tree and to LF in the repository. +# +* text=auto + +# Use `eol=crlf` for files that should have the CRLF line ending both in the +# working tree (even on Unix) and in the repository. +# +#*.bat text eol=crlf + +# Use `eol=lf` for files that should have the LF line ending both in the +# working tree (even on Windows) and in the repository. +# +#*.sh text eol=lf + +# Use `binary` to make sure certain files are never auto-detected as text. +# +#*.png binary diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..b9525a8 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,24 @@ +name: CI + +on: + push: + pull_request: + +permissions: + contents: read + +concurrency: + group: ci-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + build: + uses: vivarium-ai/certifiable-github/.github/workflows/ci.yml@master + with: + build-target: certifiable-training + + tt-build: + uses: vivarium-ai/certifiable-github/.github/workflows/tt-ci.yml@master + with: + build-target: certifiable-training + tt_dev_image: ghcr.io/tenstorrent/tt-metal/tt-metalium/ubuntu-22.04-dev-amd64:d6958801d86fe1e20a07f2be7795fac0b2c9b211 diff --git a/.gitignore b/.gitignore index 9c19748..9f0e676 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,48 @@ -# Build artifacts -build/ +.bdep/ + +# Local default options files. +# +.build2/local/ + +# Compiler/linker output. +# +*.d +*.t +*.i +*.i.* +*.ii +*.ii.* *.o -*.a +*.obj +*.gcm +*.pcm +*.ifc *.so *.dylib +*.dll +*.a +*.lib +*.exp +*.pdb +*.ilk +*.exe +*.exe.dlls/ +*.exe.manifest +*.pc + +# Build2 symlinks exes from build dir to src dir for convenient +examples/train_xor +examples/verify_step +tests/unit/test_backward +tests/unit/test_bit_identity +tests/unit/test_compensated +tests/unit/test_forward +tests/unit/test_merkle +tests/unit/test_optimizer +tests/unit/test_permutation +tests/unit/test_primitives +tests/unit/test_prng +tests/unit/test_reduction # Editor files *.swp diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..3093b98 --- /dev/null +++ b/Makefile @@ -0,0 +1,63 @@ +EXES := +DIST := + +# Versioning +VERSION ?= $(shell (git describe --tags 2>/dev/null || echo "develop") | sed 's/^v//') +REVISION ?= $(shell git rev-parse --short HEAD) + +export VERSION +export REVISION + +# Build configuration (overrideable) +# build2 requires out-of-source builds. Default to parent directory with compiler suffix. +SRCDIR := $(notdir $(CURDIR)) +SCRIPTS_DIR ?= ./certifiable-build/scripts +BUILD_DIR ?= ../build2/$(SRCDIR)-default +BUILD_TYPE ?= release +PREFIX ?= /usr/local + +# Export for scripts +export BUILD_DIR +export BUILD_TYPE +export PREFIX + +.PHONY: all help setup start-tt config build test install package release clean + +all: config build test + +##@ Dependencies +setup: ## Setup project + $(SCRIPTS_DIR)/setup.sh + +##@ Development +config: ## Configure the build + $(SCRIPTS_DIR)/config.sh + +build: ## Build the project + $(SCRIPTS_DIR)/build.sh + +start-tt: ## Start the Tenstorrent container + $(SCRIPTS_DIR)/start-tt.sh + +##@ Testing +test: ## Run tests + $(SCRIPTS_DIR)/test.sh + +##@ Project Management +install: build ## Install the project + $(SCRIPTS_DIR)/install.sh + +package: ## Build release artifacts + $(SCRIPTS_DIR)/package.sh + +release: ## Publish release artifacts + $(SCRIPTS_DIR)/release.sh + +##@ Maintenance +clean: ## Remove all build artifacts + $(SCRIPTS_DIR)/clean.sh + +##@ Documentation +help: ## Display this help + @awk 'BEGIN {FS = ":.*##"; printf "Makefile Usage:\n make \033[36m\033[0m\n"} /^[.a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) + diff --git a/build/.gitignore b/build/.gitignore new file mode 100644 index 0000000..974e01d --- /dev/null +++ b/build/.gitignore @@ -0,0 +1,4 @@ +/config.build +/root/ +/bootstrap/ +build/ diff --git a/build/bootstrap.build b/build/bootstrap.build new file mode 100644 index 0000000..ea54d2a --- /dev/null +++ b/build/bootstrap.build @@ -0,0 +1,7 @@ +project = certifiable-training + +using version +using config +using test +using install +using dist diff --git a/build/export.build b/build/export.build new file mode 100644 index 0000000..3a2824c --- /dev/null +++ b/build/export.build @@ -0,0 +1,6 @@ +$out_root/ +{ + include include/ +} + +export $out_root/include/$import.target diff --git a/build/root.build b/build/root.build new file mode 100644 index 0000000..5f0fb4a --- /dev/null +++ b/build/root.build @@ -0,0 +1,11 @@ +using c +using test + +c.std = c99 +c.warnings = all +c.coptions += -Werror -pedantic -Wno-unused-parameter + +if ($c.id == 'gcc') + c.coptions += -fanalyzer + +c.poptions =+ "-I$src_root/include" diff --git a/buildfile b/buildfile new file mode 100644 index 0000000..2746a27 --- /dev/null +++ b/buildfile @@ -0,0 +1,14 @@ +./: {*/ -build/ -certifiable-build/ -include/ -.github/ -docs/} \ + doc{README.md} \ + legal{LICENSE} \ + manifest + +./: src/ (examples/) tests/ + +import src = src/ +import examples = examples/ +import tests = tests/ + +# Don't install tests. +# +tests/: install = false diff --git a/certifiable-build/.gitignore b/certifiable-build/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/certifiable-build/LICENSE b/certifiable-build/LICENSE new file mode 100644 index 0000000..cebc493 --- /dev/null +++ b/certifiable-build/LICENSE @@ -0,0 +1,678 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. + +--- + +For commercial licensing inquiries, contact: william@fstopify.com diff --git a/certifiable-build/Makefile.template b/certifiable-build/Makefile.template new file mode 100644 index 0000000..3093b98 --- /dev/null +++ b/certifiable-build/Makefile.template @@ -0,0 +1,63 @@ +EXES := +DIST := + +# Versioning +VERSION ?= $(shell (git describe --tags 2>/dev/null || echo "develop") | sed 's/^v//') +REVISION ?= $(shell git rev-parse --short HEAD) + +export VERSION +export REVISION + +# Build configuration (overrideable) +# build2 requires out-of-source builds. Default to parent directory with compiler suffix. +SRCDIR := $(notdir $(CURDIR)) +SCRIPTS_DIR ?= ./certifiable-build/scripts +BUILD_DIR ?= ../build2/$(SRCDIR)-default +BUILD_TYPE ?= release +PREFIX ?= /usr/local + +# Export for scripts +export BUILD_DIR +export BUILD_TYPE +export PREFIX + +.PHONY: all help setup start-tt config build test install package release clean + +all: config build test + +##@ Dependencies +setup: ## Setup project + $(SCRIPTS_DIR)/setup.sh + +##@ Development +config: ## Configure the build + $(SCRIPTS_DIR)/config.sh + +build: ## Build the project + $(SCRIPTS_DIR)/build.sh + +start-tt: ## Start the Tenstorrent container + $(SCRIPTS_DIR)/start-tt.sh + +##@ Testing +test: ## Run tests + $(SCRIPTS_DIR)/test.sh + +##@ Project Management +install: build ## Install the project + $(SCRIPTS_DIR)/install.sh + +package: ## Build release artifacts + $(SCRIPTS_DIR)/package.sh + +release: ## Publish release artifacts + $(SCRIPTS_DIR)/release.sh + +##@ Maintenance +clean: ## Remove all build artifacts + $(SCRIPTS_DIR)/clean.sh + +##@ Documentation +help: ## Display this help + @awk 'BEGIN {FS = ":.*##"; printf "Makefile Usage:\n make \033[36m\033[0m\n"} /^[.a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) + diff --git a/certifiable-build/README.md b/certifiable-build/README.md new file mode 100644 index 0000000..357e748 --- /dev/null +++ b/certifiable-build/README.md @@ -0,0 +1,51 @@ +# Certifiable Build + +This repository contains the build infrastructure that supports the [build2](https://www.build2.org) tools for developers and CI systems like GitHub Actions for projects in this organization. + +The repository is included via `git subtree` in the individual component repositories. + +## Building Components + +All components are built using the same four step process: + +1. `make setup` installs the compilers and build2 tools; +1. `make config` configures the source code for building; +1. `make build` builds the source code into artifacts; +1. `make test` runs the tests for the component. + +If you wish, you can skip the `make setup` step and install the required C/C++ compilers and build2 tools yourself. + +## License + +**Dual Licensed:** + +* **Open Source:** GNU General Public License v3.0 (GPLv3) +* **Commercial:** Available for proprietary use in safety-critical systems + +For commercial licensing and compliance documentation packages, contact below. + +## Patent Protection + +This implementation is built on the **Murray Deterministic Computing Platform (MDCP)**, +protected by UK Patent **GB2521625.0**. + +For commercial licensing inquiries: william@fstopify.com + +## About + +Built by **SpeyTech** in the Scottish Highlands. + +30 years of UNIX infrastructure experience applied to deterministic computing for safety-critical systems. + +Patent: UK GB2521625.0 - Murray Deterministic Computing Platform (MDCP) + +**Contact:** +William Murray +william@fstopify.com +[speytech.com](https://speytech.com) + +--- + +*Building deterministic AI systems for when lives depend on the answer.* + +Copyright © 2026 The Murray Family Innovation Trust. All rights reserved. diff --git a/certifiable-build/etc/lima/tt-metal-dev.yaml b/certifiable-build/etc/lima/tt-metal-dev.yaml new file mode 100644 index 0000000..7f6b48e --- /dev/null +++ b/certifiable-build/etc/lima/tt-metal-dev.yaml @@ -0,0 +1,21 @@ +# certifiable-build/etc/lima/tt-metal-dev.yaml +vmType: "qemu" +arch: "x86_64" +plain: true +base: + - template://_images/ubuntu +images: + - location: "ghcr.io/tenstorrent/tt-metal/tt-metalium/ubuntu-22.04-dev-amd64:d6958801d86fe1e20a07f2be7795fac0b2c9b211" + arch: x86_64 + +cpus: 8 +memory: "16GiB" +disk: "80GiB" + +mounts: + - location: "~" + writable: true + +containerd: + system: false + user: false diff --git a/certifiable-build/github/workflows/ci.yml b/certifiable-build/github/workflows/ci.yml new file mode 100644 index 0000000..a688531 --- /dev/null +++ b/certifiable-build/github/workflows/ci.yml @@ -0,0 +1,24 @@ +name: CI + +on: + push: + pull_request: + +permissions: + contents: read + +concurrency: + group: ci-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + build: + uses: vivarium-ai/certifiable-github/.github/workflows/ci.yml@master + with: + build-target: certifiable-inference + + tt-build: + uses: vivarium-ai/certifiable-github/.github/workflows/tt-ci.yml@master + with: + build-target: certifiable-inference + tt_dev_image: ghcr.io/tenstorrent/tt-metal/tt-metalium/ubuntu-22.04-dev-amd64:d6958801d86fe1e20a07f2be7795fac0b2c9b211 diff --git a/certifiable-build/scripts/build.sh b/certifiable-build/scripts/build.sh new file mode 100755 index 0000000..98aac7d --- /dev/null +++ b/certifiable-build/scripts/build.sh @@ -0,0 +1,10 @@ +#!/bin/sh +set -eu + +SCRIPT_DIR=$(CDPATH='' cd -- "$(dirname "$0")" && pwd) +REPO_ROOT=$(CDPATH='' cd -- "$SCRIPT_DIR/../.." && pwd) +cd "$REPO_ROOT" + +BDEP=${BDEP:-bdep} + +"$BDEP" update -a @clang @gcc diff --git a/certifiable-build/scripts/clean.sh b/certifiable-build/scripts/clean.sh new file mode 100755 index 0000000..0d7ee7b --- /dev/null +++ b/certifiable-build/scripts/clean.sh @@ -0,0 +1,69 @@ +#!/bin/sh +set -eu + +usage() { + code=${1:-1} + cat </dev/null 2>&1 || true +"$BDEP" deinit --force -a @clang >/dev/null 2>&1 || true +"$BDEP" config remove @gcc >/dev/null 2>&1 || true +"$BDEP" config remove @clang >/dev/null 2>&1 || true + +"$BDEP" --no-default-options init --wipe -C "$clang_dir" @clang cc \ + "config.c=$CC_CLANG" "config.cxx=$CXX_CLANG" \ + "config.config.mode=$BUILD_TYPE" \ + "config.install.root=$PREFIX" + +"$BDEP" --no-default-options init --wipe -C "$gcc_dir" @gcc cc \ + "config.c=$CC_GCC" "config.cxx=$CXX_GCC" \ + "config.config.mode=$BUILD_TYPE" diff --git a/certifiable-build/scripts/install.sh b/certifiable-build/scripts/install.sh new file mode 100755 index 0000000..94a68e7 --- /dev/null +++ b/certifiable-build/scripts/install.sh @@ -0,0 +1,23 @@ +#!/bin/sh +set -eu + +usage() { + cat <-gcc) + PREFIX: Install prefix (env: PREFIX, default: /usr/local) +EOF + exit 1 +} + +cd "$(dirname "$0")/../.." || exit 1 +SRCDIR="$(basename "$(pwd)")" +BUILD_DIR="${1:-${BUILD_DIR:-../$SRCDIR-gcc}}" +PREFIX="${2:-${PREFIX:-/usr/local}}" +B="${B:-b}" + +[ -d "$BUILD_DIR" ] || { echo "Build directory not found. Run build first."; exit 1; } + +echo "Installing to $PREFIX..." +"$B" install: "$BUILD_DIR" \ + "config.install.root=$PREFIX" diff --git a/certifiable-build/scripts/package.sh b/certifiable-build/scripts/package.sh new file mode 100755 index 0000000..58dda3b --- /dev/null +++ b/certifiable-build/scripts/package.sh @@ -0,0 +1,26 @@ +#!/bin/sh +set -eu + +usage() { + cat <-gcc) + VERSION: Package version (env: VERSION, required) + REVISION: Package revision (env: REVISION, required) +EOF + exit 1 +} + +cd "$(dirname "$0")/../.." || exit 1 +SRCDIR="$(basename "$(pwd)")" +BUILD_DIR="${1:-${BUILD_DIR:-../$SRCDIR-gcc}}" +VERSION="${2:-${VERSION:-}}" +REVISION="${3:-${REVISION:-}}" + +[ -z "$VERSION" ] && usage +[ -z "$REVISION" ] && usage +[ -d "$BUILD_DIR" ] || { echo "Build directory not found. Run build first."; exit 1; } + +echo "Creating package $VERSION-$REVISION..." +# Add packaging logic here +echo "Package created." diff --git a/certifiable-build/scripts/release.sh b/certifiable-build/scripts/release.sh new file mode 100755 index 0000000..7b8c8a0 --- /dev/null +++ b/certifiable-build/scripts/release.sh @@ -0,0 +1,18 @@ +#!/bin/sh +set -eu + +usage() { + cat </dev/null 2>&1; then + echo "Homebrew already installed." +else + NONINTERACTIVE=1 /bin/bash -c \ + "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" + + case "$OS" in + Linux) + test -d ~/.linuxbrew && eval "$(~/.linuxbrew/bin/brew shellenv)" + test -d /home/linuxbrew/.linuxbrew && eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" + echo "eval \"\$($(brew --prefix)/bin/brew shellenv)\"" >> ~/.bashrc + ;; + Darwin) + if [ -x /opt/homebrew/bin/brew ]; then + eval "$(/opt/homebrew/bin/brew shellenv)" + return 0 + elif [ -x /usr/local/bin/brew ]; then + eval "$(/usr/local/bin/brew shellenv)" + return 0 + fi + ;; + *) + echo "Unsupported OS: $OS" + exit 1 + ;; + esac +fi + +echo "Homebrew version:" +brew --version + +brew update +brew install --overwrite --force gcc llvm build2 +brew link --overwrite --force gcc llvm build2 + +gcc --version +g++ --version +clang --version +clang++ --version +bdep --version + +echo "System dependencies installed successfully." diff --git a/certifiable-build/scripts/start-tt.sh b/certifiable-build/scripts/start-tt.sh new file mode 100755 index 0000000..c52f3f6 --- /dev/null +++ b/certifiable-build/scripts/start-tt.sh @@ -0,0 +1,136 @@ +#!/bin/sh +set -eu + +# Optional env: +# TT_RUNTIME=lima|podman|docker (force runtime selection) +# TT_LIMA_INSTANCE=tt-metal-dev (override Lima instance name) +# TT_LIMA_CONFIG=path/to/yaml (override Lima config file) +# TT_IMAGE=ghcr.io/...:tag (override container image) + +echo "Starting TT environment…" + +# Resolve repo root (prefer git, fall back to current directory) +if command -v git >/dev/null 2>&1 && git rev-parse --show-toplevel >/dev/null 2>&1; then + REPO_ROOT="$(git rev-parse --show-toplevel)" +else + REPO_ROOT="$(pwd)" +fi + +# Normalize REPO_ROOT (best-effort) +# shellcheck disable=SC2164 +cd "$REPO_ROOT" +REPO_ROOT="$(pwd)" + +IMAGE_DEFAULT="ghcr.io/tenstorrent/tt-metal/tt-metalium/ubuntu-22.04-dev-amd64:d6958801d86fe1e20a07f2be7795fac0b2c9b211" +TT_IMAGE="${TT_IMAGE:-$IMAGE_DEFAULT}" + +OS="$(uname -s)" + +TT_LIMA_INSTANCE="${TT_LIMA_INSTANCE:-tt-metal-dev}" +TT_LIMA_CONFIG="${TT_LIMA_CONFIG:-certifiable-build/etc/lima/tt-metal-dev.yaml}" + +# Choose runtime +choose_runtime() { + # If user forced it, obey. + if [ "${TT_RUNTIME:-}" != "" ]; then + echo "$TT_RUNTIME" + return + fi + + case "$OS" in + Darwin) + # Default to Lima on macOS. + echo "lima" + ;; + Linux) + if command -v podman >/dev/null 2>&1; then + echo "podman" + elif command -v docker >/dev/null 2>&1; then + echo "docker" + else + echo "none" + fi + ;; + *) + echo "none" + ;; + esac +} + +RUNTIME="$(choose_runtime)" + +run_container() { + runtime="$1" + + if ! command -v "$runtime" >/dev/null 2>&1; then + echo "Error: requested runtime '$runtime' not found in PATH." + exit 1 + fi + + # Pick a sensible interactive shell inside the container. + # Most of these images have bash; fall back to sh if not. + SHELL_CMD='if command -v bash >/dev/null 2>&1; then exec bash -l; else exec sh -l; fi' + + echo "Using $runtime to run container:" + echo " Image: $TT_IMAGE" + echo " Repo: $REPO_ROOT" + + # --userns=keep-id helps on podman (Linux); harmless or ignored elsewhere. + # We do NOT set --user because macOS Docker Desktop file permissions are quirky; + # on Linux you can add it later if you care. + exec "$runtime" run --rm -it \ + -v "$REPO_ROOT:$REPO_ROOT" \ + -w "$REPO_ROOT" \ + --userns=keep-id \ + "$TT_IMAGE" \ + sh -lc "$SHELL_CMD" +} + +run_lima() { + if ! command -v limactl >/dev/null 2>&1; then + echo "Error: limactl not found. Install Lima (e.g., brew install lima)." + exit 1 + fi + + if [ ! -f "$TT_LIMA_CONFIG" ]; then + echo "Error: Lima config not found at: $TT_LIMA_CONFIG" + echo "Set TT_LIMA_CONFIG to the correct path." + exit 1 + fi + + # Create/start instance if needed. + if limactl list -q | grep -Fx "$TT_LIMA_INSTANCE" >/dev/null 2>&1; then + : # instance exists + else + echo "Creating Lima instance '$TT_LIMA_INSTANCE' from $TT_LIMA_CONFIG…" + limactl create --name="$TT_LIMA_INSTANCE" "$TT_LIMA_CONFIG" + fi + + echo "Starting Lima instance '$TT_LIMA_INSTANCE'…" + limactl start "$TT_LIMA_INSTANCE" >/dev/null + + # Drop into an interactive shell, cd to repo root. + # Note: With your current Lima YAML (containerd disabled), this lands you in the VM. + # If you truly want "container inside Lima", enable containerd or run a container runtime in the VM. + echo "Entering Lima shell (VM) at repo root: $REPO_ROOT" + exec limactl shell "$TT_LIMA_INSTANCE" -- sh -lc "cd '$REPO_ROOT' && if command -v bash >/dev/null 2>&1; then exec bash -l; else exec sh -l; fi" +} + +case "$RUNTIME" in + docker|podman) + run_container "$RUNTIME" + ;; + lima) + # If user set TT_RUNTIME=docker/podman, they get a container on macOS too. + run_lima + ;; + none) + echo "Unsupported or missing runtime on OS '$OS'." + echo "On Linux install podman or docker. On macOS install lima (or set TT_RUNTIME=docker/podman if you insist)." + exit 1 + ;; + *) + echo "Error: unknown TT_RUNTIME='$RUNTIME' (expected lima|docker|podman)." + exit 1 + ;; +esac diff --git a/certifiable-build/scripts/test.sh b/certifiable-build/scripts/test.sh new file mode 100755 index 0000000..ee46bf5 --- /dev/null +++ b/certifiable-build/scripts/test.sh @@ -0,0 +1,10 @@ +#!/bin/sh +set -eu + +SCRIPT_DIR=$(CDPATH='' cd -- "$(dirname "$0")" && pwd) +REPO_ROOT=$(CDPATH='' cd -- "$SCRIPT_DIR/../.." && pwd) +cd "$REPO_ROOT" + +BDEP=${BDEP:-bdep} + +"$BDEP" test -a @clang @gcc diff --git a/examples/buildfile b/examples/buildfile new file mode 100644 index 0000000..9310d72 --- /dev/null +++ b/examples/buildfile @@ -0,0 +1,13 @@ +exes = exe{train_xor verify_step} + +./: ../src/ + +exe{train_xor}: c{train_xor} ../src/liba{certifiable_training} +exe{verify_step}: c{verify_step} ../src/liba{certifiable_training} + +$exes: +{ + c.libs += -lm +} + +./: $exes diff --git a/include/buildfile b/include/buildfile new file mode 100644 index 0000000..b1f0774 --- /dev/null +++ b/include/buildfile @@ -0,0 +1,23 @@ +intf_libs = # Interface dependencies. +#import xxxx_libs += libhello%lib{hello} + +lib{certifiable-training}: h{**} $intf_libs + +# Export options. +# +out_pfx = [dir_path] $out_root/include/ +src_pfx = [dir_path] $src_root/include/ + +lib{certifiable-training}: +{ + c.export.poptions = "-I$out_pfx" "-I$src_pfx" + c.export.libs = $intf_libs +} + +# Install recreating subdirectories. +# +h{*}: +{ + install = include/ + install.subdirs = true +} diff --git a/manifest b/manifest new file mode 100644 index 0000000..e0768f4 --- /dev/null +++ b/manifest @@ -0,0 +1,14 @@ +: 1 +name: certifiable-training +version: 0.1.0-a.0.z +type: lib,binless +language: c +summary: Certifiable inference engine with deterministic behavior +license: other: proprietary +description-file: README.md +package-description-file: PACKAGE-README.md +url: https://github.com/SpeyTech/certifiable-training +package-url: https://github.com/SpeyTech/certifiable-training +package-email: packaging@build2.org ; Mailing list. +depends: * build2 >= 0.16.0 +depends: * bpkg >= 0.16.0 diff --git a/repositories.manifest b/repositories.manifest new file mode 100644 index 0000000..ad7d550 --- /dev/null +++ b/repositories.manifest @@ -0,0 +1,11 @@ +: 1 +summary: certifiable-training project repository + +#: +#role: prerequisite +#location: https://pkg.cppget.org/1/stable +#trust: ... + +#: +#role: prerequisite +#location: https://git.build2.org/hello/libhello.git diff --git a/src/audit/merkle.c b/src/audit/merkle.c index 72793bb..f480ea4 100644 --- a/src/audit/merkle.c +++ b/src/audit/merkle.c @@ -112,6 +112,17 @@ void ct_sha256_init(ct_sha256_ctx_t *ctx) { ctx->count = 0; } +/* GCC -fanalyzer false positive: interprocedural analysis through the + * (const void *data) parameter cannot prove that callers have initialised + * every byte of the buffer passed to ct_sha256_update. All callers fill + * their buffers completely via write_u32_le / write_u64_le / write_i32_le + * before calling this function. See CT-MATH-001 §16 for the proof that + * the header layout is fully covered. */ +#if defined(__GNUC__) && !defined(__clang__) && (__GNUC__ >= 13) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wanalyzer-use-of-uninitialized-value" +#endif + void ct_sha256_update(ct_sha256_ctx_t *ctx, const void *data, size_t len) { const uint8_t *p = (const uint8_t *)data; size_t buf_idx = (size_t)(ctx->count & 63); @@ -145,6 +156,10 @@ void ct_sha256_update(ct_sha256_ctx_t *ctx, const void *data, size_t len) { } } +#if defined(__GNUC__) && !defined(__clang__) +#pragma GCC diagnostic pop +#endif + void ct_sha256_final(ct_sha256_ctx_t *ctx, uint8_t hash[CT_HASH_SIZE]) { size_t buf_idx = (size_t)(ctx->count & 63); uint64_t bit_count = ctx->count * 8; diff --git a/src/buildfile b/src/buildfile new file mode 100644 index 0000000..a97a7dd --- /dev/null +++ b/src/buildfile @@ -0,0 +1,9 @@ +liba{certifiable_training}: \ + c{**/**.c} \ + h{../include/**.h} +{ + export = true + install = true +} + +./: liba{certifiable_training} diff --git a/tests/.gitignore b/tests/.gitignore new file mode 100644 index 0000000..662178d --- /dev/null +++ b/tests/.gitignore @@ -0,0 +1,8 @@ +# Test executables. +# +driver + +# Testscript output directories (can be symlinks). +# +test +test-* diff --git a/tests/buildfile b/tests/buildfile new file mode 100644 index 0000000..56a2778 --- /dev/null +++ b/tests/buildfile @@ -0,0 +1,3 @@ +import unit = unit/ + +./: unit/ diff --git a/tests/unit/buildfile b/tests/unit/buildfile new file mode 100644 index 0000000..79b5ca6 --- /dev/null +++ b/tests/unit/buildfile @@ -0,0 +1,21 @@ +tests = exe{test_backward test_bit_identity test_compensated test_forward test_merkle test_optimizer test_permutation test_primitives test_prng test_reduction} + +exe{test_backward}: c{test_backward} ../../src/liba{certifiable_training} +exe{test_bit_identity}: c{test_bit_identity} ../../src/liba{certifiable_training} +exe{test_compensated}: c{test_compensated} ../../src/liba{certifiable_training} +exe{test_forward}: c{test_forward} ../../src/liba{certifiable_training} +exe{test_merkle}: c{test_merkle} ../../src/liba{certifiable_training} +exe{test_optimizer}: c{test_optimizer} ../../src/liba{certifiable_training} +exe{test_permutation}: c{test_permutation} ../../src/liba{certifiable_training} +exe{test_primitives}: c{test_primitives} ../../src/liba{certifiable_training} +exe{test_prng}: c{test_prng} ../../src/liba{certifiable_training} +exe{test_reduction}: c{test_reduction} ../../src/liba{certifiable_training} + +$tests: +{ + c.coptions += -UNDEBUG + c.libs += -lm + test = true +} + +./: $tests