November 2017 - tor-commits - lists.torproject.org

[tor/master] Merge branch 'maint-0.3.2'
by nickm＠torproject.org 13 Nov '17

13 Nov '17

commit e53daee2f49aea30129f95fa1145b291565b3919 Merge: ebcd1a57c 441bfcd88 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 13 11:13:22 2017 -0500 Merge branch 'maint-0.3.2'

1 0

[tor/master] Merge branch 'maint-0.3.1' into maint-0.3.2
by nickm＠torproject.org 13 Nov '17

13 Nov '17

commit 441bfcd8856ee98f4d622e4ebbfcabe24624ca66 Merge: 512dfa15e 2777b469f Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 13 11:13:22 2017 -0500 Merge branch 'maint-0.3.1' into maint-0.3.2

1 0

[tor/master] Merge branch 'maint-0.2.9' into maint-0.3.0
by nickm＠torproject.org 13 Nov '17

13 Nov '17

commit ece63105d9157fa432cc59d8b828ca23a80040ff Merge: 5348c8996 c928fb988 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 13 11:13:22 2017 -0500 Merge branch 'maint-0.2.9' into maint-0.3.0 changes/ticket21953 | 6 ++++++ src/or/main.c | 10 +++++++++- 2 files changed, 15 insertions(+), 1 deletion(-)

1 0

[tor/master] Merge branch 'ticket21953_029' into maint-0.2.9
by nickm＠torproject.org 13 Nov '17

13 Nov '17

commit c928fb988a6679cc5aca380bcc568b165e5f7c4a Merge: 9666c620d 15cc41e66 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 13 11:13:18 2017 -0500 Merge branch 'ticket21953_029' into maint-0.2.9 changes/ticket21953 | 6 ++++++ src/or/main.c | 10 +++++++++- 2 files changed, 15 insertions(+), 1 deletion(-)

1 0

[tor/maint-0.3.2] Merge branch 'maint-0.3.1' into maint-0.3.2
by nickm＠torproject.org 13 Nov '17

13 Nov '17

commit 441bfcd8856ee98f4d622e4ebbfcabe24624ca66 Merge: 512dfa15e 2777b469f Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 13 11:13:22 2017 -0500 Merge branch 'maint-0.3.1' into maint-0.3.2

1 0

[tor/master] annotate where C and Rust need to stay in sync
by nickm＠torproject.org 13 Nov '17

13 Nov '17

commit 1c50331b9af28a691cb48e632ab71d9af83916ba Author: Chelsea Holland Komlo <me(a)chelseakomlo.com> Date: Sat Nov 11 22:26:22 2017 -0500 annotate where C and Rust need to stay in sync --- doc/HACKING/GettingStartedRust.md | 8 ++++++++ src/rust/protover/ffi.rs | 3 ++- src/rust/protover/protover.rs | 12 ++++++++++++ 3 files changed, 22 insertions(+), 1 deletion(-) diff --git a/doc/HACKING/GettingStartedRust.md b/doc/HACKING/GettingStartedRust.md index a5253b46a..3cd7fdc42 100644 --- a/doc/HACKING/GettingStartedRust.md +++ b/doc/HACKING/GettingStartedRust.md @@ -125,6 +125,14 @@ is on our TODO list to try to cultivate good standing with various distro maintainers of `rustc` and `cargo`, in order to ensure that whatever version we solidify on is readily available. +If parts of your Rust code needs to stay in sync with C code (such as handling +enums across the FFI boundary), annonotate these places in a comment structured +as follows: + + /// C_RUST_COUPLED: <path_to_file> `<name_of_c_object>` + +Where <name_of_c_object> can be an enum, struct, constant, etc. + Adding your Rust module to Tor's build system ----------------------------------------------- diff --git a/src/rust/protover/ffi.rs b/src/rust/protover/ffi.rs index cebf9e12f..3eb22c933 100644 --- a/src/rust/protover/ffi.rs +++ b/src/rust/protover/ffi.rs @@ -15,7 +15,8 @@ use tor_allocate::allocate_and_copy_string; /// Translate C enums to Rust Proto enums, using the integer value of the C /// enum to map to its associated Rust enum -/// This is dependant on the associated C enum preserving ordering. +/// +/// C_RUST_COUPLED: src/or/protover.h `protocol_type_t` fn translate_to_rust(c_proto: uint32_t) -> Result<Proto, &'static str> { match c_proto { 0 => Ok(Proto::Link), diff --git a/src/rust/protover/protover.rs b/src/rust/protover/protover.rs index b8bf280d4..7d5947ca2 100644 --- a/src/rust/protover/protover.rs +++ b/src/rust/protover/protover.rs @@ -10,13 +10,20 @@ use std::string::String; /// The first version of Tor that included "proto" entries in its descriptors. /// Authorities should use this to decide whether to guess proto lines. +/// +/// C_RUST_COUPLED: +/// src/or/protover.h `FIRST_TOR_VERSION_TO_ADVERTISE_PROTOCOLS` const FIRST_TOR_VERSION_TO_ADVERTISE_PROTOCOLS: &'static str = "0.2.9.3-alpha"; /// The maximum number of subprotocol version numbers we will attempt to expand /// before concluding that someone is trying to DoS us +/// +/// C_RUST_COUPLED: src/or/protover.c `MAX_PROTOCOLS_TO_EXPAND` const MAX_PROTOCOLS_TO_EXPAND: u32 = 500; /// Currently supported protocols and their versions +/// +/// C_RUST_COUPLED: src/or/protover.c `protover_get_supported_protocols` const SUPPORTED_PROTOCOLS: &'static [&'static str] = &[ "Cons=1-2", "Desc=1-2", @@ -31,6 +38,8 @@ const SUPPORTED_PROTOCOLS: &'static [&'static str] = &[ ]; /// Known subprotocols in Tor. Indicates which subprotocol a relay supports. +/// +/// C_RUST_COUPLED: src/or/protover.h `protocol_type_t` #[derive(Hash, Eq, PartialEq, Debug)] pub enum Proto { Cons, @@ -53,6 +62,8 @@ impl fmt::Display for Proto { /// Translates a string representation of a protocol into a Proto type. /// Error if the string is an unrecognized protocol name. +/// +/// C_RUST_COUPLED: src/or/protover.c `PROTOCOL_NAMES` impl FromStr for Proto { type Err = &'static str; @@ -712,6 +723,7 @@ pub fn is_supported_here(proto: Proto, vers: u32) -> bool { /// This function returns the protocols that are supported by the version input, /// only for tor versions older than FIRST_TOR_VERSION_TO_ADVERTISE_PROTOCOLS. /// +/// C_RUST_COUPLED: src/rust/protover.c `compute_for_old_tor` pub fn compute_for_old_tor(version: &str) -> String { if c_tor_version_as_new_as( version,

1 0

[tor/master] Add corresponding rust-c coupling comments to C
by nickm＠torproject.org 13 Nov '17

13 Nov '17

commit fdefda95bc2566f1ee37c99d89c33399b1364eaa Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 13 10:03:46 2017 -0500 Add corresponding rust-c coupling comments to C --- src/or/protover.c | 5 +++++ src/or/protover.h | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/src/or/protover.c b/src/or/protover.c index 8b61d9663..ae955296e 100644 --- a/src/or/protover.c +++ b/src/or/protover.c @@ -34,6 +34,7 @@ static int protocol_list_contains(const smartlist_t *protos, protocol_type_t pr, uint32_t ver); /** Mapping between protocol type string and protocol type. */ +/// C_RUST_COUPLED: src/rust/protover/protover.rs `PROTOCOL_NAMES` static const struct { protocol_type_t protover_type; const char *name; @@ -320,6 +321,7 @@ protocol_list_supports_protocol_or_later(const char *list, /** Return the canonical string containing the list of protocols * that we support. */ +/// C_RUST_COUPLED: src/rust/protover/protover.rs `SUPPORTED_PROTOCOLS` const char * protover_get_supported_protocols(void) { @@ -403,6 +405,8 @@ encode_protocol_list(const smartlist_t *sl) /* We treat any protocol list with more than this many subprotocols in it * as a DoS attempt. */ +/// C_RUST_COUPLED: src/rust/protover/protover.rs +/// `MAX_PROTOCOLS_TO_EXPAND` static const int MAX_PROTOCOLS_TO_EXPAND = (1<<16); /** Voting helper: Given a list of proto_entry_t, return a newly allocated @@ -729,6 +733,7 @@ protocol_list_contains(const smartlist_t *protos, * Note that this is only used to infer protocols for Tor versions that * can't declare their own. **/ +/// C_RUST_COUPLED: src/rust/protover/protover.rs `compute_for_old_tor` const char * protover_compute_for_old_tor(const char *version) { diff --git a/src/or/protover.h b/src/or/protover.h index 5884585ea..a4dbc8bfc 100644 --- a/src/or/protover.h +++ b/src/or/protover.h @@ -15,6 +15,8 @@ * descriptors. Authorities should use this to decide whether to * guess proto lines. */ /* This is a guess. */ +/// C_RUST_COUPLED: src/rust/protover/protover.rs +/// `FIRST_TOR_VERSION_TO_ADVERTISE_PROTOCOLS` #define FIRST_TOR_VERSION_TO_ADVERTISE_PROTOCOLS "0.2.9.3-alpha" /** The protover version number that signifies HSDir support for HSv3 */ @@ -25,6 +27,8 @@ #define PROTOVER_HS_RENDEZVOUS_POINT_V3 2 /** List of recognized subprotocols. */ +/// C_RUST_COUPLED: src/rust/protover/ffi.rs `translate_to_rust` +/// C_RUST_COUPLED: src/rust/protover/protover.rs `Proto` typedef enum protocol_type_t { PRT_LINK, PRT_LINKAUTH,

