| Version | Date | Change |
|---|---|---|
| 1.0 | 2011-11-11 | Initial |
Line numbers service associates locations in the source files with the corresponding machine instruction addresses in the executable object.
Line number information is searched in symbol files of a debug context. The symbol file list is handled by Memory Map Service.
Results of line information searches are arrays of Code Area objects. Code Area represents a continues area in source text mapped to continues range of code addresses. Code Area data object is collection of area properties.
Lines are numbered beginning at 1.
Columns are numbered beginning at 1. The value 0 is reserved to indicate that a code area begins at the "left edge" of the line. Absence of column property means same as value 0.
Predefined Code Area properties are:
"SLine" : <number>
- line number of the start of the area in the source file.
"SCol" : <number>
- column number of the start of the area in the source file.
"SAddr" : <number>
- address of the start of the area in memory.
"ELine" : <number>
- line number of the end of the area in the source file.
"ECol" : <number>
- column number of the end of the area in the source file.
"EAddr" : <number>
- address of the end of the area in memory.
"NAddr" : <number>
- address of the next area in the source file.
"File" : <string>
- name of the source file corresponding to the area. It can be relative to "Dir".
"Dir" : <string>
- directory name of of the source file corresponding to the area.
"ISA" : <number>
- an integer whose value encodes the applicable instruction set architecture for the area.
"IsStmt" : <boolean>
- a boolean indicating that the area is a recommended breakpoint location.
A recommended breakpoint location is intended to "represent" a line, a statement and/or a semantically distinct subpart of a statement.
"BasicBlock" : <boolean>
- a boolean indicating that the area is the beginning of a basic block.
"PrologueEnd" : <boolean>
- a boolean indicating that the area is one (of possibly many) where execution should be suspended for an entry breakpoint of a function.
"EpilogueBegin" : <boolean>
- a boolean indicating that the area is one (of possibly many) where execution should be suspended for an exit breakpoint of a function.
"OpIndex" : <number>
- an integer representing the index of an operation within a VLIW instruction.
The index of the first operation is 0. For non-VLIW architectures, this is either 0 or absent.
"Discriminator" : <number>
- an integer identifying the block to which the area belongs.
Discriminator values are assigned arbitrarily by the debug information producer and serve to distinguish among
multiple blocks that may all be associated with the same source file, line, and column.
Where only one block exists for a given source position, the discriminator value should be either 0 or absent.
"NStmtAddr" : <number>
- address of the next recommended breakpoint location (start of statement).
<array of code areas>
⇒ null
⇒ [ <code area list> ]
<code area list>
⇒ <Code Area: object>
⇒ <code area list> , <Code Area: object>
The service uses standard format for error reports, see Error Report Format.
C • <token> • LineNumbers • mapToSource • <string: context ID> • <number: start address> • <number: end address> •
The command searches line number information for given range of memory addresses of a context.
The reply contains an array of Code Area objects:
R • <token> • <error report> • <array of code areas> •
C • <token> • LineNumbers • mapToMemory • <string: context ID> • <string: file> • <number: line> • <number: column> •
The command searches line number information for given source file name, line and column.
The reply contains an array of Code Area objects:
R • <token> • <error report> • <array of code areas> •
/**
* Line numbers service associates locations in the source files with the corresponding
* machine instruction addresses in the executable object.
*
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ILineNumbers extends IService {
static final String NAME = "LineNumbers";
/**
* CodeArea represent a continues area in source text mapped to
* continues range of code addresses.
* Line and columns are counted starting from 1.
* File name can be relative path, in such case client should
* use CodeArea directory name as origin for the path.
* File and directory names are valid on a host where code was compiled.
* It is client responsibility to map names to this host file system.
*/
final class CodeArea {
public final String directory;
public final String file;
public final int start_line;
public final int start_column;
public final int end_line;
public final int end_column;
public final Number start_address;
public final Number end_address;
public final Number next_stmt_address;
public final int isa;
public final boolean is_statement;
public final boolean basic_block;
public final boolean prologue_end;
public final boolean epilogue_begin;
public CodeArea(String directory, String file, int start_line, int start_column,
int end_line, int end_column, Number start_address, Number end_address, int isa,
boolean is_statement, boolean basic_block,
boolean prologue_end, boolean epilogue_begin) {
this.directory = directory;
this.file = file;
this.start_line = start_line;
this.start_column = start_column;
this.end_line = end_line;
this.end_column = end_column;
this.start_address = start_address;
this.end_address = end_address;
this.next_stmt_address = null;
this.isa = isa;
this.is_statement = is_statement;
this.basic_block = basic_block;
this.prologue_end = prologue_end;
this.epilogue_begin = epilogue_begin;
}
/**
* @since 1.7
*/
public CodeArea(String directory, String file, int start_line, int start_column,
int end_line, int end_column, Number start_address, Number end_address, Number next_stmt_address, int isa,
boolean is_statement, boolean basic_block,
boolean prologue_end, boolean epilogue_begin) {
this.directory = directory;
this.file = file;
this.start_line = start_line;
this.start_column = start_column;
this.end_line = end_line;
this.end_column = end_column;
this.start_address = start_address;
this.end_address = end_address;
this.next_stmt_address = next_stmt_address;
this.isa = isa;
this.is_statement = is_statement;
this.basic_block = basic_block;
this.prologue_end = prologue_end;
this.epilogue_begin = epilogue_begin;
}
/**
* @since 1.3
*/
public CodeArea(Map<String,Object> area, CodeArea prev) {
this(getString(area, "Dir", prev != null ? prev.directory : null),
getString(area, "File", prev != null ? prev.file : null),
getInteger(area, "SLine", 0), getInteger(area, "SCol", 0),
getInteger(area, "ELine", 0), getInteger(area, "ECol", 0),
(Number)area.get("SAddr"), (Number)area.get("EAddr"),
(Number)area.get("NStmtAddr"), getInteger(area, "ISA", 0),
getBoolean(area, "IsStmt"), getBoolean(area, "BasicBlock"),
getBoolean(area, "PrologueEnd"), getBoolean(area, "EpilogueBegin"));
}
private static int getInteger(Map<String,Object> map, String name, int def) {
Number n = (Number)map.get(name);
if (n == null) return def;
return n.intValue();
}
private static String getString(Map<String,Object> map, String name, String def) {
String s = (String)map.get(name);
if (s == null) return def;
return s;
}
private static boolean getBoolean(Map<String,Object> map, String name) {
Boolean b = (Boolean)map.get(name);
if (b == null) return false;
return b.booleanValue();
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof CodeArea)) return false;
CodeArea a = (CodeArea)o;
if (start_line != a.start_line) return false;
if (start_column != a.start_column) return false;
if (end_line != a.end_line) return false;
if (end_column != a.end_column) return false;
if (isa != a.isa) return false;
if (is_statement != a.is_statement) return false;
if (basic_block != a.basic_block) return false;
if (prologue_end != a.prologue_end) return false;
if (epilogue_begin != a.epilogue_begin) return false;
if (start_address != null && !start_address.equals(a.start_address)) return false;
if (start_address == null && a.start_address != null) return false;
if (end_address != null && !end_address.equals(a.end_address)) return false;
if (end_address == null && a.end_address != null) return false;
if (next_stmt_address != null && !next_stmt_address.equals(a.next_stmt_address)) return false;
if (next_stmt_address == null && a.next_stmt_address != null) return false;
if (file != null && !file.equals(a.file)) return false;
if (file == null && a.file != null) return false;
if (directory != null && !directory.equals(a.directory)) return false;
if (directory == null && a.directory != null) return false;
return true;
}
@Override
public int hashCode() {
int h = 0;
if (file != null) h += file.hashCode();
return h + start_line + start_column + end_line + end_column;
}
@Override
public String toString() {
StringBuffer bf = new StringBuffer();
bf.append('[');
if (directory != null) {
bf.append(directory);
bf.append(':');
}
if (file != null) {
bf.append(file);
bf.append(':');
}
bf.append(start_line);
if (start_column != 0) {
bf.append('.');
bf.append(start_column);
}
bf.append("..");
bf.append(end_line);
if (end_column != 0) {
bf.append('.');
bf.append(end_column);
}
bf.append(" -> ");
if (start_address != null) {
bf.append("0x");
bf.append(JSON.toBigInteger(start_address).toString(16));
}
else {
bf.append('0');
}
bf.append("..");
if (end_address != null) {
bf.append("0x");
bf.append(JSON.toBigInteger(end_address).toString(16));
}
else {
bf.append('0');
}
if (next_stmt_address != null) {
bf.append(",next stmt ");
bf.append("0x");
bf.append(JSON.toBigInteger(next_stmt_address).toString(16));
}
if (isa != 0) {
bf.append(",isa ");
bf.append(isa);
}
if (is_statement) {
bf.append(",statement");
}
if (basic_block) {
bf.append(",basic block");
}
if (prologue_end) {
bf.append(",prologue end");
}
if (epilogue_begin) {
bf.append(",epilogue begin");
}
bf.append(']');
return bf.toString();
}
}
IToken mapToSource(String context_id, Number start_address, Number end_address, DoneMapToSource done);
interface DoneMapToSource {
void doneMapToSource(IToken token, Exception error, CodeArea[] areas);
}
IToken mapToMemory(String context_id, String file, int line, int column, DoneMapToMemory done);
interface DoneMapToMemory {
void doneMapToMemory(IToken token, Exception error, CodeArea[] areas);
}
}