Skip to content

debuginfo: Add a "no_debug" attribute that allows to exclude functions from debuginfo generation. #16497

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

Merged
merged 1 commit into from
Aug 15, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/librustc/lint/builtin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,7 @@ impl LintPass for UnusedAttribute {
"packed",
"static_assert",
"thread_local",
"no_debug",

// not used anywhere (!?) but apparently we want to keep them around
"comment",
Expand Down
26 changes: 26 additions & 0 deletions src/librustc/middle/trans/debuginfo.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1128,6 +1128,10 @@ pub fn create_function_debug_context(cx: &CrateContext,

let (ident, fn_decl, generics, top_level_block, span, has_path) = match fnitem {
ast_map::NodeItem(ref item) => {
if contains_nodebug_attribute(item.attrs.as_slice()) {
return FunctionDebugContext { repr: FunctionWithoutDebugInfo };
}

match item.node {
ast::ItemFn(fn_decl, _, _, ref generics, top_level_block) => {
(item.ident, fn_decl, generics, top_level_block, item.span, true)
Expand All @@ -1141,6 +1145,12 @@ pub fn create_function_debug_context(cx: &CrateContext,
ast_map::NodeImplItem(ref item) => {
match **item {
ast::MethodImplItem(ref method) => {
if contains_nodebug_attribute(method.attrs.as_slice()) {
return FunctionDebugContext {
repr: FunctionWithoutDebugInfo
};
}

(method.pe_ident(),
method.pe_fn_decl(),
method.pe_generics(),
Expand Down Expand Up @@ -1173,6 +1183,12 @@ pub fn create_function_debug_context(cx: &CrateContext,
ast_map::NodeTraitItem(ref trait_method) => {
match **trait_method {
ast::ProvidedMethod(ref method) => {
if contains_nodebug_attribute(method.attrs.as_slice()) {
return FunctionDebugContext {
repr: FunctionWithoutDebugInfo
};
}

(method.pe_ident(),
method.pe_fn_decl(),
method.pe_generics(),
Expand Down Expand Up @@ -3169,6 +3185,16 @@ fn set_debug_location(cx: &CrateContext, debug_location: DebugLocation) {
// Utility Functions
//=-----------------------------------------------------------------------------

fn contains_nodebug_attribute(attributes: &[ast::Attribute]) -> bool {
attributes.iter().any(|attr| {
let meta_item: &ast::MetaItem = &*attr.node.value;
match meta_item.node {
ast::MetaWord(ref value) => value.get() == "no_debug",
_ => false
}
})
}

/// Return codemap::Loc corresponding to the beginning of the span
fn span_start(cx: &CrateContext, span: Span) -> codemap::Loc {
cx.sess().codemap().lookup_char_pos(span.lo)
Expand Down
45 changes: 45 additions & 0 deletions src/test/debuginfo/no-debug-attribute.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// ignore-android: FIXME(#10381)
// ignore-lldb

// compile-flags:-g

// gdb-command:break 'no-debug-attribute.rs':32
// gdb-command:break 'no-debug-attribute.rs':38
// gdb-command:run

// gdb-command:info locals
// gdb-check:No locals.
// gdb-command:continue

// gdb-command:info locals
// gdb-check:abc = 10
// gdb-command:continue

#![allow(unused_variable)]

fn function_with_debuginfo() {
let abc = 10u;
return (); // #break
}

#[no_debug]
fn function_without_debuginfo() {
let abc = -57i32;
return (); // #break
}

fn main() {
function_without_debuginfo();
function_with_debuginfo();
}