1 0

[tor/master] Merge remote-tracking branch 'chelseakomlo/24032-cargo-rust-sync'
by nickm＠torproject.org 13 Nov '17

13 Nov '17

commit edf3d6b7ee2c02804b1c590949af6e24d1d37383 Merge: 05662f35e 1c50331b9 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 13 09:59:10 2017 -0500 Merge remote-tracking branch 'chelseakomlo/24032-cargo-rust-sync' doc/HACKING/GettingStartedRust.md | 8 ++++++++ src/rust/protover/ffi.rs | 3 ++- src/rust/protover/protover.rs | 12 ++++++++++++ 3 files changed, 22 insertions(+), 1 deletion(-)

1 0

[tor/master] Note in the rust doc that these comments are bidirectional
by nickm＠torproject.org 13 Nov '17

13 Nov '17

commit ebcd1a57c0f784d97bfebfc071dffbd0bff93ec8 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 13 10:04:40 2017 -0500 Note in the rust doc that these comments are bidirectional --- doc/HACKING/GettingStartedRust.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/HACKING/GettingStartedRust.md b/doc/HACKING/GettingStartedRust.md index 7d8a74bfe..181535122 100644 --- a/doc/HACKING/GettingStartedRust.md +++ b/doc/HACKING/GettingStartedRust.md @@ -131,7 +131,9 @@ as follows: /// C_RUST_COUPLED: <path_to_file> `<name_of_c_object>` -Where <name_of_c_object> can be an enum, struct, constant, etc. +Where <name_of_c_object> can be an enum, struct, constant, etc. Then, do the +same in the C code, to note that rust will need to be changed when the C +does. Adding your Rust module to Tor's build system -----------------------------------------------

1 0

[tor/master] update rust getting started for new build
by nickm＠torproject.org 13 Nov '17

13 Nov '17

commit 05662f35ea4469e354b863ca5498522c716416c7 Author: Chelsea Holland Komlo <me(a)chelseakomlo.com> Date: Mon Nov 6 12:55:10 2017 -0500 update rust getting started for new build --- doc/HACKING/GettingStartedRust.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/HACKING/GettingStartedRust.md b/doc/HACKING/GettingStartedRust.md index a5253b46a..5a8f495b7 100644 --- a/doc/HACKING/GettingStartedRust.md +++ b/doc/HACKING/GettingStartedRust.md @@ -132,8 +132,13 @@ solidify on is readily available. in the `.../tor/src/rust/` directory. 1. Add your crate to `.../tor/src/rust/Cargo.toml`, in the `[workspace.members]` section. -2. Append your crate's static library to the `rust_ldadd` definition - (underneath `if USE_RUST`) in `.../tor/Makefile.am`. +2. Add your crate's files to src/rust/include.am + +If your crate should be available to C (rather than just being included as a +dependency of other Rust modules): +0. Declare the crate as a dependency of tor_rust in + `src/rust/tor_util/Cargo.toml` and include it in + `src/rust/tor_rust/lib.rs` How to test your Rust code ----------------------------

1 0