Initial import of rusticata-macros-3.1.0
Bug: 193833713
Change-Id: I8c64a1f7a387fb4162d80d201b1cfcd7172ed0f3
diff --git a/.cargo_vcs_info.json b/.cargo_vcs_info.json
new file mode 100644
index 0000000..e5ef5a3
--- /dev/null
+++ b/.cargo_vcs_info.json
@@ -0,0 +1,5 @@
+{
+ "git": {
+ "sha1": "636cde7a9e61447c6f17f8cc665c32e7f70f319f"
+ }
+}
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..8e9dd2b
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+target
+Cargo.lock
+.*.swp
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..a376435
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,33 @@
+language: rust
+sudo: false
+matrix:
+ include:
+ - rust: stable
+ env:
+ - NAME="stable"
+ - FEATURES=''
+ - rust: stable
+ env:
+ - NAME="stable,clippy"
+ - FEATURES=''
+ - CLIPPY=yes
+ - rust: stable
+ env:
+ - NAME="stable,fmt"
+ - FEATURES=''
+ - RUSTFMT=yes
+ - rust: nightly
+ env:
+ - NAME="nightly"
+ - FEATURES=''
+ - BENCH=1
+before_script:
+ - ([ "$CLIPPY" != yes ] || rustup component add clippy)
+ - ([ "$RUSTFMT" != yes ] || rustup component add rustfmt)
+script:
+ - ([ "$CLIPPY" != yes ] || cargo clippy --all-features -- -D clippy::all)
+ - ([ "$RUSTFMT" != yes ] || cargo fmt --all -- --check)
+ - |
+ cargo build --verbose --features "$FEATURES" &&
+ cargo test --verbose --features "$FEATURES" &&
+ ([ "$BENCH" != 1 ] || cargo bench --verbose --features "$FEATURES")
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..1f5f076
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,26 @@
+# 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 believe there's an error in this file please file an
+# issue against the rust-lang/cargo repository. If you're
+# editing this file be aware that the upstream Cargo.toml
+# will likely look very different (and much more reasonable)
+
+[package]
+edition = "2018"
+name = "rusticata-macros"
+version = "3.1.0"
+authors = ["Pierre Chifflier <[email protected]>"]
+description = "Helper macros for Rusticata"
+homepage = "https://github.com/rusticata/rusticata-macros"
+readme = "README.md"
+keywords = ["parser", "nom", "serialize"]
+categories = ["parsing"]
+license = "MIT/Apache-2.0"
+repository = "https://github.com/rusticata/rusticata-macros.git"
+[dependencies.nom]
+version = "6.0"
diff --git a/Cargo.toml.orig b/Cargo.toml.orig
new file mode 100644
index 0000000..6c23803
--- /dev/null
+++ b/Cargo.toml.orig
@@ -0,0 +1,15 @@
+[package]
+name = "rusticata-macros"
+version = "3.1.0"
+description = "Helper macros for Rusticata"
+license = "MIT/Apache-2.0"
+keywords = ["parser","nom","serialize"]
+homepage = "https://github.com/rusticata/rusticata-macros"
+repository = "https://github.com/rusticata/rusticata-macros.git"
+authors = ["Pierre Chifflier <[email protected]>"]
+edition = "2018"
+categories = ["parsing"]
+readme = "README.md"
+
+[dependencies]
+nom = "6.0"
diff --git a/LICENSE b/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ 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/LICENSE-MIT b/LICENSE-MIT
new file mode 100644
index 0000000..290e7b9
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,25 @@
+Copyright (c) 2017 Pierre Chifflier
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/METADATA b/METADATA
new file mode 100644
index 0000000..ddd8570
--- /dev/null
+++ b/METADATA
@@ -0,0 +1,20 @@
+name: "rusticata-macros"
+description: "Helper macros for Rusticata"
+third_party {
+ url {
+ type: HOMEPAGE
+ value: "https://crates.io/crates/rusticata-macros"
+ }
+ url {
+ type: ARCHIVE
+ value: "https://static.crates.io/crates/rusticata-macros/rusticata-macros-3.1.0.crate"
+ }
+ version: "3.1.0"
+ # Dual-licensed, using the least restrictive per go/thirdpartylicenses#same.
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2021
+ month: 7
+ day: 9
+ }
+}
diff --git a/MODULE_LICENSE_APACHE2 b/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/MODULE_LICENSE_APACHE2
diff --git a/OWNERS b/OWNERS
new file mode 100644
index 0000000..3f9a6ad
--- /dev/null
+++ b/OWNERS
@@ -0,0 +1,4 @@
+include platform/prebuilts/rust:master:/OWNERS
+# Android Auto
[email protected]
[email protected]
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6defe1e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,110 @@
+# rusticata-macros
+
+[](./LICENSE-MIT)
+[](./LICENSE-APACHE)
+[](https://travis-ci.org/rusticata/rusticata-macros)
+[](https://github.com/rusticata/rusticata-macros/actions)
+[](https://crates.io/crates/rusticata-macros)
+
+<!-- cargo-sync-readme start -->
+
+# Rusticata-macros
+
+Helper macros for the [rusticata](https://github.com/rusticata) project.
+
+This crate contains some additions to [nom](https://github.com/Geal/nom).
+
+For example, the `error_if!` macro allows to test a condition and return an error from the parser if the condition
+fails:
+
+```rust
+use rusticata_macros::error_if;
+let r : IResult<&[u8],()> = do_parse!(
+ s,
+ l: be_u8 >>
+ error_if!(l < 4, ErrorKind::Verify) >>
+ data: take!(l - 4) >>
+ (())
+ );
+```
+
+See the documentation for more details and examples.
+
+<!-- cargo-sync-readme end -->
+
+## Nom versions
+
+Different versions of this crate are available, depending on nom version.
+
+- `rusticata-macros` 0.3.x depends on nom 6
+- `rusticata-macros` 0.2.x depends on nom 5
+
+## Documentation
+
+Crate is documented, do running `cargo doc` will crate the offline documentation.
+
+Reference documentation can be found [here](https://docs.rs/rusticata-macros/)
+
+## Changes
+
+### 3.0.1
+
+- Add `be_var_u64` and `le_var_u64`
+
+### 3.0.0
+
+- Upgrade to nom 6
+
+### 2.1.0
+
+- Add common trait `Serialize` for structures serialization
+
+### 2.0.4
+
+- Add function version of most combinators
+
+### 2.0.3
+
+- Add macros `q` (quote) and `align32`
+
+### 2.0.2
+
+- Add `upgrade_error` and `upgrade_error_to`
+
+### 2.0.1
+
+- Add macro `custom_check`
+- Add macro `flat_take`
+
+### 2.0.0
+
+- Upgrade to nom 5
+- Debug types: use newtypes
+
+### 1.1.0
+
+- Add macro `newtype_enum`
+
+### 1.0.0
+
+- Upgrade to nom 4.0
+ - Warning: this is a breaking change!
+- Mark `parse_uint24` as deprecated
+
+## License
+
+Licensed under either of
+
+ * Apache License, Version 2.0
+ ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license
+ ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
+
diff --git a/benches/bench.rs b/benches/bench.rs
new file mode 100644
index 0000000..250f5be
--- /dev/null
+++ b/benches/bench.rs
@@ -0,0 +1,17 @@
+#![feature(test)]
+
+extern crate test;
+use test::Bencher;
+
+extern crate rusticata_macros;
+
+use rusticata_macros::bytes_to_u64;
+
+#[bench]
+fn bench_bytes_to_u64(b: &mut Bencher) {
+ let bytes = &[0x12, 0x34, 0x56, 0x78, 0x90, 0x12];
+ b.iter(|| {
+ let res = bytes_to_u64(bytes);
+ assert_eq!(res, Ok(0x123456789012));
+ });
+}
diff --git a/src/combinator.rs b/src/combinator.rs
new file mode 100644
index 0000000..f5de774
--- /dev/null
+++ b/src/combinator.rs
@@ -0,0 +1,210 @@
+//! General purpose combinators
+
+use nom::bytes::streaming::take;
+use nom::combinator::map_parser;
+pub use nom::error::{make_error, ErrorKind, ParseError};
+pub use nom::{IResult, Needed};
+use nom::{InputIter, InputTake};
+use nom::{InputLength, ToUsize};
+
+/// Read the entire slice as a big endian unsigned integer, up to 8 bytes
+#[inline]
+pub fn be_var_u64<'a, E: ParseError<&'a [u8]>>(input: &'a [u8]) -> IResult<&'a [u8], u64, E> {
+ if input.is_empty() {
+ return Err(nom::Err::Incomplete(Needed::new(1)));
+ }
+ if input.len() > 8 {
+ return Err(nom::Err::Error(make_error(input, ErrorKind::TooLarge)));
+ }
+ let mut res = 0u64;
+ for byte in input {
+ res = (res << 8) + *byte as u64;
+ }
+
+ Ok((&b""[..], res))
+}
+
+/// Read the entire slice as a little endian unsigned integer, up to 8 bytes
+#[inline]
+pub fn le_var_u64<'a, E: ParseError<&'a [u8]>>(input: &'a [u8]) -> IResult<&'a [u8], u64, E> {
+ if input.is_empty() {
+ return Err(nom::Err::Incomplete(Needed::new(1)));
+ }
+ if input.len() > 8 {
+ return Err(nom::Err::Error(make_error(input, ErrorKind::TooLarge)));
+ }
+ let mut res = 0u64;
+ for byte in input.iter().rev() {
+ res = (res << 8) + *byte as u64;
+ }
+
+ Ok((&b""[..], res))
+}
+
+/// Read a slice as a big-endian value.
+#[inline]
+pub fn parse_hex_to_u64<S>(i: &[u8], size: S) -> IResult<&[u8], u64>
+where
+ S: ToUsize + Copy,
+{
+ map_parser(take(size.to_usize()), be_var_u64)(i)
+}
+
+/// Apply combinator, automatically converts between errors if the underlying type supports it
+pub fn upgrade_error<I, O, E1: ParseError<I>, E2: ParseError<I>, F>(
+ mut f: F,
+) -> impl FnMut(I) -> IResult<I, O, E2>
+where
+ F: FnMut(I) -> IResult<I, O, E1>,
+ E2: From<E1>,
+{
+ move |i| f(i).map_err(nom::Err::convert)
+}
+
+/// Create a combinator that returns the provided value, and input unchanged
+pub fn pure<I, O, E: ParseError<I>>(val: O) -> impl Fn(I) -> IResult<I, O, E>
+where
+ O: Clone,
+{
+ move |input: I| Ok((input, val.clone()))
+}
+
+/// Return a closure that takes `len` bytes from input, and applies `parser`.
+pub fn flat_take<I, C, O, E: ParseError<I>, F>(len: C, parser: F) -> impl Fn(I) -> IResult<I, O, E>
+where
+ I: InputTake + InputLength + InputIter,
+ C: ToUsize + Copy,
+ F: Fn(I) -> IResult<I, O, E>,
+{
+ // Note: this is the same as `map_parser(take(len), parser)`
+ move |input: I| {
+ let (input, o1) = take(len.to_usize())(input)?;
+ let (_, o2) = parser(o1)?;
+ Ok((input, o2))
+ }
+}
+
+/// Take `len` bytes from `input`, and apply `parser`.
+pub fn flat_takec<I: Clone, O, E: ParseError<I>, C, F>(
+ input: I,
+ len: C,
+ parser: F,
+) -> IResult<I, O, E>
+where
+ C: ToUsize + Copy,
+ F: Fn(I) -> IResult<I, O, E>,
+ I: InputTake + InputLength + InputIter,
+ O: InputLength,
+{
+ flat_take(len, parser)(input)
+}
+
+/// Helper macro for nom parsers: run first parser if condition is true, else second parser
+pub fn cond_else<I: Clone, O, E: ParseError<I>, C, F, G>(
+ cond: C,
+ first: F,
+ second: G,
+) -> impl Fn(I) -> IResult<I, O, E>
+where
+ C: Fn() -> bool,
+ F: Fn(I) -> IResult<I, O, E>,
+ G: Fn(I) -> IResult<I, O, E>,
+{
+ move |input: I| {
+ if cond() {
+ first(input)
+ } else {
+ second(input)
+ }
+ }
+}
+
+/// Align input value to the next multiple of n bytes
+/// Valid only if n is a power of 2
+pub const fn align_n2(x: usize, n: usize) -> usize {
+ (x + (n - 1)) & !(n - 1)
+}
+
+/// Align input value to the next multiple of 4 bytes
+pub const fn align32(x: usize) -> usize {
+ (x + 3) & !3
+}
+
+#[cfg(test)]
+mod tests {
+ use super::{align32, be_var_u64, cond_else, flat_take, pure};
+ use nom::bytes::streaming::take;
+ use nom::number::streaming::{be_u16, be_u32, be_u8};
+ use nom::{Err, IResult, Needed};
+
+ #[test]
+ fn test_be_var_u64() {
+ let res: IResult<&[u8], u64> = be_var_u64(b"\x12\x34\x56");
+ let (_, v) = res.expect("be_var_u64 failed");
+ assert_eq!(v, 0x123456);
+ }
+
+ #[test]
+ fn test_flat_take() {
+ let input = &[0x00, 0x01, 0xff];
+ // read first 2 bytes and use correct combinator: OK
+ let res: IResult<&[u8], u16> = flat_take(2u8, be_u16)(input);
+ assert_eq!(res, Ok((&input[2..], 0x0001)));
+ // read 3 bytes and use 2: OK (some input is just lost)
+ let res: IResult<&[u8], u16> = flat_take(3u8, be_u16)(input);
+ assert_eq!(res, Ok((&b""[..], 0x0001)));
+ // read 2 bytes and a combinator requiring more bytes
+ let res: IResult<&[u8], u32> = flat_take(2u8, be_u32)(input);
+ assert_eq!(res, Err(Err::Incomplete(Needed::new(2))));
+ }
+
+ #[test]
+ fn test_flat_take_str() {
+ let input = "abcdef";
+ // read first 2 bytes and use correct combinator: OK
+ let res: IResult<&str, &str> = flat_take(2u8, take(2u8))(input);
+ assert_eq!(res, Ok(("cdef", "ab")));
+ // read 3 bytes and use 2: OK (some input is just lost)
+ let res: IResult<&str, &str> = flat_take(3u8, take(2u8))(input);
+ assert_eq!(res, Ok(("def", "ab")));
+ // read 2 bytes and a use combinator requiring more bytes
+ let res: IResult<&str, &str> = flat_take(2u8, take(4u8))(input);
+ assert_eq!(res, Err(Err::Incomplete(Needed::Unknown)));
+ }
+
+ #[test]
+ fn test_cond_else() {
+ let input = &[0x01][..];
+ let empty = &b""[..];
+ let a = 1;
+ fn parse_u8(i: &[u8]) -> IResult<&[u8], u8> {
+ be_u8(i)
+ }
+ assert_eq!(
+ cond_else(|| a == 1, parse_u8, pure(0x02))(input),
+ Ok((empty, 0x01))
+ );
+ assert_eq!(
+ cond_else(|| a == 1, parse_u8, pure(0x02))(input),
+ Ok((empty, 0x01))
+ );
+ assert_eq!(
+ cond_else(|| a == 2, parse_u8, pure(0x02))(input),
+ Ok((input, 0x02))
+ );
+ assert_eq!(
+ cond_else(|| a == 1, pure(0x02), parse_u8)(input),
+ Ok((input, 0x02))
+ );
+ let res: IResult<&[u8], u8> = cond_else(|| a == 1, parse_u8, parse_u8)(input);
+ assert_eq!(res, Ok((empty, 0x01)));
+ }
+
+ #[test]
+ fn test_align32() {
+ assert_eq!(align32(3), 4);
+ assert_eq!(align32(4), 4);
+ assert_eq!(align32(5), 8);
+ assert_eq!(align32(5usize), 8);
+ }
+}
diff --git a/src/debug.rs b/src/debug.rs
new file mode 100644
index 0000000..eb4e821
--- /dev/null
+++ b/src/debug.rs
@@ -0,0 +1,54 @@
+//! Helper functions and structures for debugging purpose
+
+use std::fmt;
+
+/// Wrapper for printing value as u8 hex data
+pub struct HexU8(pub u8);
+
+impl fmt::Debug for HexU8 {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ write!(fmt, "0x{:02x}", self.0)
+ }
+}
+
+/// Wrapper for printing value as u16 hex data
+pub struct HexU16(pub u16);
+
+impl fmt::Debug for HexU16 {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ write!(fmt, "0x{:04x}", self.0)
+ }
+}
+
+/// Wrapper for printing slice as hex data
+pub struct HexSlice<'a>(pub &'a [u8]);
+
+impl<'a> fmt::Debug for HexSlice<'a> {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ let s: Vec<_> = self.0.iter().map(|&i| format!("{:02x}", i)).collect();
+ write!(fmt, "[{}]", s.join(" "))
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use crate::debug;
+
+ #[test]
+ fn debug_print_hexu8() {
+ assert_eq!(format!("{:?}", debug::HexU8(18)), "0x12");
+ }
+
+ #[test]
+ fn debug_print_hexu16() {
+ assert_eq!(format!("{:?}", debug::HexU16(32769)), "0x8001");
+ }
+
+ #[test]
+ fn debug_print_hexslice() {
+ assert_eq!(
+ format!("{:?}", debug::HexSlice(&[15, 16, 17, 18, 19, 20])),
+ "[0f 10 11 12 13 14]"
+ );
+ }
+}
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..c6f4344
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,51 @@
+//! # Rusticata-macros
+//!
+//! Helper macros for the [rusticata](https://github.com/rusticata) project.
+//!
+//! This crate contains some additions to [nom](https://github.com/Geal/nom).
+//!
+//! For example, the `error_if!` macro allows to test a condition and return an error from the parser if the condition
+//! fails:
+//!
+//! ```rust
+//! # extern crate rusticata_macros;
+//! # extern crate nom;
+//! # use nom::{do_parse, take, IResult};
+//! # use nom::error::ErrorKind;
+//! # use nom::number::streaming::be_u8;
+//! use rusticata_macros::error_if;
+//! # fn parser(s:&[u8]) {
+//! let r : IResult<&[u8],()> = do_parse!(
+//! s,
+//! l: be_u8 >>
+//! error_if!(l < 4, ErrorKind::Verify) >>
+//! data: take!(l - 4) >>
+//! (())
+//! );
+//! # }
+//! ```
+//!
+//! See the documentation for more details and examples.
+
+#![deny(
+ missing_docs,
+ unsafe_code,
+ unstable_features,
+ unused_import_braces,
+ unused_qualifications
+)]
+
+#[macro_use]
+extern crate nom;
+
+extern crate core;
+
+pub mod combinator;
+
+pub use macros::*;
+#[macro_use]
+pub mod macros;
+
+pub mod debug;
+mod traits;
+pub use traits::*;
diff --git a/src/macros.rs b/src/macros.rs
new file mode 100644
index 0000000..c74cb4e
--- /dev/null
+++ b/src/macros.rs
@@ -0,0 +1,406 @@
+//! Helper macros
+
+use nom::bytes::complete::take;
+use nom::combinator::map_res;
+use nom::combinator::rest;
+pub use nom::error::{make_error, ErrorKind, ParseError};
+use nom::HexDisplay;
+pub use nom::{IResult, Needed};
+
+#[doc(hidden)]
+pub mod export {
+ pub use core::{fmt, mem, ptr};
+}
+
+/// Helper macro for newtypes: declare associated constants and implement Display trait
+#[macro_export]
+macro_rules! newtype_enum (
+ (@collect_impl, $name:ident, $($key:ident = $val:expr),* $(,)*) => {
+ $( pub const $key : $name = $name($val); )*
+ };
+
+ (@collect_disp, $name:ident, $f:ident, $m:expr, $($key:ident = $val:expr),* $(,)*) => {
+ match $m {
+ $( $val => write!($f, stringify!{$key}), )*
+ n => write!($f, "{}({} / 0x{:x})", stringify!{$name}, n, n)
+ }
+ };
+
+ // entry
+ (impl $name:ident {$($body:tt)*}) => (
+ #[allow(non_upper_case_globals)]
+ impl $name {
+ newtype_enum!{@collect_impl, $name, $($body)*}
+ }
+ );
+
+ // entry with display
+ (impl display $name:ident {$($body:tt)*}) => (
+ newtype_enum!(impl $name { $($body)* });
+
+ impl $crate::export::fmt::Display for $name {
+ fn fmt(&self, f: &mut $crate::export::fmt::Formatter) -> $crate::export::fmt::Result {
+ newtype_enum!(@collect_disp, $name, f, self.0, $($body)*)
+ }
+ }
+ );
+
+ // entry with display and debug
+ (impl debug $name:ident {$($body:tt)*}) => (
+ newtype_enum!(impl display $name { $($body)* });
+
+ impl $crate::export::fmt::Debug for $name {
+ fn fmt(&self, f: &mut $crate::export::fmt::Formatter) -> $crate::export::fmt::Result {
+ write!(f, "{}", self)
+ }
+ }
+ );
+);
+
+/// Helper macro for nom parsers: raise error if the condition is true
+///
+/// This macro is used when using custom errors
+#[macro_export]
+macro_rules! custom_check (
+ ($i:expr, $cond:expr, $err:expr) => (
+ {
+ if $cond {
+ Err(::nom::Err::Error($err))
+ } else {
+ Ok(($i, ()))
+ }
+ }
+ );
+);
+
+/// Helper macro for nom parsers: raise error if the condition is true
+///
+/// This macro is used when using `ErrorKind`
+#[macro_export]
+macro_rules! error_if (
+ ($i:expr, $cond:expr, $err:expr) => (
+ {
+ use nom::error_position;
+ if $cond {
+ Err(::nom::Err::Error(error_position!($i, $err)))
+ } else {
+ Ok(($i, ()))
+ }
+ }
+ );
+);
+
+/// Helper macro for nom parsers: raise error if input is not empty
+///
+/// Deprecated - use `nom::eof`
+#[macro_export]
+#[deprecated(since = "2.0.0")]
+macro_rules! empty (
+ ($i:expr,) => (
+ {
+ use nom::eof;
+ eof!($i,)
+ }
+ );
+);
+
+/// Helper macro for nom parsers: run first parser if condition is true, else second parser
+#[macro_export]
+macro_rules! cond_else (
+ ($i:expr, $cond:expr, $expr_then:ident!($($args_then:tt)*), $expr_else:ident!($($args_else:tt)*)) => (
+ {
+ if $cond { $expr_then!($i, $($args_then)*) }
+ else { $expr_else!($i, $($args_else)*) }
+ }
+ );
+ ($i:expr, $cond:expr, $expr_then:expr, $expr_else:ident!($($args_else:tt)*)) => (
+ cond_else!($i, $cond, call!($expr_then), $expr_else!($($args_else)*))
+ );
+ ($i:expr, $cond:expr, $expr_then:ident!($($args_then:tt)*), $expr_else:expr) => (
+ cond_else!($i, $cond, $expr_then!($($args_then)*), call!($expr_else))
+ );
+ ($i:expr, $cond:expr, $expr_then:expr, $expr_else:expr) => (
+ cond_else!($i, $cond, call!($expr_then), call!($expr_else))
+ );
+);
+
+/// Dump the remaining bytes to stderr, formatted as hex
+pub fn dbg_dmp_rest(i: &[u8]) -> IResult<&[u8], ()> {
+ map!(i, peek!(call!(rest)), |r| eprintln!("\n{}\n", r.to_hex(16)))
+}
+
+#[deprecated(since = "3.0.1", note = "please use `be_var_u64` instead")]
+/// Read an entire slice as a big-endian value.
+///
+/// Returns the value as `u64`. This function checks for integer overflows, and returns a
+/// `Result::Err` value if the value is too big.
+pub fn bytes_to_u64(s: &[u8]) -> Result<u64, &'static str> {
+ let mut u: u64 = 0;
+
+ if s.is_empty() {
+ return Err("empty");
+ };
+ if s.len() > 8 {
+ return Err("overflow");
+ }
+ for &c in s {
+ let u1 = u << 8;
+ u = u1 | (c as u64);
+ }
+
+ Ok(u)
+}
+
+/// Read a slice as a big-endian value.
+#[macro_export]
+macro_rules! parse_hex_to_u64 (
+ ( $i:expr, $size:expr ) => {
+ map_res(take($size as usize), $crate::combinator::be_var_u64)($i)
+ };
+);
+
+/// Read 3 bytes as an unsigned integer
+#[deprecated(since = "0.5.0", note = "please use `be_u24` instead")]
+#[allow(deprecated)]
+#[inline]
+pub fn parse_uint24(i: &[u8]) -> IResult<&[u8], u64> {
+ map_res(take(3usize), bytes_to_u64)(i)
+}
+
+//named!(parse_hex4<&[u8], u64>, parse_hex_to_u64!(4));
+
+/// Parse a slice and return a fixed-sized array of bytes
+///
+/// This creates a copy of input data
+/// Uses unsafe code
+#[macro_export]
+macro_rules! slice_fixed(
+ ( $i:expr, $count:expr ) => (
+ {
+ let cnt = $count;
+ let ires: IResult<_,_> = if $i.len() < cnt {
+ Err(::nom::Err::Incomplete(Needed::new(cnt)))
+ } else {
+ let mut res: [u8; $count] = unsafe {
+ $crate::export::mem::MaybeUninit::uninit().assume_init()
+ };
+ unsafe{$crate::export::ptr::copy($i.as_ptr(), res.as_mut_ptr(), cnt)};
+ Ok((&$i[cnt..],res))
+ };
+ ires
+ }
+ );
+);
+
+/// Combination and flat_map! and take! as first combinator
+#[macro_export]
+macro_rules! flat_take (
+ ($i:expr, $len:expr, $f:ident) => ({
+ if $i.len() < $len { Err(::nom::Err::Incomplete(::nom::Needed::new($len))) }
+ else {
+ let taken = &$i[0..$len];
+ let rem = &$i[$len..];
+ match $f(taken) {
+ Ok((_,res)) => Ok((rem,res)),
+ Err(e) => Err(e)
+ }
+ }
+ });
+ ($i:expr, $len:expr, $submac:ident!( $($args:tt)*)) => ({
+ if $i.len() < $len { Err(::nom::Err::Incomplete(::nom::Needed::new($len))) }
+ else {
+ let taken = &$i[0..$len];
+ let rem = &$i[$len..];
+ match $submac!(taken, $($args)*) {
+ Ok((_,res)) => Ok((rem,res)),
+ Err(e) => Err(e)
+ }
+ }
+ });
+);
+
+/// Apply combinator, trying to "upgrade" error to next error type (using the `Into` or `From`
+/// traits).
+#[macro_export]
+macro_rules! upgrade_error (
+ ($i:expr, $submac:ident!( $($args:tt)*) ) => ({
+ upgrade_error!( $submac!( $i, $($args)* ) )
+ });
+ ($i:expr, $f:expr) => ({
+ upgrade_error!( call!($i, $f) )
+ });
+ ($e:expr) => ({
+ match $e {
+ Ok(o) => Ok(o),
+ Err(::nom::Err::Error(e)) => Err(::nom::Err::Error(e.into())),
+ Err(::nom::Err::Failure(e)) => Err(::nom::Err::Failure(e.into())),
+ Err(::nom::Err::Incomplete(i)) => Err(::nom::Err::Incomplete(i)),
+ }
+ });
+);
+
+/// Apply combinator, trying to "upgrade" error to next error type (using the `Into` or `From`
+/// traits).
+#[macro_export]
+macro_rules! upgrade_error_to (
+ ($i:expr, $ty:ty, $submac:ident!( $($args:tt)*) ) => ({
+ upgrade_error_to!( $ty, $submac!( $i, $($args)* ) )
+ });
+ ($i:expr, $ty:ty, $f:expr) => ({
+ upgrade_error_to!( $ty, call!($i, $f) )
+ });
+ ($ty:ty, $e:expr) => ({
+ match $e {
+ Ok(o) => Ok(o),
+ Err(::nom::Err::Error(e)) => Err(::nom::Err::Error(e.into::<$ty>())),
+ Err(::nom::Err::Failure(e)) => Err(::nom::Err::Failure(e.into::<$ty>())),
+ Err(::nom::Err::Incomplete(i)) => Err(::nom::Err::Incomplete(i)),
+ }
+ });
+);
+
+/// Nom combinator that returns the given expression unchanged
+#[macro_export]
+macro_rules! q {
+ ($i:expr, $x:expr) => {{
+ Ok(($i, $x))
+ }};
+}
+
+/// Align input value to the next multiple of n bytes
+/// Valid only if n is a power of 2
+#[macro_export]
+macro_rules! align_n2 {
+ ($x:expr, $n:expr) => {
+ ($x + ($n - 1)) & !($n - 1)
+ };
+}
+
+/// Align input value to the next multiple of 4 bytes
+#[macro_export]
+macro_rules! align32 {
+ ($x:expr) => {
+ $crate::align_n2!($x, 4)
+ };
+}
+
+#[cfg(test)]
+mod tests {
+ use nom::error::ErrorKind;
+ use nom::number::streaming::{be_u16, be_u32, be_u8};
+ use nom::{Err, IResult, Needed};
+
+ #[test]
+ #[allow(unsafe_code)]
+ fn test_slice_fixed() {
+ let empty = &b""[..];
+ let b = &[0x01, 0x02, 0x03, 0x04, 0x05];
+
+ let res = slice_fixed!(b, 4);
+ assert_eq!(res, Ok((&b[4..], [1, 2, 3, 4])));
+
+ // can we still use the result ?
+ match res {
+ Ok((rem, _)) => {
+ let res2: IResult<&[u8], u8> = be_u8(rem);
+ assert_eq!(res2, Ok((empty, 5)));
+ }
+ _ => (),
+ }
+ }
+
+ #[test]
+ #[allow(unsafe_code)]
+ fn test_slice_fixed_incomplete() {
+ let b = &[0x01, 0x02, 0x03, 0x04, 0x05];
+ let res = slice_fixed!(b, 8);
+ assert_eq!(res, Err(Err::Incomplete(Needed::new(8))));
+ }
+
+ #[test]
+ fn test_error_if() {
+ let empty = &b""[..];
+ let res: IResult<&[u8], ()> = error_if!(empty, true, ErrorKind::Tag);
+ assert_eq!(res, Err(Err::Error(error_position!(empty, ErrorKind::Tag))));
+ }
+
+ #[test]
+ fn test_cond_else() {
+ let input = &[0x01][..];
+ let empty = &b""[..];
+ let a = 1;
+ fn parse_u8(i: &[u8]) -> IResult<&[u8], u8> {
+ be_u8(i)
+ }
+ assert_eq!(
+ cond_else!(input, a == 1, call!(parse_u8), value!(0x02)),
+ Ok((empty, 0x01))
+ );
+ assert_eq!(
+ cond_else!(input, a == 1, parse_u8, value!(0x02)),
+ Ok((empty, 0x01))
+ );
+ assert_eq!(
+ cond_else!(input, a == 2, parse_u8, value!(0x02)),
+ Ok((input, 0x02))
+ );
+ assert_eq!(
+ cond_else!(input, a == 1, value!(0x02), parse_u8),
+ Ok((input, 0x02))
+ );
+ let res: IResult<&[u8], u8> = cond_else!(input, a == 1, parse_u8, parse_u8);
+ assert_eq!(res, Ok((empty, 0x01)));
+ }
+
+ #[test]
+ fn test_newtype_enum() {
+ #[derive(Debug, PartialEq, Eq)]
+ struct MyType(pub u8);
+
+ newtype_enum! {
+ impl display MyType {
+ Val1 = 0,
+ Val2 = 1
+ }
+ }
+
+ assert_eq!(MyType(0), MyType::Val1);
+ assert_eq!(MyType(1), MyType::Val2);
+
+ assert_eq!(format!("{}", MyType(0)), "Val1");
+ assert_eq!(format!("{}", MyType(4)), "MyType(4 / 0x4)");
+ }
+ #[test]
+ fn test_flat_take() {
+ let input = &[0x00, 0x01, 0xff];
+ // read first 2 bytes and use correct combinator: OK
+ let res: IResult<&[u8], u16> = flat_take!(input, 2, be_u16);
+ assert_eq!(res, Ok((&input[2..], 0x0001)));
+ // read 3 bytes and use 2: OK (some input is just lost)
+ let res: IResult<&[u8], u16> = flat_take!(input, 3, be_u16);
+ assert_eq!(res, Ok((&b""[..], 0x0001)));
+ // read 2 bytes and a combinator requiring more bytes
+ let res: IResult<&[u8], u32> = flat_take!(input, 2, be_u32);
+ assert_eq!(res, Err(Err::Incomplete(Needed::new(2))));
+ // test with macro as sub-combinator
+ let res: IResult<&[u8], u16> = flat_take!(input, 2, be_u16);
+ assert_eq!(res, Ok((&input[2..], 0x0001)));
+ }
+
+ #[test]
+ fn test_q() {
+ let empty = &b""[..];
+ let res: IResult<&[u8], &str, ErrorKind> = q!(empty, "test");
+ assert_eq!(res, Ok((empty, "test")));
+ }
+
+ #[test]
+ fn test_align32() {
+ assert_eq!(align32!(3), 4);
+ assert_eq!(align32!(4), 4);
+ assert_eq!(align32!(5), 8);
+ assert_eq!(align32!(5u32), 8);
+ assert_eq!(align32!(5i32), 8);
+ assert_eq!(align32!(5usize), 8);
+ }
+}
diff --git a/src/traits.rs b/src/traits.rs
new file mode 100644
index 0000000..38f1402
--- /dev/null
+++ b/src/traits.rs
@@ -0,0 +1,9 @@
+//! Common traits
+
+/// Common trait for structures serialization
+pub trait Serialize<O = Vec<u8>> {
+ /// Type of serialization error
+ type Error;
+ /// Try to serialize object
+ fn serialize(&self) -> Result<O, Self::Error>;
+}
