Skip to content

Driver logging: disable colors when logging to file #78435

Closed
#80887
#78548
Closed
Driver logging: disable colors when logging to file#78435
#80887
#78548
Assignees
camelid
Labels
A-driverArea: rustc_driver that ties everything together into the `rustc` compilerC-enhancementCategory: An issue proposing an enhancement or a PR with one.

Description

@RalfJung
RalfJung
opened on Oct 27, 2020

When debugging a large Miri trace, I like to put the trace into a file that I can analyze and search through in an editor. Unfortunately, since the recent logging changes, that leads to a lot of garbage in the file:

2:rustc│ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m Retag([fn entry] _1)
2:rustc│ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m StorageLive(_2)
2:rustc│ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m StorageLive(_3)
2:rustc│ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m _3 = move _1
2:rustc│ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m Retag(_3)
2:rustc│ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m _2 = std::mem::ManuallyDrop::<std::boxed::Box<T, A>>::new(move _3) -> [return: bb1, unwind: bb5]
2:rustc│ │ │ │ │ │ ├┐�[2mrustc_mir::interpret::eval_context�[0m::�[1;32mframe�[0m std::boxed::Box::<alloc::collections::btree::node::LeafNode<std::string::String, i32>>::into_unique
2:rustc│ │ │ │ │ │ │└┐�[2mrustc_mir::interpret::eval_context�[0m::�[1;32mframe�[0m std::mem::ManuallyDrop::<std::boxed::Box<alloc::collections::btree::node::LeafNode<std::string::String, i32>>>::new
2:rustc│ │ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m // executing bb0
2:rustc│ │ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m Retag([fn entry] _1)
2:rustc│ │ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m StorageLive(_2)
2:rustc│ │ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m _2 = move _1
2:rustc│ │ │ │ │ │ │ ├─�[2m0�[0m�[2mms�[0m �[1;32m INFO�[0m �[2mrustc_mir::interpret::step�[0m Retag(_2)

Looks like the color escape sequences are printed even when redirecting to a file. This makes working with the logfile much harder than it was before. Is there a way to fix that?

Cc @oli-obk

Activity

  1. oli-obk commented on Oct 27, 2020

    @oli-obk
    oli-obk
    on Oct 27, 2020
    Contributor

    This is the fault of

    rust/compiler/rustc_driver/src/lib.rs

    Line 1289 in 35debd4

    .with_ansi(true)

    I should be checking for whether the terminal supports colors before activating colors

  2. oli-obk commented on Oct 27, 2020

    @oli-obk
    oli-obk
    on Oct 27, 2020
    Contributor

    A workaround until then is to use https://superuser.com/a/380778

  3. camelid
    added
    A-miriArea: The miri tool
    on Oct 28, 2020
  4. camelid
    self-assigned this
    on Oct 28, 2020
  5. camelid
    added
    A-driverArea: rustc_driver that ties everything together into the `rustc` compiler
    and removed
    A-miriArea: The miri tool
    on Oct 28, 2020
  6. camelid
    changed the title [-]Miri engine logging: disable colors when logging to file[/-] [+]Driver logging: disable colors when logging to file[/+] on Oct 28, 2020

  7. camelid commented on Oct 29, 2020

    @camelid
    camelid
    on Oct 29, 2020
    Member

    How can I run miri from the rust repo? (i.e. built using ./x.py build)

  8. RalfJung commented on Oct 29, 2020

    @RalfJung
    RalfJung
    on Oct 29, 2020
    MemberAuthor

    You can run the test suite with ./x.py test --stage 0 src/tools/miri, but that's not what you were asking... that's not supported yet unfortunately: #76666

  9. RalfJung commented on Oct 29, 2020

    @RalfJung
    RalfJung
    on Oct 29, 2020
    MemberAuthor

    Until then, you'll have to resort to this.

    Some of the x.py commands might need adjusting though as x.py changed.

  10. camelid commented on Oct 29, 2020

    @camelid
    camelid
    on Oct 29, 2020
    Member

    Ah, thanks! I forgot about that part of the docs :)

  11. camelid commented on Oct 29, 2020

    @camelid
    camelid
    on Oct 29, 2020
    Member

    Hmm, I'm getting this error:

    error[E0463]: can't find crate for `rustc_attr`
  --> src/lib.rs:14:1
   |
14 | extern crate rustc_attr;
   | ^^^^^^^^^^^^^^^^^^^^^^^^ can't find crate

error: aborting due to previous error

    I'm using the latest master rustc and the latest miri. Is miri broken right now?

    EDIT: Oh, I think I need --stage 2.

  12. RalfJung commented on Oct 29, 2020

    @RalfJung
    RalfJung
    on Oct 29, 2020
    MemberAuthor

    Yeah looks like you are using the wrong stage or so. The docs are from back when stage 2 was the default...

  13. camelid
    added
    C-enhancementCategory: An issue proposing an enhancement or a PR with one.
    on Oct 29, 2020
  14. camelid
    added a commit that references this issue on Oct 29, 2020

    driver: Only output ANSI if connected to a terminal

    d282aca
  15. bors
    added a commit that references this issue on Oct 30, 2020

    Auto merge of #1610 - camelid:patch-2, r=RalfJung

    8f36839
  16. bors
    closed this as completedin 1c389ffon Nov 24, 2020

  17. RalfJung commented on Jan 10, 2021

    @RalfJung
    RalfJung
    on Jan 10, 2021
    MemberAuthor

    @oli-obk @camelid I'm afraid the problem was not solved by that PR. When I run Miri like this locally

    MIRI_LOG=info,miri::stacked_borrows=trace ./miri run /tmp/test.rs -Zmiri-track-raw-pointers 2> log

    I still get all the ANSI codes in that logfile, which makes the file very hard to work with.

  18. RalfJung
    reopened this on Jan 10, 2021

  19. RalfJung commented on Jan 10, 2021

    @RalfJung
    RalfJung
    on Jan 10, 2021
    MemberAuthor

    Looks like the code tests stdout_isatty, but logging goes to stderr so this is the wrong test.

  20. camelid commented on Jan 10, 2021

    @camelid
    camelid
    on Jan 10, 2021
    Member

    Hmm, I guess I didn't notice any issues because I always redirect stderr to stdout and then view that.

  21. camelid commented on Jan 10, 2021

    @camelid
    camelid
    on Jan 10, 2021
    Member

    Working on a fix.

  22. RalfJung commented on Jan 10, 2021

    @RalfJung
    RalfJung
    on Jan 10, 2021
    MemberAuthor

    Yeah, for now using &>log to redirect both to the logfile is an okay work-around.

  23. jyn514 commented on Jan 11, 2021

    @jyn514
    jyn514
    on Jan 11, 2021
    Member

    @RalfJung FYI you can view the original color with less -R, which prints them directly to the terminal. That doesn't work in an editor, though.

  24. JohnTitor
    added a commit that references this issue on Jan 11, 2021

    Rollup merge of rust-lang#80887 - camelid:fix-log-color-auto, r=RalfJung

    293a491
  25. bors
    closed this as completedin 293a491on Jan 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-driverArea: rustc_driver that ties everything together into the `rustc` compilerC-enhancementCategory: An issue proposing an enhancement or a PR with one.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions