/usr/lib/llvm-3.4/include/lldb/Symbol/LineTable.h is in liblldb-3.4-dev 1:3.4.2-13.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 | //===-- LineTable.h ---------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#ifndef liblldb_LineTable_h_
#define liblldb_LineTable_h_
#include <vector>
#include "lldb/lldb-private.h"
#include "lldb/Symbol/LineEntry.h"
#include "lldb/Core/ModuleChild.h"
#include "lldb/Core/Section.h"
#include "lldb/Core/RangeMap.h"
namespace lldb_private {
//----------------------------------------------------------------------
/// @class LineSequence LineTable.h "lldb/Symbol/LineTable.h"
/// @brief An abstract base class used during symbol table creation.
//----------------------------------------------------------------------
class LineSequence
{
public:
LineSequence ();
virtual
~LineSequence() {}
virtual void
Clear() = 0;
private:
DISALLOW_COPY_AND_ASSIGN (LineSequence);
};
//----------------------------------------------------------------------
/// @class LineTable LineTable.h "lldb/Symbol/LineTable.h"
/// @brief A line table class.
//----------------------------------------------------------------------
class LineTable
{
public:
//------------------------------------------------------------------
/// Construct with compile unit.
///
/// @param[in] comp_unit
/// The compile unit to which this line table belongs.
//------------------------------------------------------------------
LineTable (CompileUnit* comp_unit);
//------------------------------------------------------------------
/// Destructor.
//------------------------------------------------------------------
~LineTable ();
//------------------------------------------------------------------
/// Adds a new line entry to this line table.
///
/// All line entries are maintained in file address order.
///
/// @param[in] line_entry
/// A const reference to a new line_entry to add to this line
/// table.
///
/// @see Address::DumpStyle
//------------------------------------------------------------------
// void
// AddLineEntry (const LineEntry& line_entry);
// Called when you can't guarantee the addresses are in increasing order
void
InsertLineEntry (lldb::addr_t file_addr,
uint32_t line,
uint16_t column,
uint16_t file_idx,
bool is_start_of_statement,
bool is_start_of_basic_block,
bool is_prologue_end,
bool is_epilogue_begin,
bool is_terminal_entry);
// Used to instantiate the LineSequence helper classw
LineSequence*
CreateLineSequenceContainer ();
// Append an entry to a caller-provided collection that will later be
// inserted in this line table.
void
AppendLineEntryToSequence (LineSequence* sequence,
lldb::addr_t file_addr,
uint32_t line,
uint16_t column,
uint16_t file_idx,
bool is_start_of_statement,
bool is_start_of_basic_block,
bool is_prologue_end,
bool is_epilogue_begin,
bool is_terminal_entry);
// Insert a sequence of entries into this line table.
void
InsertSequence (LineSequence* sequence);
//------------------------------------------------------------------
/// Dump all line entries in this line table to the stream \a s.
///
/// @param[in] s
/// The stream to which to dump the object descripton.
///
/// @param[in] style
/// The display style for the address.
///
/// @see Address::DumpStyle
//------------------------------------------------------------------
void
Dump (Stream *s, Target *target,
Address::DumpStyle style,
Address::DumpStyle fallback_style,
bool show_line_ranges);
void
GetDescription (Stream *s,
Target *target,
lldb::DescriptionLevel level);
//------------------------------------------------------------------
/// Find a line entry that contains the section offset address \a
/// so_addr.
///
/// @param[in] so_addr
/// A section offset address object containing the address we
/// are searching for.
///
/// @param[out] line_entry
/// A copy of the line entry that was found if \b true is
/// returned, otherwise \a entry is left unmodified.
///
/// @param[out] index_ptr
/// A pointer to a 32 bit integer that will get the actual line
/// entry index if it is not NULL.
///
/// @return
/// Returns \b true if \a so_addr is contained in a line entry
/// in this line table, \b false otherwise.
//------------------------------------------------------------------
bool
FindLineEntryByAddress (const Address &so_addr, LineEntry& line_entry, uint32_t *index_ptr = NULL);
//------------------------------------------------------------------
/// Find a line entry index that has a matching file index and
/// source line number.
///
/// Finds the next line entry that has a matching \a file_idx and
/// source line number \a line starting at the \a start_idx entries
/// into the line entry collection.
///
/// @param[in] start_idx
/// The number of entries to skip when starting the search.
///
/// @param[out] file_idx
/// The file index to search for that should be found prior
/// to calling this function using the following functions:
/// CompileUnit::GetSupportFiles()
/// FileSpecList::FindFileIndex (uint32_t, const FileSpec &) const
///
/// @param[in] line
/// The source line to match.
///
/// @param[in] exact
/// If true, match only if you find a line entry exactly matching \a line.
/// If false, return the closest line entry greater than \a line.
///
/// @param[out] line_entry
/// A reference to a line entry object that will get a copy of
/// the line entry if \b true is returned, otherwise \a
/// line_entry is left untouched.
///
/// @return
/// Returns \b true if a matching line entry is found in this
/// line table, \b false otherwise.
///
/// @see CompileUnit::GetSupportFiles()
/// @see FileSpecList::FindFileIndex (uint32_t, const FileSpec &) const
//------------------------------------------------------------------
uint32_t
FindLineEntryIndexByFileIndex (uint32_t start_idx,
uint32_t file_idx,
uint32_t line,
bool exact,
LineEntry* line_entry_ptr);
uint32_t
FindLineEntryIndexByFileIndex (uint32_t start_idx,
const std::vector<uint32_t> &file_indexes,
uint32_t line,
bool exact,
LineEntry* line_entry_ptr);
size_t
FineLineEntriesForFileIndex (uint32_t file_idx,
bool append,
SymbolContextList &sc_list);
//------------------------------------------------------------------
/// Get the line entry from the line table at index \a idx.
///
/// @param[in] idx
/// An index into the line table entry collection.
///
/// @return
/// A valid line entry if \a idx is a valid index, or an invalid
/// line entry if \a idx is not valid.
///
/// @see LineTable::GetSize()
/// @see LineEntry::IsValid() const
//------------------------------------------------------------------
bool
GetLineEntryAtIndex(uint32_t idx, LineEntry& line_entry);
//------------------------------------------------------------------
/// Gets the size of the line table in number of line table entries.
///
/// @return
/// The number of line table entries in this line table.
//------------------------------------------------------------------
uint32_t
GetSize () const;
typedef lldb_private::RangeArray<lldb::addr_t, lldb::addr_t, 32> FileAddressRanges;
//------------------------------------------------------------------
/// Gets all contiguous file address ranges for the entire line table.
///
/// @param[out] file_ranges
/// A collection of file address ranges that will be filled in
/// by this function.
///
/// @param[out] append
/// If \b true, then append to \a file_ranges, otherwise clear
/// \a file_ranges prior to adding any ranges.
///
/// @return
/// The number of address ranges added to \a file_ranges
//------------------------------------------------------------------
size_t
GetContiguousFileAddressRanges (FileAddressRanges &file_ranges, bool append);
//------------------------------------------------------------------
/// Given a file range link map, relink the current line table
/// and return a fixed up line table.
///
/// @param[out] file_range_map
/// A collection of file ranges that maps to new file ranges
/// that will be used when linking the line table.
///
/// @return
/// A new line table if at least one line table entry was able
/// to be mapped.
//------------------------------------------------------------------
typedef RangeDataVector<lldb::addr_t, lldb::addr_t, lldb::addr_t> FileRangeMap;
LineTable *
LinkLineTable (const FileRangeMap &file_range_map);
protected:
struct Entry
{
Entry () :
file_addr (LLDB_INVALID_ADDRESS),
line (0),
column (0),
file_idx (0),
is_start_of_statement (false),
is_start_of_basic_block (false),
is_prologue_end (false),
is_epilogue_begin (false),
is_terminal_entry (false)
{
}
Entry ( lldb::addr_t _file_addr,
uint32_t _line,
uint16_t _column,
uint16_t _file_idx,
bool _is_start_of_statement,
bool _is_start_of_basic_block,
bool _is_prologue_end,
bool _is_epilogue_begin,
bool _is_terminal_entry) :
file_addr (_file_addr),
line (_line),
column (_column),
file_idx (_file_idx),
is_start_of_statement (_is_start_of_statement),
is_start_of_basic_block (_is_start_of_basic_block),
is_prologue_end (_is_prologue_end),
is_epilogue_begin (_is_epilogue_begin),
is_terminal_entry (_is_terminal_entry)
{
}
int
bsearch_compare (const void *key, const void *arrmem);
void
Clear ()
{
file_addr = LLDB_INVALID_ADDRESS;
line = 0;
column = 0;
file_idx = 0;
is_start_of_statement = false;
is_start_of_basic_block = false;
is_prologue_end = false;
is_epilogue_begin = false;
is_terminal_entry = false;
}
static int
Compare (const Entry& lhs, const Entry& rhs)
{
// Compare the sections before calling
#define SCALAR_COMPARE(a,b) if (a < b) return -1; if (a > b) return +1
SCALAR_COMPARE (lhs.file_addr, rhs.file_addr);
SCALAR_COMPARE (lhs.line, rhs.line);
SCALAR_COMPARE (lhs.column, rhs.column);
SCALAR_COMPARE (lhs.is_start_of_statement, rhs.is_start_of_statement);
SCALAR_COMPARE (lhs.is_start_of_basic_block, rhs.is_start_of_basic_block);
// rhs and lhs reversed on purpose below.
SCALAR_COMPARE (rhs.is_prologue_end, lhs.is_prologue_end);
SCALAR_COMPARE (lhs.is_epilogue_begin, rhs.is_epilogue_begin);
// rhs and lhs reversed on purpose below.
SCALAR_COMPARE (rhs.is_terminal_entry, lhs.is_terminal_entry);
SCALAR_COMPARE (lhs.file_idx, rhs.file_idx);
#undef SCALAR_COMPARE
return 0;
}
class LessThanBinaryPredicate
{
public:
LessThanBinaryPredicate(LineTable *line_table);
bool operator() (const LineTable::Entry&, const LineTable::Entry&) const;
protected:
LineTable *m_line_table;
};
static bool EntryAddressLessThan (const Entry& lhs, const Entry& rhs)
{
return lhs.file_addr < rhs.file_addr;
}
//------------------------------------------------------------------
// Member variables.
//------------------------------------------------------------------
lldb::addr_t file_addr; ///< The file address for this line entry
uint32_t line; ///< The source line number, or zero if there is no line number information.
uint16_t column; ///< The column number of the source line, or zero if there is no column information.
uint16_t file_idx:11, ///< The file index into CompileUnit's file table, or zero if there is no file information.
is_start_of_statement:1, ///< Indicates this entry is the beginning of a statement.
is_start_of_basic_block:1, ///< Indicates this entry is the beginning of a basic block.
is_prologue_end:1, ///< Indicates this entry is one (of possibly many) where execution should be suspended for an entry breakpoint of a function.
is_epilogue_begin:1, ///< Indicates this entry is one (of possibly many) where execution should be suspended for an exit breakpoint of a function.
is_terminal_entry:1; ///< Indicates this entry is that of the first byte after the end of a sequence of target machine instructions.
};
struct EntrySearchInfo
{
LineTable* line_table;
lldb_private::Section *a_section;
Entry *a_entry;
};
//------------------------------------------------------------------
// Types
//------------------------------------------------------------------
typedef std::vector<lldb_private::Section*> section_collection; ///< The collection type for the sections.
typedef std::vector<Entry> entry_collection; ///< The collection type for the line entries.
//------------------------------------------------------------------
// Member variables.
//------------------------------------------------------------------
CompileUnit* m_comp_unit; ///< The compile unit that this line table belongs to.
entry_collection m_entries; ///< The collection of line entries in this line table.
//------------------------------------------------------------------
// Helper class
//------------------------------------------------------------------
class LineSequenceImpl : public LineSequence
{
public:
LineSequenceImpl() :
LineSequence()
{}
virtual
~LineSequenceImpl()
{}
virtual void
Clear();
entry_collection m_entries; ///< The collection of line entries in this sequence.
};
bool
ConvertEntryAtIndexToLineEntry (uint32_t idx, LineEntry &line_entry);
private:
DISALLOW_COPY_AND_ASSIGN (LineTable);
};
} // namespace lldb_private
#endif // liblldb_LineTable_h_
|