From f05572478f5c344c80ad2ec2b8833df98b6a5b87 Mon Sep 17 00:00:00 2001 From: Steffen Smolka Date: Mon, 23 Sep 2024 15:22:12 -0700 Subject: [PATCH] Initialize repository --- BUILD | 13 +++ LICENSE | 202 +++++++++++++++++++++++++++++++++++++++++++ METADATA | 67 ++++++++++++++ README.md | 70 +++++++++++++++ docs/CONTRIBUTING.md | 32 +++++++ 5 files changed, 384 insertions(+) create mode 100644 BUILD create mode 100644 LICENSE create mode 100644 METADATA create mode 100644 README.md create mode 100644 docs/CONTRIBUTING.md diff --git a/BUILD b/BUILD new file mode 100644 index 0000000..344b1be --- /dev/null +++ b/BUILD @@ -0,0 +1,13 @@ +# NetKAT, a framework for describing and reasoning about packet-switched networks. + +load("//tools/build_defs/license:license.bzl", "license") + +package(default_applicable_licenses = [":license"]) + +# Define the license for this package, which is used as the default license +# for all targets in this package based on default_applicable_licenses above. +license(name = "license") + +licenses(["notice"]) + +exports_files(["LICENSE"]) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/METADATA b/METADATA new file mode 100644 index 0000000..1fd70cb --- /dev/null +++ b/METADATA @@ -0,0 +1,67 @@ +# go/google3metadata +# proto-file: devtools/metadata/metadata.proto +# proto-message: MetaData + +name: "NetKAT" +description: "Framework for describing and reasoning about packet-switched networks" + +third_party { + identifier { + type: "Piper" + value: "http://google3/third_party/netkat" + primary_source: true + } +} + +# Block submissions on SpongeMonitor findings. +presubmit: { + include_presubmit: "//depot/google3/testing/tools/sponge_monitor/blocking_presubmit.METADATA" + check_tests: { + project: "netkat" + } +} + +# Block submissions on Linter findings. +presubmit: { + check_lint { + base { + disable_tags: "ROLLBACK_OF" + disable_tags: "CLEANUP" + } + failure_status: ERROR + } +} + +presubmit: { + check_tricorder: { + action: SUBMIT + categories: "ClangTidy" + categories: "ErrorProne" + categories: "UnusedDeps" + categories: "TODONT" # go/todont + categories: "CppDefensiveCoding" # go/cpp-defensive-coding + } +} + +tricorder { + enable: TODONT # go/todont + enable: CppDefensiveCoding # go/cpp-defensive-coding + enable: TargetSizeLimits # go/targetsizelimits-presubmit + options { + cpp_defensive_coding: { + # Most critical CDC checks: + applicable_rules: POINTER_CHECKS + applicable_rules: MAYBE_NULL_CHECKS + + # Next most critical: + applicable_rules: OPTIONAL_CHECKS + applicable_rules: STATUS_OR_CHECKS + + # These checks have been shown to prevent crashes, but can be quite noisy + # on certain codebases. We recommend codebases enable them to gauge their + # effectiveness, and then disable them if they find them to be too noisy. + applicable_rules: VECTOR_CHECKS + applicable_rules: PROTO_CHECKS + } + } +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc43f74 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# NetKAT + +This is a C++ implementation of NetKAT. + +NetKAT is a domain specific language (DSL) and system for specifying, +programming, and reasoning about packet-switched networks. Key features include: + +* Automated reasoning and verification. +* Modular composition, supporting clean isolation and abstraction. +* Simple, yet very powerful syntax & semantics. +* Strong mathematical foundation. + +If you want to learn more, you may check out the list of +[publications on NetKAT](#academic-publications-on-netkat) below. In the future, +we also hope to provide a gentler introduction to NetKAT in the form of a +tutorial. + +Note: We expect that this NetKAT implementation may diverge from NeKAT as +described [in the literature](#academic-publications-on-netkat) over time, +as we take liberty to optimize and adjust the language for industrial use. + +## Disclaimer + +This is not an officially supported Google product. This project is not +eligible for the [Google Open Source Software Vulnerability Rewards +Program](https://bughunters.google.com/open-source-security). + +## Academic Publications on NetKAT + +NetKAT was first conceived and studied in academia. +Here, we list a small selection of key publications related to NetKAT. + +* **NetKAT: Semantic Foundations for Networks.** POPL 2014. + [[PDF]](https://www.cs.cornell.edu/~jnfoster/papers/frenetic-netkat.pdf) +* **A Fast Compiler for NetKAT.** ICFP 2015. + [[PDF]](https://www.cs.cornell.edu/~jnfoster/papers/netkat-compiler.pdf) +* **KATch: A Fast Symbolic Verifier for NetKAT.** PLDI 2024. + [[PDF]](https://research.google/pubs/katch-a-fast-symbolic-verifier-for-netkat/) + +## Contributing + +We would love to accept your patches and contributions to this project. Please +familiarize yourself with [our contribution process](docs/CONTRIBUTING.md). + +### Source Code Headers + +Every file containing source code must include copyright and license +information. + +Apache header: + + Copyright 2024 Google LLC + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +This can be done automatically using +[addlicense](https://github.com/google/addlicense) as follows: +```sh +addlicense -c "The P4-Constraints Authors" -l apache ./p4_constraints +``` diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..8956a61 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# How to Contribute + +We would love to accept your patches and contributions to this project. + +## Before you begin + +### Sign our Contributor License Agreement + +Contributions to this project must be accompanied by a +[Contributor License Agreement](https://cla.developers.google.com/about) (CLA). +You (or your employer) retain the copyright to your contribution; this simply +gives us permission to use and redistribute your contributions as part of the +project. + +If you or your current employer have already signed the Google CLA (even if it +was for a different project), you probably don't need to do it again. + +Visit to see your current agreements or to +sign a new one. + +### Review our Community Guidelines + +This project follows [Google's Open Source Community +Guidelines](https://opensource.google/conduct/). + +## Contribution process + +### Code Reviews + +All submissions, including submissions by project members, require review. We +use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests) +for this purpose.