git.sur5r.net Git - cc65/blob - src/dbginfo/dbginfo.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 dbginfo.h                                 */
   4 /*                                                                           */
   5 /*                         cc65 debug info handling                          */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2010-2011, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 52                                           */
  11 /*                D-70794 Filderstadt                                        */
  12 /* EMail:         uz@cc65.org                                                */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef DBGINFO_H
  37 #define DBGINFO_H
  38
  39
  40
  41 /* Allow usage from C++ */
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46
  47
  48 /*****************************************************************************/
  49 /*                                   Data                                    */
  50 /*****************************************************************************/
  51
  52
  53
  54 /* Data types used for addresses, sizes and line numbers. Change to "unsigned
  55  * long" if you ever want to run the code on a 16-bit machine.
  56  */
  57 typedef unsigned cc65_line;             /* Used to store line numbers */
  58 typedef unsigned cc65_addr;             /* Used to store (65xx) addresses */
  59 typedef unsigned cc65_size;             /* Used to store (65xx) sizes */
  60
  61 /* A value that is used to mark invalid ids */
  62 #define CC65_INV_ID     (~0U)
  63
  64
  65
  66 /*****************************************************************************/
  67 /*                             Debug info files                              */
  68 /*****************************************************************************/
  69
  70
  71
  72 /* Severity for cc65_parseerror */
  73 typedef enum {
  74     CC65_WARNING,
  75     CC65_ERROR,
  76 } cc65_error_severity;
  77
  78 /* Warnings/errors in cc65_read_dbginfo are passed via this struct */
  79 typedef struct cc65_parseerror cc65_parseerror;
  80 struct cc65_parseerror {
  81     cc65_error_severity type;           /* Type of error */
  82     const char*         name;           /* Name of input file */
  83     cc65_line           line;           /* Error line */
  84     unsigned            column;         /* Error column */
  85     char                errormsg[1];    /* Error message */
  86 };
  87
  88 /* Function that is called in case of parse errors */
  89 typedef void (*cc65_errorfunc) (const cc65_parseerror*);
  90
  91 /* Pointer to an opaque data structure containing information from the debug
  92  * info file. Actually a handle to the data in the file.
  93  */
  94 typedef const void* cc65_dbginfo;
  95
  96
  97
  98 cc65_dbginfo cc65_read_dbginfo (const char* filename, cc65_errorfunc errorfunc);
  99 /* Parse the debug info file with the given name. On success, the function
 100  * will return a pointer to an opaque cc65_dbginfo structure, that must be
 101  * passed to the other functions in this module to retrieve information.
 102  * errorfunc is called in case of warnings and errors. If the file cannot be
 103  * read successfully, NULL is returned.
 104  */
 105
 106 void cc65_free_dbginfo (cc65_dbginfo Handle);
 107 /* Free debug information read from a file */
 108
 109
 110
 111 /*****************************************************************************/
 112 /*                                 Libraries                                 */
 113 /*****************************************************************************/
 114
 115
 116
 117 /* Library information */
 118 typedef struct cc65_librarydata cc65_librarydata;
 119 struct cc65_librarydata {
 120     unsigned            library_id;     /* The internal library id */
 121     const char*         library_name;   /* Name of the library */
 122 };
 123
 124 typedef struct cc65_libraryinfo cc65_libraryinfo;
 125 struct cc65_libraryinfo {
 126     unsigned            count;          /* Number of data sets that follow */
 127     cc65_librarydata    data[1];        /* Data sets, number is dynamic */
 128 };
 129
 130
 131
 132 const cc65_libraryinfo* cc65_get_librarylist (cc65_dbginfo handle);
 133 /* Return a list of all libraries */
 134
 135 const cc65_libraryinfo* cc65_library_byid (cc65_dbginfo handle, unsigned id);
 136 /* Return information about a library with a specific id. The function
 137  * returns NULL if the id is invalid (no such library) and otherwise a
 138  * cc65_libraryinfo structure with one entry that contains the requested
 139  * library information.
 140  */
 141
 142 void cc65_free_libraryinfo (cc65_dbginfo handle, const cc65_libraryinfo* info);
 143 /* Free a library info record */
 144
 145
 146
 147 /*****************************************************************************/
 148 /*                                 Line info                                 */
 149 /*****************************************************************************/
 150
 151
 152
 153 /* Type of line */
 154 typedef enum {
 155     CC65_LINE_ASM,                      /* Assembler source */
 156     CC65_LINE_EXT,                      /* Externally supplied (= C) */
 157     CC65_LINE_MACRO,                    /* Macro expansion */
 158 } cc65_line_type;
 159
 160 /* Line information */
 161 typedef struct cc65_linedata cc65_linedata;
 162 struct cc65_linedata {
 163     unsigned            line_id;        /* Internal id of this record */
 164     unsigned            source_id;      /* Id of the source file */
 165     cc65_line           source_line;    /* Line number */
 166     cc65_line_type      line_type;      /* Type of line */
 167     unsigned            count;          /* Nesting counter for macros */
 168 };
 169
 170 typedef struct cc65_lineinfo cc65_lineinfo;
 171 struct cc65_lineinfo {
 172     unsigned            count;          /* Number of data sets that follow */
 173     cc65_linedata       data[1];        /* Data sets, number is dynamic */
 174 };
 175
 176
 177
 178 const cc65_lineinfo* cc65_line_byid (cc65_dbginfo handle, unsigned id);
 179 /* Return information about a line with a specific id. The function
 180  * returns NULL if the id is invalid (no such line) and otherwise a
 181  * cc65_lineinfo structure with one entry that contains the requested
 182  * module information.
 183  */
 184
 185 const cc65_lineinfo* cc65_line_bynumber (cc65_dbginfo handle,
 186                                          unsigned source_id,
 187                                          cc65_line line);
 188 /* Return line information for a source file/line number combination. The
 189  * function returns NULL if no line information was found.
 190  */
 191
 192 const cc65_lineinfo* cc65_line_bysource (cc65_dbginfo Handle, unsigned source_id);
 193 /* Return line information for a source file. The function returns NULL if the
 194  * file id is invalid.
 195  */
 196
 197 const cc65_lineinfo* cc65_line_bysymdef (cc65_dbginfo handle, unsigned symbol_id);
 198 /* Return line information for the definition of a symbol. The function
 199  * returns NULL if the symbol id is invalid, otherwise a list of line infos.
 200  */
 201
 202 const cc65_lineinfo* cc65_line_bysymref (cc65_dbginfo handle, unsigned symbol_id);
 203 /* Return line information for all references of a symbol. The function
 204  * returns NULL if the symbol id is invalid, otherwise a list of line infos.
 205  */
 206
 207 void cc65_free_lineinfo (cc65_dbginfo handle, const cc65_lineinfo* info);
 208 /* Free line info returned by one of the other functions */
 209
 210
 211
 212 /*****************************************************************************/
 213 /*                                  Modules                                  */
 214 /*****************************************************************************/
 215
 216
 217
 218 /* Module information
 219  * Notes:
 220  *   - scope_id contains CC65_INV_ID if the module was compiled without
 221  *     debug information.
 222  */
 223 typedef struct cc65_moduledata cc65_moduledata;
 224 struct cc65_moduledata {
 225     unsigned            module_id;      /* The internal module id */
 226     const char*         module_name;    /* Name of the module */
 227     unsigned            source_id;      /* Id of the module main file */
 228     unsigned            library_id;     /* Id of the library if any */
 229     unsigned            scope_id;       /* Id of the main scope */
 230 };
 231
 232 typedef struct cc65_moduleinfo cc65_moduleinfo;
 233 struct cc65_moduleinfo {
 234     unsigned            count;          /* Number of data sets that follow */
 235     cc65_moduledata     data[1];        /* Data sets, number is dynamic */
 236 };
 237
 238
 239
 240 const cc65_moduleinfo* cc65_get_modulelist (cc65_dbginfo handle);
 241 /* Return a list of all modules */
 242
 243 const cc65_moduleinfo* cc65_module_byid (cc65_dbginfo handle, unsigned id);
 244 /* Return information about a module with a specific id. The function
 245  * returns NULL if the id is invalid (no such module) and otherwise a
 246  * cc65_moduleinfo structure with one entry that contains the requested
 247  * module information.
 248  */
 249
 250 void cc65_free_moduleinfo (cc65_dbginfo handle, const cc65_moduleinfo* info);
 251 /* Free a module info record */
 252
 253
 254
 255 /*****************************************************************************/
 256 /*                                   Spans                                   */
 257 /*****************************************************************************/
 258
 259
 260
 261 /* Span information */
 262 typedef struct cc65_spandata cc65_spandata;
 263 struct cc65_spandata {
 264     unsigned            span_id;        /* The internal span id */
 265     cc65_addr           span_start;     /* Start of the span */
 266     cc65_addr           span_end;       /* End of the span (inclusive!) */
 267     unsigned            segment_id;     /* Id of the segment */
 268     unsigned            line_count;     /* Number of lines attached */
 269     unsigned            scope_count;    /* Number of scopes attached */
 270 };
 271
 272 typedef struct cc65_spaninfo cc65_spaninfo;
 273 struct cc65_spaninfo {
 274     unsigned            count;          /* Number of data sets that follow */
 275     cc65_spandata       data[1];        /* Data sets, number is dynamic */
 276 };
 277
 278
 279
 280 const cc65_spaninfo* cc65_get_spanlist (cc65_dbginfo handle);
 281 /* Return a list of all spans. BEWARE: Large! */
 282
 283 const cc65_spaninfo* cc65_span_byid (cc65_dbginfo handle, unsigned id);
 284 /* Return information about a span with a specific id. The function
 285  * returns NULL if the id is invalid (no such span) and otherwise a
 286  * cc65_spaninfo structure with one entry that contains the requested
 287  * span information.
 288  */
 289
 290 const cc65_spaninfo* cc65_span_byaddr (cc65_dbginfo handle,
 291                                        unsigned long addr);
 292 /* Return span information for the given address. The function returns NULL
 293  * if no spans were found for this address.
 294  */
 295
 296 const cc65_spaninfo* cc65_span_byline (cc65_dbginfo handle, unsigned line_id);
 297 /* Return span information for the given source line. The function returns NULL
 298  * if the line id is invalid, otherwise the spans for this line (possibly zero).
 299  */
 300
 301 const cc65_spaninfo* cc65_span_byscope (cc65_dbginfo handle, unsigned scope_id);
 302 /* Return span information for the given scope. The function returns NULL if
 303  * the scope id is invalid, otherwise the spans for this scope (possibly zero).
 304  */
 305
 306 void cc65_free_spaninfo (cc65_dbginfo handle, const cc65_spaninfo* info);
 307 /* Free a span info record */
 308
 309
 310
 311 /*****************************************************************************/
 312 /*                               Source files                                */
 313 /*****************************************************************************/
 314
 315
 316
 317 /* Source file information */
 318 typedef struct cc65_sourcedata cc65_sourcedata;
 319 struct cc65_sourcedata {
 320     unsigned            source_id;      /* The internal file id */
 321     const char*         source_name;    /* Name of the file */
 322     unsigned long       source_size;    /* Size of file */
 323     unsigned long       source_mtime;   /* Modification time */
 324 };
 325
 326 typedef struct cc65_sourceinfo cc65_sourceinfo;
 327 struct cc65_sourceinfo {
 328     unsigned            count;          /* Number of data sets that follow */
 329     cc65_sourcedata     data[1];        /* Data sets, number is dynamic */
 330 };
 331
 332
 333
 334 const cc65_sourceinfo* cc65_get_sourcelist (cc65_dbginfo handle);
 335 /* Return a list of all source files */
 336
 337 const cc65_sourceinfo* cc65_source_byid (cc65_dbginfo handle, unsigned id);
 338 /* Return information about a source file with a specific id. The function
 339  * returns NULL if the id is invalid (no such source file) and otherwise a
 340  * cc65_sourceinfo structure with one entry that contains the requested
 341  * source file information.
 342  */
 343
 344 const cc65_sourceinfo* cc65_source_bymodule (cc65_dbginfo handle,
 345                                              unsigned module_id);
 346 /* Return information about the source files used to build a module. The
 347  * function returns NULL if the module id is invalid (no such module) and
 348  * otherwise a cc65_sourceinfo structure with one entry per source file.
 349  */
 350
 351 void cc65_free_sourceinfo (cc65_dbginfo handle, const cc65_sourceinfo* info);
 352 /* Free a source info record */
 353
 354
 355
 356 /*****************************************************************************/
 357 /*                                 Segments                                  */
 358 /*****************************************************************************/
 359
 360
 361
 362 /* Segment information.
 363  * Notes:
 364  *   - output_name may be NULL if the data wasn't written to the output file
 365  *     (example: bss segment)
 366  *   - output_offs is invalid if there is no output_name, and may not be of
 367  *     much use in case of a relocatable output file
 368  */
 369 typedef struct cc65_segmentdata cc65_segmentdata;
 370 struct cc65_segmentdata {
 371     unsigned            segment_id;     /* The internal segment id */
 372     const char*         segment_name;   /* Name of the segment */
 373     cc65_addr           segment_start;  /* Start address of segment */
 374     cc65_size           segment_size;   /* Size of segment */
 375     const char*         output_name;    /* Output file this seg was written to */
 376     unsigned long       output_offs;    /* Offset of this seg in output file */
 377 };
 378
 379 typedef struct cc65_segmentinfo cc65_segmentinfo;
 380 struct cc65_segmentinfo {
 381     unsigned            count;          /* Number of data sets that follow */
 382     cc65_segmentdata    data[1];        /* Data sets, number is dynamic */
 383 };
 384
 385
 386
 387 const cc65_segmentinfo* cc65_get_segmentlist (cc65_dbginfo handle);
 388 /* Return a list of all segments referenced in the debug information */
 389
 390 const cc65_segmentinfo* cc65_segment_byid (cc65_dbginfo handle, unsigned id);
 391 /* Return information about a segment with a specific id. The function returns
 392  * NULL if the id is invalid (no such segment) and otherwise a cc65_segmentinfo
 393  * structure with one entry that contains the requested segment information.
 394  */
 395
 396 const cc65_segmentinfo* cc65_segment_byname (cc65_dbginfo handle,
 397                                              const char* name);
 398 /* Return information about a segment with a specific name. The function
 399  * returns NULL if no segment with this name exists and otherwise a
 400  * cc65_segmentinfo structure with one entry that contains the requested
 401  * information.
 402  */
 403
 404 void cc65_free_segmentinfo (cc65_dbginfo handle, const cc65_segmentinfo* info);
 405 /* Free a segment info record */
 406
 407
 408
 409 /*****************************************************************************/
 410 /*                                  Symbols                                  */
 411 /*****************************************************************************/
 412
 413
 414
 415 /* Symbol information */
 416 typedef enum {
 417     CC65_SYM_EQUATE,
 418     CC65_SYM_LABEL,                     /* Some sort of address */
 419     CC65_SYM_IMPORT,                    /* An import */
 420 } cc65_symbol_type;
 421
 422 /* Notes:
 423  *  - If the symbol is segment relative, the segment id gives segment
 424  *    information, otherwise it contains CC65_INV_ID.
 425  *  - If the type is CC65_SYM_IMPORT, export_id may contain the id of the
 426  *    export. This is not the case if the module contaiing the export doesn't
 427  *    have debug information.
 428  *  - For an import, the fields symbol_value and segment_id are taken from
 429  *    the export, if it is available, since imports have no value or segments
 430  *    by itself.
 431  *  - For an import symbol_size doesn't have a meaning.
 432  *  - For normal symbols (not cheap locals) parent_id contains CC65_INV_ID,
 433  *    for cheap locals it contains the symbol id of the parent symbol.
 434  */
 435 typedef struct cc65_symboldata cc65_symboldata;
 436 struct cc65_symboldata {
 437     unsigned            symbol_id;      /* Id of symbol */
 438     const char*         symbol_name;    /* Name of symbol */
 439     cc65_symbol_type    symbol_type;    /* Type of symbol */
 440     cc65_size           symbol_size;    /* Size of symbol, 0 if unknown */
 441     long                symbol_value;   /* Value of symbol */
 442     unsigned            export_id;      /* For imports: Matching export */
 443     unsigned            segment_id;     /* Id of segment if any */
 444     unsigned            scope_id;       /* The scope this symbol is in */
 445     unsigned            parent_id;      /* Parent symbol for cheap locals */
 446 };
 447
 448 typedef struct cc65_symbolinfo cc65_symbolinfo;
 449 struct cc65_symbolinfo {
 450     unsigned            count;          /* Number of data sets that follow */
 451     cc65_symboldata     data[1];        /* Data sets, number is dynamic */
 452 };
 453
 454
 455
 456 const cc65_symbolinfo* cc65_symbol_byid (cc65_dbginfo handle, unsigned id);
 457 /* Return the symbol with a given id. The function returns NULL if no symbol
 458  * with this id was found.
 459  */
 460
 461 const cc65_symbolinfo* cc65_symbol_byname (cc65_dbginfo handle, const char* name);
 462 /* Return a list of symbols with a given name. The function returns NULL if
 463  * no symbol with this name was found.
 464  */
 465
 466 const cc65_symbolinfo* cc65_symbol_byscope (cc65_dbginfo handle,
 467                                             unsigned scope_id);
 468 /* Return a list of symbols in the given scope. This includes cheap local
 469  * symbols, but not symbols in subscopes. The function returns NULL if the
 470  * scope id is invalid (no such scope) and otherwise a - possibly empty -
 471  * symbol list.
 472  */
 473
 474 const cc65_symbolinfo* cc65_symbol_inrange (cc65_dbginfo handle,
 475                                             cc65_addr start, cc65_addr end);
 476 /* Return a list of labels in the given range. end is inclusive. The function
 477  * return NULL if no symbols within the given range are found. Non label
 478  * symbols are ignored and not returned.
 479  */
 480
 481 void cc65_free_symbolinfo (cc65_dbginfo Handle, const cc65_symbolinfo* Info);
 482 /* Free a symbol info record */
 483
 484
 485
 486 /*****************************************************************************/
 487 /*                                  Scopes                                   */
 488 /*****************************************************************************/
 489
 490
 491
 492 /* Scope information */
 493 typedef enum {
 494     CC65_SCOPE_GLOBAL,                  /* Global scope */
 495     CC65_SCOPE_MODULE,                  /* Module scope */
 496     CC65_SCOPE_SCOPE,                   /* .PROC/.SCOPE */
 497     CC65_SCOPE_STRUCT,                  /* .STRUCT */
 498     CC65_SCOPE_ENUM,                    /* .ENUM */
 499 } cc65_scope_type;
 500
 501 typedef struct cc65_scopedata cc65_scopedata;
 502 struct cc65_scopedata {
 503     unsigned            scope_id;       /* Id of scope */
 504     const char*         scope_name;     /* Name of scope */
 505     cc65_scope_type     scope_type;     /* Type of scope */
 506     cc65_size           scope_size;     /* Size of scope, 0 if unknown */
 507     unsigned            parent_id;      /* Id of parent scope */
 508     unsigned            symbol_id;      /* Id of scope symbol if any */
 509     unsigned            module_id;      /* Id of the module */
 510 };
 511
 512 typedef struct cc65_scopeinfo cc65_scopeinfo;
 513 struct cc65_scopeinfo {
 514     unsigned            count;          /* Number of data sets that follow */
 515     cc65_scopedata      data[1];        /* Data sets, number is dynamic */
 516 };
 517
 518
 519
 520 const cc65_scopeinfo* cc65_get_scopelist (cc65_dbginfo handle);
 521 /* Return a list of all scopes in the debug information */
 522
 523 const cc65_scopeinfo* cc65_scope_byid (cc65_dbginfo handle, unsigned id);
 524 /* Return the scope with a given id. The function returns NULL if no scope
 525  * with this id was found.
 526  */
 527
 528 const cc65_scopeinfo* cc65_scope_bymodule (cc65_dbginfo handle, unsigned module_id);
 529 /* Return the list of scopes for one module. The function returns NULL if no
 530  * scope with the given id was found.
 531  */
 532
 533 const cc65_scopeinfo* cc65_scope_byname (cc65_dbginfo handle, const char* name);
 534 /* Return the list of scopes with a given name. Returns NULL if no scope with
 535  * the given name was found, otherwise a non empty scope list.
 536  */
 537
 538 const cc65_scopeinfo* cc65_childscopes_byid (cc65_dbginfo handle, unsigned id);
 539 /* Return the direct child scopes of a scope with a given id. The function
 540  * returns NULL if no scope with this id was found, otherwise a list of the
 541  * direct childs.
 542  */
 543
 544 void cc65_free_scopeinfo (cc65_dbginfo Handle, const cc65_scopeinfo* Info);
 545 /* Free a scope info record */
 546
 547
 548
 549 /* Allow usage from C++ */
 550 #ifdef __cplusplus
 551 }
 552 #endif
 553
 554
 555
 556 /* End of dbginfo.h */
 557 #endif
 558
 559
 560