diff options
author | Henri Chataing <henrichataing@google.com> | 2023-10-24 09:36:55 +0000 |
---|---|---|
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | 2023-10-24 09:36:55 +0000 |
commit | ed40f8e3bf0699b7794417e669ed2219f3433389 (patch) | |
tree | 19bc6fbb8b36697fc0c5352fc51cc233385b885c | |
parent | 18ee7a9e1cce70a3839dd2a519d3c1301d682b2c (diff) | |
parent | 42955e2a200acb81007c67251964f3874b6f2d93 (diff) | |
download | pdl-runtime-ed40f8e3bf0699b7794417e669ed2219f3433389.tar.gz |
Import platform/external/rust/crates/pdl-runtime am: 42955e2a20
Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/pdl-runtime/+/2799356
Change-Id: Iace18a5a480138813fd1a762fc659517491f65dd
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
-rw-r--r-- | Android.bp | 24 | ||||
-rw-r--r-- | Cargo.toml | 38 | ||||
-rw-r--r-- | Cargo.toml.orig | 19 | ||||
-rw-r--r-- | LICENSE | 202 | ||||
-rw-r--r-- | METADATA | 19 | ||||
-rw-r--r-- | MODULE_LICENSE_APACHE2 | 0 | ||||
-rw-r--r-- | OWNERS | 2 | ||||
-rw-r--r-- | README.md | 49 | ||||
-rw-r--r-- | src/lib.rs | 59 |
9 files changed, 412 insertions, 0 deletions
diff --git a/Android.bp b/Android.bp new file mode 100644 index 0000000..d660707 --- /dev/null +++ b/Android.bp @@ -0,0 +1,24 @@ +// This file is generated by cargo2android.py --run --device --tests. +// Do not modify this file as changes will be overridden on upgrade. + + + +rust_library { + name: "libpdl_runtime", + host_supported: true, + crate_name: "pdl_runtime", + cargo_env_compat: true, + cargo_pkg_version: "0.2.1", + srcs: ["src/lib.rs"], + edition: "2021", + rustlibs: [ + "libbytes", + "libthiserror", + ], + apex_available: [ + "//apex_available:platform", + "//apex_available:anyapex", + ], + product_available: true, + vendor_available: true, +} diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..57a1e84 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,38 @@ +# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO +# +# When uploading crates to the registry Cargo will automatically +# "normalize" Cargo.toml files for maximal compatibility +# with all versions of Cargo and also rewrite `path` dependencies +# to registry (e.g., crates.io) dependencies. +# +# If you are reading this file be aware that the original Cargo.toml +# will likely look very different (and much more reasonable). +# See Cargo.toml.orig for the original contents. + +[package] +edition = "2021" +name = "pdl-runtime" +version = "0.2.1" +authors = [ + "Henri Chataing <henrichataing@google.com>", + "David de Jesus Duarte <licorne@google.com>", + "Martin Geisler <mgeisler@google.com>", +] +description = "PDL's runtime library" +readme = "README.md" +keywords = [ + "pdl", + "parser", + "serializer", + "grammar", +] +categories = ["parsing"] +license = "Apache-2.0" +repository = "https://github.com/google/pdl/" +resolver = "1" + +[dependencies.bytes] +version = "1.4.0" + +[dependencies.thiserror] +version = "1.0.47" diff --git a/Cargo.toml.orig b/Cargo.toml.orig new file mode 100644 index 0000000..56311b3 --- /dev/null +++ b/Cargo.toml.orig @@ -0,0 +1,19 @@ +[package] +name = "pdl-runtime" +version = "0.2.1" +edition = "2021" +description = "PDL's runtime library" +repository = "https://github.com/google/pdl/" +license = "Apache-2.0" +readme = "../README.md" +keywords = ["pdl", "parser", "serializer", "grammar"] +authors = [ + "Henri Chataing <henrichataing@google.com>", + "David de Jesus Duarte <licorne@google.com>", + "Martin Geisler <mgeisler@google.com>" +] +categories = ["parsing"] + +[dependencies] +bytes = "1.4.0" +thiserror = "1.0.47" @@ -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..bef278d --- /dev/null +++ b/METADATA @@ -0,0 +1,19 @@ +name: "pdl-runtime" +description: "PDL\'s runtime library" +third_party { + identifier { + type: "crates.io" + value: "https://crates.io/crates/pdl-runtime" + } + identifier { + type: "Archive" + value: "https://static.crates.io/crates/pdl-runtime/pdl-runtime-0.2.1.crate" + } + version: "0.2.1" + license_type: NOTICE + last_upgrade_date { + year: 2023 + month: 10 + day: 18 + } +} diff --git a/MODULE_LICENSE_APACHE2 b/MODULE_LICENSE_APACHE2 new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/MODULE_LICENSE_APACHE2 @@ -0,0 +1,2 @@ +include platform/prebuilts/rust:main:/OWNERS +henrichataing@google.com diff --git a/README.md b/README.md new file mode 100644 index 0000000..1396b3d --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Packet Description Language (PDL) + +[![Crate](https://img.shields.io/crates/v/pdl-compiler?style=flat-square)](https://crates.io/crates/pdl-compiler) +[![Build workflow](https://img.shields.io/github/actions/workflow/status/google/pdl/build.yml?style=flat-square)](https://github.com/google/pdl/actions/workflows/build.yml?query=branch%3Amain) +[![GitHub contributors](https://img.shields.io/github/contributors/google/pdl?style=flat-square)](https://github.com/google/pdl/graphs/contributors) +[![GitHub stars](https://img.shields.io/github/stars/google/pdl?style=flat-square)](https://github.com/google/pdl/stargazers) + +PDL is a domain specific language for writing the definition of binary protocol +packets. Parsing and validating packets from raw bytes is tedious and error +prone in any language. PDL generates memory safe and tailored backends for +multiple target languages: + + - Rust + - C++ + - Python + +Historically PDL was developed as part of the Android Bluetooth stack +([bluetooth_packetgen](https://cs.android.com/android/platform/superproject/+/master:packages/modules/Bluetooth/system/gd/packet/)) +as a way to generate the parser and serializer for Bluetooth packets, and +reduce the number of memory safety issues that come with manipulating +and validating raw data. + +## How to use PDL + +1. Write the protocol definition +1. `cargo run my-protocol.pdl --output-format rust > my-protocol.rs` + +Language specific instructions are provided for all supported backends: + +1. [Rust generated code guide](doc/rust-generated-code-guide.rst) +1. [Python generated code guide](doc/python-generated-code-guide.rst) +1. [C++ generated code guide](doc/cxx-generated-code-guide.rst) + +## Supported Features + +[Full reference documentation](doc/reference.md) +- Scalar values +- Enumerators +- Arrays +- Optional fields +- Nested packets +- Conditional packet derivation +- Custom field definitions + +## Similar projects + +- [Kaitai](https://kaitai.io) +- [EMBOSS](https://github.com/kimrutherford/EMBOSS) +- [P4](https://p4.org/p4-spec/docs/P4-16-v1.0.0-spec.html) diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..728a7c2 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,59 @@ +// Copyright 2023 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. + +//! Helper definitions used used by the generated Rust backend. + +use bytes::Bytes; +use thiserror::Error; + +/// Type of parsing errors. +#[derive(Debug, Error, PartialEq, Eq)] +pub enum Error { + #[error("Packet parsing failed")] + InvalidPacketError, + #[error("{field} was {value:x}, which is not known")] + ConstraintOutOfBounds { field: String, value: u64 }, + #[error("Got {actual:x}, expected {expected:x}")] + InvalidFixedValue { expected: u64, actual: u64 }, + #[error("when parsing {obj} needed length of {wanted} but got {got}")] + InvalidLengthError { obj: String, wanted: usize, got: usize }, + #[error("array size ({array} bytes) is not a multiple of the element size ({element} bytes)")] + InvalidArraySize { array: usize, element: usize }, + #[error("Due to size restrictions a struct could not be parsed.")] + ImpossibleStructError, + #[error("when parsing field {obj}.{field}, {value} is not a valid {type_} value")] + InvalidEnumValueError { obj: String, field: String, value: u64, type_: String }, + #[error("expected child {expected}, got {actual}")] + InvalidChildError { expected: &'static str, actual: String }, +} + +/// Trait implemented for all toplevel packet declarations. +pub trait Packet { + fn to_bytes(self) -> Bytes; + fn to_vec(self) -> Vec<u8>; +} + +/// Private prevents users from creating arbitrary scalar values +/// in situations where the value needs to be validated. +/// Users can freely deref the value, but only the backend +/// may create it. +#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)] +pub struct Private<T>(T); + +impl<T> std::ops::Deref for Private<T> { + type Target = T; + fn deref(&self) -> &Self::Target { + &self.0 + } +} |