Remove `stdlib.rs` by jyn514 · Pull Request #1008 · tokio-rs/tracing

jyn514 · 2020-10-02T02:25:21Z

Motivation

Since core and alloc are unconditionally available, there is no
need to use a facade module for most of std.

Follow-up to #960 (comment): these modules aren't necessary.

Solution

Most of the imports could be switch to use core or use alloc without trouble.
The only exceptions were for Mutex and Once, which are only available with the full standard
library. These had a sync module added to tracing-core which acts as
a facade, re-exporting std if available and spin if not.

r? @hawkw

hawkw

looks good to me --- i had one question about the extern crate decl for liballoc.

tracing-core/src/lib.rs

hawkw · 2020-10-02T21:13:10Z

tracing-futures/src/lib.rs


-pub(crate) mod stdlib;
-
 #[cfg(feature = "std-future")]


we can probably just remove the feature flag for std::future in the upcoming release.... it was added way back in the day before std::future was stable, so it could be enabled by users on nightly. now, it's stable in our MSRV, so this is definitely no longer necessary.

Do you want me to remove all the uses of the feature here? I can keep std-future = [] as a no-op so it doesn't break existing code.

Oh actually it looks like enabling std-future conflicts with futures_01 ... do you plan to remove futures_01 in tracing 0.2?

hawkw · 2020-10-02T21:19:48Z

looks like there are some merge conflicts, and rustfmt needs to be run?

jyn514 · 2020-10-03T03:39:29Z

I rebased and ran rustfmt. I'm going to remove the std-future feature as mentioned in #1008 (comment), let me know if I should push it here or as a seperate PR.

jyn514 · 2020-10-03T04:00:56Z

Hmm, this doesn't look related to my change.

---- callsite::tests::linked_list_push stdout ----
thread 'callsite::tests::linked_list_push' panicked at 'attempt to add with overflow', tracing-core/src/callsite.rs:322:13

hawkw · 2020-10-05T18:33:43Z

Hmm, this doesn't look related to my change.

---- callsite::tests::linked_list_push stdout ----
thread 'callsite::tests::linked_list_push' panicked at 'attempt to add with overflow', tracing-core/src/callsite.rs:322:13

Hmm, that test was added quite recently (in PR #988), so I'm curious if there's a flaky behavior in the test, or a racy bug that only occurs occasionally. I'm going to take a closer look at that.

## Motivation Currently, the tests for the linked list implementation in `tracing_core::callsite` declare two static `Registration`s in the test module, which are used in multiple tests. Since these tests are all run in one binary, in separate threads, these statics are shared across all tests. This means that --- depending on the order in which tests are run --- these `Registration`s may already have values for their `next` pointers. In particular, there's a potential issue where the `for_each` in the test `linked_list_push` can loop repeatedly, if one of the `Registration`s already had a next pointer from a previous test. See: #1008 (comment) ## Solution This branch declares separate `Registration` statics for each test. These are not shared between multiple test threads. We still reuse the same callsite statics, since their state does not change during the tests --- only the `Registration`s change. I also refactored the test code a little bit to use only a single type implementing `Callsite`, rather than two separate types, since the callsite impl is not actually used and this makes the code somewhat more concise. Finally, I added a new test for pushing more than two callsites. Signed-off-by: Eliza Weisman <eliza@buoyant.io>

hawkw · 2020-10-05T23:39:29Z

Hmm, this doesn't look related to my change.

---- callsite::tests::linked_list_push stdout ----
thread 'callsite::tests::linked_list_push' panicked at 'attempt to add with overflow', tracing-core/src/callsite.rs:322:13

okay, #1016 fixes this --- mind rebasing? this should be good to merge once we get a green build :)

Since `core` and `alloc` are unconditionally available, there was no need to use a facade module for most of std. The only exceptions were for `Mutex` and `Once`, which are only available with the full standard library. These had a `sync` module added to `tracing-core` which acts as a facade, re-exporting `std` if available and `spin` if not.

jyn514 · 2020-10-06T00:37:46Z

Rebased and CI is passing :)

hawkw

okay, this seems good to me!

hawkw · 2020-10-06T00:40:51Z

This should hopefully make #1017 a bit nicer as well. :)

jyn514 · 2020-10-06T00:41:04Z

Awesome! Glad I could help :)

