Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

src: separate trace_event_common from trace_event #10628

Closed
wants to merge 1 commit into from

Conversation

targos
Copy link
Member

@targos targos commented Jan 5, 2017

Currently, trace_event.h contains a full copy of the header present in
deps/v8/base/trace_event/common/trace_event_common.h mixed with
implementation-specific macros.
This patch moves the V8 code to its own file and includes it from
trace_event.h.

  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines

src

@nodejs-github-bot nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. dont-land-on-v7.x labels Jan 5, 2017
@targos
Copy link
Member Author

targos commented Jan 5, 2017

/cc @jasongin @nodejs/diagnostics @nodejs/v8

I'm happy to remove the copy and directly include it from deps if you want.

@jasongin
Copy link
Member

jasongin commented Jan 5, 2017

LGTM, certainly an improvement, though I don't know if it's the best approach.

@ofrobots do you know why trace_event_common.h was originally added at deps\v8\trace_event\common rather than deps\v8\include? If it was in the latter location then it would be easier to just #include in trace_event.h here.

Ideally @matthewloring should also comment on this, but I don't know when he is going to be back at work.

@ofrobots
Copy link
Contributor

ofrobots commented Jan 5, 2017

IIRC it was quite intentional that @matthewloring did not directly include trace_event_common.h – but the details escape me. Perhaps @fmeawad knows too. Matt should be back mid next week, he has the full context here.

Perhaps we can go with #10623 as the workaround for now and figure out a longer-term solution (this PR or otherwise) once @matthewloring is back.

@jasongin
Copy link
Member

jasongin commented Jan 5, 2017

#10623 is not a workaround for this issue, it is just a fix for a separate tracing-related bug.

@ofrobots
Copy link
Contributor

ofrobots commented Jan 5, 2017

Ah sorry, I misunderstood. In that case the work-around might be to copy over the necessary changes from trace_event_common.h in order to unblock #9618? @targos, I can put that together if you want, but it might be simpler for you to add the changes in #9618.

@matthewloring
Copy link

This change is definitely a step in the right direction. The reason I did not depend on the file directly was to avoid a dependency on a directory outside of deps/v8/include. IIRC the file was put outside of deps/v8/include because it was originally copied from Chromium but @fmeawad would have more context.

@mscdex mscdex added the trace_events Issues and PRs related to V8, Node.js core, and userspace code trace events. label Jan 29, 2017
@joshgav
Copy link
Contributor

joshgav commented Feb 6, 2017

V8 includes trace_event_common.h here with #include "base/trace_event/common/trace_event_common.h", which relies on the upstream src/base/trace_event/common repo in Chromium here.

@ofrobots @fmeawad would it be a good idea for Node to include the "trace_event_common" repo from Chromium directly under deps here in Node, rather than copy the file to deps/v8 as currently? And long term should we rely on one of these upstreams or our own fork as in #9304 and here?

@joshgav joshgav added the diag-agenda Issues and PRs to discuss during the meetings of the diagnostics working group. label Feb 23, 2017
@joshgav
Copy link
Contributor

joshgav commented Feb 23, 2017

Conclusion in discussion in Diag WG meeting today is that Node should manage its copy of the trace_event headers however we see fit and not worry about upstream Chromium. V8/Google plan to provide a proper tracing library eventually and when that's ready we can sync with it upstream.

@joshgav joshgav removed the diag-agenda Issues and PRs to discuss during the meetings of the diagnostics working group. label Feb 23, 2017
@targos
Copy link
Member Author

targos commented Feb 28, 2017

@joshgav thanks. Does it mean that we should go on with this PR?

Currently, trace_event.h contains a full copy of the header present in
deps/v8/base/trace_event/common/trace_event_common.h mixed with
implementation-specific macros.
This patch moves the V8 code to its own file and includes it from
trace_event.h.
The header is also updated to the latest version from V8 5.6.
@targos
Copy link
Member Author

targos commented Mar 1, 2017

Rebased and updated to the latest version from V8 5.6. src/tracing/trace_event_common.h is now a copy of deps/v8/base/trace_event/common/trace_event_common.h.

@jasnell
Copy link
Member

jasnell commented Mar 24, 2017

Any updates on this one?

@targos
Copy link
Member Author

targos commented Mar 25, 2017

I'm just waiting for some reviews

@@ -0,0 +1,1073 @@
// Copyright 2015 The Chromium Authors. All rights reserved.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file doesn't need include guards?


#if defined(TRACE_EVENT0)
#error "Another copy of this file has already been included."
#endif
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bnoordhuis It has this ^

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, but the file you moved that from has traditional include guards. I wondered (and wonder) if there is a reason not to add them here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't think about that. This is just a copy of the file from V8. Would you like me to add include guards?

@joshgav
Copy link
Contributor

joshgav commented Mar 28, 2017

LGTM.

But it doesn't seem to fix the break noted here (comment), per my testing with this follow-on commit.

cc @matthewloring

@matthewloring
Copy link

There are likely more changes required to account for updates to the macros in V8 5.7 which just landed on master. I'm currently working to put together a set of steps for updating these macros when V8 is updated. I also have a patch that will fix these files for 5.7. I can post the steps I've been using here or open the patch separately. @targos What would you prefer?

@targos
Copy link
Member Author

targos commented Mar 29, 2017

@matthewloring go ahead and open a PR

@matthewloring
Copy link

Opened here: #12127

@targos
Copy link
Member Author

targos commented Mar 30, 2017

Thanks. I'll close this one then.

@targos targos closed this Mar 30, 2017
@targos targos deleted the trace-event-common branch June 1, 2017 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c++ Issues and PRs that require attention from people who are familiar with C++. trace_events Issues and PRs related to V8, Node.js core, and userspace code trace events.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants