fork versionize_derive

fork https://github.com/firecracker-microvm/versionize_derive.git

Since our PR
(firecracker-microvm/versionize_derive#23) can't
be merged into upstream for a short time, here we fork it first.
After the upstream is merged, switch to the upstream dependency.

Signed-off-by: wllenyj <[email protected]>

Author: wllenyj

crates/dbs-versionize-derive/CHANGELOG.md

@@ -0,0 +1,26 @@
+# v0.1.5
+
+- Ping dependency versions
+- Fix clippy errors and warnings
+- Bump rust-vmm-ci version
+
+# v0.1.4
+
+- Added more documentation and examples.
+
+# v0.1.3
+
+- Updated documentation.
+
+# v0.1.2
+
+- Removed union serialization support.
+
+# v0.1.1
+
+- Removed "versionize" dependency.
+- Added support for (de)serializing enum variants with zero or more fields.
+
+# v0.1.0
+
+- "versionize_derive" v0.1.0 first release.

crates/dbs-versionize-derive/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing to versionize_derive
+
+## Contribution Workflow
+
+The versionize_derive repository uses the “fork-and-pull” development model. Follow
+these steps if you want to merge your changes:
+
+1. Within your fork of
+   [versionize_derive](https://github.com/firecracker-microvm/versionize_derive), create a
+   branch for your contribution. Use a meaningful name.
+1. Create your contribution, meeting all
+   [contribution quality standards](#contribution-quality-standards)
+1. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
+   against the master branch of the versionize_derive repository.
+1. Work with your reviewers to address any comments and obtain a
+   minimum of 2 approvals, at least one of which must be provided by
+   [a maintainer](MAINTAINERS.md).
+   To update your pull request amend existing commits whenever applicable and
+   then push the new changes to your pull request branch.
+1. Once the pull request is approved, one of the maintainers will merge it.
+
+## Request for Comments
+
+If you just want to receive feedback for a contribution proposal, open an “RFC”
+(“Request for Comments”) pull request:
+
+1. On your fork of
+   [versionize_derive](https://github.com/firecracker-microvm/versionize_derive), create a
+   branch for the contribution you want feedback on. Use a meaningful name.
+1. Create your proposal based on the existing codebase.
+1. [Create a draft pull request](https://github.blog/2019-02-14-introducing-draft-pull-requests/)
+   against the master branch of the versionize_derive repository.
+1. Discuss your proposal with the community on the pull request page (or on any
+   other channel). Add the conclusion(s) of this discussion to the pull request
+   page.
+
+## Contribution Quality Standards
+
+Most quality and style standards are enforced automatically during integration
+testing. Your contribution needs to meet the following standards:
+
+- Separate each **logical change** into its own commit.
+- Each commit must pass all unit & code style tests, and the full pull request
+  must pass all integration tests.
+- Unit test coverage must _increase_ the overall project code coverage.
+- Document all your public functions.
+- Add a descriptive message for each commit. Follow
+  [commit message best practices](https://github.com/erlang/otp/wiki/writing-good-commit-messages).
+- Document your pull requests. Include the reasoning behind each change.
+- Acknowledge versionize_derive's [Apache 2.0 license](LICENSE) and certify that no
+  part of your contribution contravenes this license by signing off on all your
+  commits with `git -s`. Ensure that every file in your pull request has a
+  header referring to the repository license file.

crates/dbs-versionize-derive/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "versionize_derive"
+version = "0.1.5"
+license = "Apache-2.0"
+authors = ["Amazon Firecracker team <[email protected]>"]
+description = "Implements the Versionize derive proc macro."
+readme = "README.md"
+repository = "https://github.com/firecracker-microvm/versionize_derive"
+keywords = ["serialization", "version"]
+
+[dependencies]
+proc-macro2 = "1.0.47"
+quote = "1.0.21"
+syn = { version = "1.0.13", features=["full", "extra-traits"]}
+
+[lib]
+proc-macro = true
+
+[badges]
+maintenance = { status = "experimental" }

crates/dbs-versionize-derive/LICENSE

@@ -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.

crates/dbs-versionize-derive/README.md

@@ -0,0 +1,83 @@
+**Versionize is a framework for version tolerant serializion/deserialization of
+Rust data structures, designed for usecases that need fast deserialization 
+times and minimal size overhead. It does not aim to be a generic serialization 
+framework and only the [bincode](https://crates.io/crates/bincode) backend is 
+supported.**
+
+#### You may be looking for:
+- [Versionize documentation](https://docs.rs/versionize/)
+- [Releases](https://github.com/firecracker-microvm/versionize_derive/releases)
+
+## Important note
+
+This crate is currently used for cross-version serialization with the 
+[Firecracker snapshot-restore dev preview][1], but has not been tested for 
+other use cases. It should be considered **experimental software** outside the 
+Firecracker context. It’s likely that this crate will see both interface and 
+implementation changes in the future.
+
+## Versionize in action
+
+```rust
+    extern crate versionize;
+    extern crate versionize_derive;
+
+    use versionize::{VersionMap, Versionize, VersionizeResult};
+    use versionize_derive::Versionize;
+
+    // The test structure is at version 3.
+    #[derive(Debug, PartialEq, Versionize)]
+    pub struct Test {
+        a: u32,
+        #[version(start = 2, end = 3)]
+        b: u8,
+        #[version(start = 3, default_fn = "default_c")]
+        c: String,
+    }
+
+    impl Test {
+        // Default value for field `c`.
+        // The callback is invoked when deserialization from and older version
+        // where the field did not exist.
+        fn default_c(_source_version: u16) -> String {
+            "test_string".to_owned()
+        }
+    }
+
+    // Memory to hold the serialization output.
+    let mut mem = vec![0u8; 512];
+    // Create a new version map - it will start at version 1.
+    let mut version_map = VersionMap::new();
+    // Add new version and mark changes for Test struct: Set the current version
+    // to point to Test struct version 2.
+    version_map
+        .new_version()
+        .set_type_version(Test::type_id(), 2)
+        .new_version()
+        .set_type_version(Test::type_id(), 3);
+
+    let test_struct = Test {
+        a: 1337,
+        b: 0xFF,
+        c: "c_value".to_owned(),
+    };
+
+    // Serialize to version 2 - field c will not be serialized.
+    test_struct
+        .serialize(&mut mem.as_mut_slice(), &version_map, 2)
+        .unwrap();
+
+    // Deserialize from version 2 - c should contain the default_fn() return value.
+    let restored_test_struct = Test::deserialize(&mut mem.as_slice(), &version_map, 2).unwrap();
+
+    assert_eq!(
+        restored_test_struct,
+        Test {
+            a: 1337,
+            b: 255,
+            c: "test_string".to_owned()
+        }
+    );
+```
+
+[1]: https://github.com/firecracker-microvm/firecracker/tree/v0.24.0