* upstream/master: subscriber: warn if trying to enable a statically disabled level (tokio-rs#990) subscriber: use macros for module declarations (tokio-rs#1009) chore: remove `stdlib.rs` (tokio-rs#1008) core: fix linked list tests reusing `Registration`s (tokio-rs#1016) subscriber: support dash in target names (tokio-rs#1012) docs: switch to intra-doc links in tracing-core (tokio-rs#1010) tracing-opentelemetry: implement additional record types (bool, i64, u64) (tokio-rs#1007) core: add intrusive linked list for callsite registry (tokio-rs#988) serde: allow tracing-serde to work on no_std. (tokio-rs#960) tracing: remove `Into<Option<Id>>` impl for `Span` (tokio-rs#1003) tracing: make `Entered` `!Send` (tokio-rs#1001) chore: fix nightly clippy warnings (tokio-rs#991) chore: bump all crate versions (tokio-rs#998) macros: fix the `tracing-macros` crate not compiling (tokio-rs#1000) tracing: prepare to release 0.1.21 (tokio-rs#997) core: prepare to release 0.1.17 (tokio-rs#996) subscriber: make `PartialOrd` & `Ord` impls more correct (tokio-rs#995) core, tracing: don't inline dispatcher::get_default (tokio-rs#994) core: make `Level` and `LevelFilter` `Copy` (tokio-rs#992)

…spatch-as-ref-tokio-rs#455 * upstream/master: (28 commits) opentelemetry: prepare for 0.8.0 release (tokio-rs#1036) docs: add favicon for extra pretty docs (tokio-rs#1033) subscriber: fix `reload` ergonomics (tokio-rs#1035) chore(deps): update crossbeam-channel requirement from 0.4.2 to 0.5.0 (tokio-rs#1031) opentelemetry: Assign default ids if missing (tokio-rs#1027) chore: remove deprecated add-path from CI (tokio-rs#1026) attributes: fix `#[instrument(err)]` in case of early returns (tokio-rs#1006) core: remove mandatory liballoc dependency with no-std (tokio-rs#1017) chore(deps): update cfg-if requirement from 0.1.10 to 1.0.0 (tokio-rs#1023) subscriber: warn if trying to enable a statically disabled level (tokio-rs#990) subscriber: use macros for module declarations (tokio-rs#1009) chore: remove `stdlib.rs` (tokio-rs#1008) core: fix linked list tests reusing `Registration`s (tokio-rs#1016) subscriber: support dash in target names (tokio-rs#1012) docs: switch to intra-doc links in tracing-core (tokio-rs#1010) tracing-opentelemetry: implement additional record types (bool, i64, u64) (tokio-rs#1007) core: add intrusive linked list for callsite registry (tokio-rs#988) serde: allow tracing-serde to work on no_std. (tokio-rs#960) tracing: remove `Into<Option<Id>>` impl for `Span` (tokio-rs#1003) tracing: make `Entered` `!Send` (tokio-rs#1001) ...

…cros * upstream/master: (30 commits) chore(deps): update pin-project requirement from 0.4 to 1.0 (tokio-rs#1038) chore: remove duplicated section from tracing/README.md (tokio-rs#1046) opentelemetry: prepare for 0.8.0 release (tokio-rs#1036) docs: add favicon for extra pretty docs (tokio-rs#1033) subscriber: fix `reload` ergonomics (tokio-rs#1035) chore(deps): update crossbeam-channel requirement from 0.4.2 to 0.5.0 (tokio-rs#1031) opentelemetry: Assign default ids if missing (tokio-rs#1027) chore: remove deprecated add-path from CI (tokio-rs#1026) attributes: fix `#[instrument(err)]` in case of early returns (tokio-rs#1006) core: remove mandatory liballoc dependency with no-std (tokio-rs#1017) chore(deps): update cfg-if requirement from 0.1.10 to 1.0.0 (tokio-rs#1023) subscriber: warn if trying to enable a statically disabled level (tokio-rs#990) subscriber: use macros for module declarations (tokio-rs#1009) chore: remove `stdlib.rs` (tokio-rs#1008) core: fix linked list tests reusing `Registration`s (tokio-rs#1016) subscriber: support dash in target names (tokio-rs#1012) docs: switch to intra-doc links in tracing-core (tokio-rs#1010) tracing-opentelemetry: implement additional record types (bool, i64, u64) (tokio-rs#1007) core: add intrusive linked list for callsite registry (tokio-rs#988) serde: allow tracing-serde to work on no_std. (tokio-rs#960) ...

…gger * upstream/master: (31 commits) chore: fix tracing-macros::dbg (tokio-rs#1054) chore(deps): update pin-project requirement from 0.4 to 1.0 (tokio-rs#1038) chore: remove duplicated section from tracing/README.md (tokio-rs#1046) opentelemetry: prepare for 0.8.0 release (tokio-rs#1036) docs: add favicon for extra pretty docs (tokio-rs#1033) subscriber: fix `reload` ergonomics (tokio-rs#1035) chore(deps): update crossbeam-channel requirement from 0.4.2 to 0.5.0 (tokio-rs#1031) opentelemetry: Assign default ids if missing (tokio-rs#1027) chore: remove deprecated add-path from CI (tokio-rs#1026) attributes: fix `#[instrument(err)]` in case of early returns (tokio-rs#1006) core: remove mandatory liballoc dependency with no-std (tokio-rs#1017) chore(deps): update cfg-if requirement from 0.1.10 to 1.0.0 (tokio-rs#1023) subscriber: warn if trying to enable a statically disabled level (tokio-rs#990) subscriber: use macros for module declarations (tokio-rs#1009) chore: remove `stdlib.rs` (tokio-rs#1008) core: fix linked list tests reusing `Registration`s (tokio-rs#1016) subscriber: support dash in target names (tokio-rs#1012) docs: switch to intra-doc links in tracing-core (tokio-rs#1010) tracing-opentelemetry: implement additional record types (bool, i64, u64) (tokio-rs#1007) core: add intrusive linked list for callsite registry (tokio-rs#988) ...

…spatch-as-owned-tokio-rs#455 * upstream/master: (34 commits) subscriber: remove TraceLogger (tokio-rs#1052) subscriber: make Registry::enter/exit much faster (tokio-rs#1058) chore(deps): update env_logger requirement from 0.7 to 0.8 (tokio-rs#1050) chore: fix tracing-macros::dbg (tokio-rs#1054) chore(deps): update pin-project requirement from 0.4 to 1.0 (tokio-rs#1038) chore: remove duplicated section from tracing/README.md (tokio-rs#1046) opentelemetry: prepare for 0.8.0 release (tokio-rs#1036) docs: add favicon for extra pretty docs (tokio-rs#1033) subscriber: fix `reload` ergonomics (tokio-rs#1035) chore(deps): update crossbeam-channel requirement from 0.4.2 to 0.5.0 (tokio-rs#1031) opentelemetry: Assign default ids if missing (tokio-rs#1027) chore: remove deprecated add-path from CI (tokio-rs#1026) attributes: fix `#[instrument(err)]` in case of early returns (tokio-rs#1006) core: remove mandatory liballoc dependency with no-std (tokio-rs#1017) chore(deps): update cfg-if requirement from 0.1.10 to 1.0.0 (tokio-rs#1023) subscriber: warn if trying to enable a statically disabled level (tokio-rs#990) subscriber: use macros for module declarations (tokio-rs#1009) chore: remove `stdlib.rs` (tokio-rs#1008) core: fix linked list tests reusing `Registration`s (tokio-rs#1016) subscriber: support dash in target names (tokio-rs#1012) ...

jyn514 requested review from a team and hawkw as code owners October 2, 2020 02:25

jyn514 force-pushed the cfg branch from c6593e0 to 8333620 Compare October 2, 2020 03:21

hawkw approved these changes Oct 2, 2020

View reviewed changes

jyn514 force-pushed the cfg branch from 8333620 to 7e9ec49 Compare October 3, 2020 03:38

hawkw mentioned this pull request Oct 5, 2020

core: fix linked list tests reusing Registrations #1016

Merged

jyn514 added 2 commits October 5, 2020 20:26

cargo fmt

c75c5b6

jyn514 force-pushed the cfg branch from 7e9ec49 to c75c5b6 Compare October 6, 2020 00:26

hawkw approved these changes Oct 6, 2020

View reviewed changes

hawkw merged commit dcad8d0 into tokio-rs:master Oct 6, 2020

jyn514 deleted the cfg branch October 6, 2020 00:40

Conversation

jyn514 commented Oct 2, 2020

Motivation

Solution

Uh oh!

hawkw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hawkw Oct 2, 2020

Choose a reason for hiding this comment

Uh oh!

jyn514 Oct 3, 2020

Choose a reason for hiding this comment

Uh oh!

jyn514 Oct 3, 2020

Choose a reason for hiding this comment

Uh oh!

hawkw commented Oct 2, 2020

Uh oh!

jyn514 commented Oct 3, 2020

Uh oh!

jyn514 commented Oct 3, 2020

Uh oh!

hawkw commented Oct 5, 2020

Uh oh!

hawkw commented Oct 5, 2020

Uh oh!

jyn514 commented Oct 6, 2020

Uh oh!

hawkw left a comment

Choose a reason for hiding this comment

Uh oh!

hawkw commented Oct 6, 2020

Uh oh!

jyn514 commented Oct 6, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants