binutils/debug.h

   1 /* debug.h -- Describe generic debugging information.
   2    Copyright (C) 1995 Free Software Foundation, Inc.
   3    Written by Ian Lance Taylor <ian@cygnus.com>.
   4
   5    This file is part of GNU Binutils.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20    02111-1307, USA.  */
  21
  22 #ifndef DEBUG_H
  23 #define DEBUG_H
  24
  25 /* This header file describes a generic debugging information format.
  26    We may eventually have readers which convert different formats into
  27    this generic format, and writers which write it out.  The initial
  28    impetus for this was writing a convertor from stabs to HP IEEE-695
  29    debugging format.  */
  30
  31 /* Different kinds of types.  */
  32
  33 enum debug_type_kind
  34 {
  35   /* Indirect via a pointer.  */
  36   DEBUG_KIND_INDIRECT,
  37   /* Void.  */
  38   DEBUG_KIND_VOID,
  39   /* Integer.  */
  40   DEBUG_KIND_INT,
  41   /* Floating point.  */
  42   DEBUG_KIND_FLOAT,
  43   /* Complex.  */
  44   DEBUG_KIND_COMPLEX,
  45   /* Boolean.  */
  46   DEBUG_KIND_BOOL,
  47   /* Struct.  */
  48   DEBUG_KIND_STRUCT,
  49   /* Union.  */
  50   DEBUG_KIND_UNION,
  51   /* Class.  */
  52   DEBUG_KIND_CLASS,
  53   /* Union class (can this really happen?).  */
  54   DEBUG_KIND_UNION_CLASS,
  55   /* Enumeration type.  */
  56   DEBUG_KIND_ENUM,
  57   /* Pointer.  */
  58   DEBUG_KIND_POINTER,
  59   /* Function.  */
  60   DEBUG_KIND_FUNCTION,
  61   /* Reference.  */
  62   DEBUG_KIND_REFERENCE,
  63   /* Range.  */
  64   DEBUG_KIND_RANGE,
  65   /* Array.  */
  66   DEBUG_KIND_ARRAY,
  67   /* Set.  */
  68   DEBUG_KIND_SET,
  69   /* Based pointer.  */
  70   DEBUG_KIND_OFFSET,
  71   /* Method.  */
  72   DEBUG_KIND_METHOD,
  73   /* Const qualified type.  */
  74   DEBUG_KIND_CONST,
  75   /* Volatile qualified type.  */
  76   DEBUG_KIND_VOLATILE,
  77   /* Named type.  */
  78   DEBUG_KIND_NAMED,
  79   /* Tagged type.  */
  80   DEBUG_KIND_TAGGED
  81 };
  82
  83 /* Different kinds of variables.  */
  84
  85 enum debug_var_kind
  86 {
  87   /* A global variable.  */
  88   DEBUG_GLOBAL,
  89   /* A static variable.  */
  90   DEBUG_STATIC,
  91   /* A local static variable.  */
  92   DEBUG_LOCAL_STATIC,
  93   /* A local variable.  */
  94   DEBUG_LOCAL,
  95   /* A register variable.  */
  96   DEBUG_REGISTER
  97 };
  98
  99 /* Different kinds of function parameters.  */
 100
 101 enum debug_parm_kind
 102 {
 103   /* A stack based parameter.  */
 104   DEBUG_PARM_STACK,
 105   /* A register parameter.  */
 106   DEBUG_PARM_REG,
 107   /* A stack based reference parameter.  */
 108   DEBUG_PARM_REFERENCE,
 109   /* A register reference parameter.  */
 110   DEBUG_PARM_REF_REG
 111 };
 112
 113 /* Different kinds of visibility.  */
 114
 115 enum debug_visibility
 116 {
 117   /* A public field (e.g., a field in a C struct).  */
 118   DEBUG_VISIBILITY_PUBLIC,
 119   /* A protected field.  */
 120   DEBUG_VISIBILITY_PROTECTED,
 121   /* A private field.  */
 122   DEBUG_VISIBILITY_PRIVATE,
 123   /* A field which should be ignored.  */
 124   DEBUG_VISIBILITY_IGNORE
 125 };
 126
 127 /* A type.  */
 128
 129 typedef struct debug_type *debug_type;
 130
 131 #define DEBUG_TYPE_NULL ((debug_type) NULL)
 132
 133 /* A field in a struct or union.  */
 134
 135 typedef struct debug_field *debug_field;
 136
 137 #define DEBUG_FIELD_NULL ((debug_field) NULL)
 138
 139 /* A base class for an object.  */
 140
 141 typedef struct debug_baseclass *debug_baseclass;
 142
 143 #define DEBUG_BASECLASS_NULL ((debug_baseclass) NULL)
 144
 145 /* A method of an object.  */
 146
 147 typedef struct debug_method *debug_method;
 148
 149 #define DEBUG_METHOD_NULL ((debug_method) NULL)
 150
 151 /* The arguments to a method function of an object.  These indicate
 152    which method to run.  */
 153
 154 typedef struct debug_method_variant *debug_method_variant;
 155
 156 #define DEBUG_METHOD_VARIANT_NULL ((debug_method_variant) NULL)
 157
 158 /* This structure is passed to debug_write.  It holds function
 159    pointers that debug_write will call based on the accumulated
 160    debugging information.  */
 161
 162 struct debug_write_fns
 163 {
 164   /* This is called at the start of each new compilation unit with the
 165      name of the main file in the new unit.  */
 166   boolean (*start_compilation_unit) PARAMS ((PTR, const char *));
 167
 168   /* This is called at the start of each source file within a
 169      compilation unit, before outputting any global information for
 170      that file.  The argument is the name of the file.  */
 171   boolean (*start_source) PARAMS ((PTR, const char *));
 172
 173   /* Each writer must keep a stack of types.  */
 174
 175   /* Push an empty type onto the type stack.  This type can appear if
 176      there is a reference to a type which is never defined.  */
 177   boolean (*empty_type) PARAMS ((PTR));
 178
 179   /* Push a void type onto the type stack.  */
 180   boolean (*void_type) PARAMS ((PTR));
 181
 182   /* Push an integer type onto the type stack, given the size and
 183      whether it is unsigned.  */
 184   boolean (*int_type) PARAMS ((PTR, unsigned int, boolean));
 185
 186   /* Push a floating type onto the type stack, given the size.  */
 187   boolean (*float_type) PARAMS ((PTR, unsigned int));
 188
 189   /* Push a complex type onto the type stack, given the size.  */
 190   boolean (*complex_type) PARAMS ((PTR, unsigned int));
 191
 192   /* Push a boolean type onto the type stack, given the size.  */
 193   boolean (*bool_type) PARAMS ((PTR, unsigned int));
 194
 195   /* Push an enum type onto the type stack, given a NULL terminated
 196      array of names and the associated values.  */
 197   boolean (*enum_type) PARAMS ((PTR, const char **, bfd_signed_vma *));
 198
 199   /* Pop the top type on the type stack, and push a pointer to that
 200      type onto the type stack.  */
 201   boolean (*pointer_type) PARAMS ((PTR));
 202
 203   /* Pop the top type on the type stack, and push a function returning
 204      that type onto the type stack.  */
 205   boolean (*function_type) PARAMS ((PTR));
 206
 207   /* Pop the top type on the type stack, and push a reference to that
 208      type onto the type stack.  */
 209   boolean (*reference_type) PARAMS ((PTR));
 210
 211   /* Pop the top type on the type stack, and push a range of that type
 212      with the given lower and upper bounds onto the type stack.  */
 213   boolean (*range_type) PARAMS ((PTR, bfd_signed_vma, bfd_signed_vma));
 214
 215   /* Push an array type onto the type stack.  The top type on the type
 216      stack is the range, and the next type on the type stack is the
 217      element type.  These should be popped before the array type is
 218      pushed.  The arguments are the lower bound, the upper bound, and
 219      whether the array is a string.  */
 220   boolean (*array_type) PARAMS ((PTR, bfd_signed_vma, bfd_signed_vma,
 221                                  boolean));
 222
 223   /* Pop the top type on the type stack, and push a set of that type
 224      onto the type stack.  The argument indicates whether this set is
 225      a bitstring.  */
 226   boolean (*set_type) PARAMS ((PTR, boolean));
 227
 228   /* Push an offset type onto the type stack.  The top type on the
 229      type stack is the target type, and the next type on the type
 230      stack is the base type.  These should be popped before the offset
 231      type is pushed.  */
 232   boolean (*offset_type) PARAMS ((PTR));
 233
 234   /* Push a method type onto the type stack.  If the second argument
 235      is true, the top type on the stack is the class to which the
 236      method belongs; otherwise, the class must be determined by the
 237      class to which the method is attached.  The third argument is the
 238      number of argument types; these are pushed onto the type stack in
 239      reverse order (the first type popped is the last argument to the
 240      method).  An argument type of -1 means that no argument in
 241      formation is available.  The next type on the type stack below
 242      the domain and the argument types is the return type of the
 243      method.  All these types must be poppsed, and then the method
 244      type must be pushed.  */
 245   boolean (*method_type) PARAMS ((PTR, boolean, int));
 246
 247   /* Pop the top type off the type stack, and push a const qualified
 248      version of that type onto the type stack.  */
 249   boolean (*const_type) PARAMS ((PTR));
 250
 251   /* Pop the top type off the type stack, and push a volatile
 252      qualified version of that type onto the type stack.  */
 253   boolean (*volatile_type) PARAMS ((PTR));
 254
 255   /* Start building a struct.  This is followed by calls to the
 256      struct_field function, and finished by a call to the
 257      end_struct_type function.  The boolean argument is true for a
 258      struct, false for a union.  The unsigned int argument is the
 259      size.  */
 260   boolean (*start_struct_type) PARAMS ((PTR, boolean, unsigned int));
 261
 262   /* Add a field to the struct type currently being built.  The type
 263      of the field should be popped off the type stack.  The arguments
 264      are the name, the bit position, the bit size (may be zero if the
 265      field is not packed), and the visibility.  */
 266   boolean (*struct_field) PARAMS ((PTR, const char *, bfd_vma, bfd_vma,
 267                                    enum debug_visibility));
 268
 269   /* Finish building a struct, and push it onto the type stack.  */
 270   boolean (*end_struct_type) PARAMS ((PTR));
 271
 272   /* Start building a class.  This is followed by calls to several
 273      functions: struct_field, class_static_member, class_baseclass,
 274      class_start_method, class_method_variant,
 275      class_static_method_variant, and class_end_method.  The class is
 276      finished by a call to end_class_type.  The boolean argument is
 277      true for a struct, false for a union.  The next argument is the
 278      size.  The next argument is true if there is a virtual function
 279      table; if there is, the next argument is true if the virtual
 280      function table can be found in the type itself, and is false if
 281      the type of the object holding the virtual function table should
 282      be popped from the type stack.  */
 283   boolean (*start_class_type) PARAMS ((PTR, boolean, unsigned int,
 284                                        boolean, boolean));
 285
 286   /* Add a static member to the class currently being built.  The
 287      arguments are the field name, the physical name, and the
 288      visibility.  */
 289   boolean (*class_static_member) PARAMS ((PTR, const char *, const char *,
 290                                           enum debug_visibility));
 291
 292   /* Add a baseclass to the class currently being built.  The type of
 293      the baseclass must be popped off the type stack.  The arguments
 294      are the bit position, whether the class is virtual, and the
 295      visibility.  */
 296   boolean (*class_baseclass) PARAMS ((PTR, bfd_vma, boolean,
 297                                       enum debug_visibility));
 298
 299   /* Start adding a method to the class currently being built.  This
 300      is followed by calls to class_method_variant and
 301      class_static_method_variant to describe different variants of the
 302      method which take different arguments.  The method is finished
 303      with a call to class_end_method.  The argument is the method
 304      name.  */
 305   boolean (*class_start_method) PARAMS ((PTR, const char *));
 306
 307   /* Describe a variant to the class method currently being built.
 308      The type of the variant must be popped off the type stack.  The
 309      second argument is a string which is either the physical name of
 310      the function or describes the argument types; see the comment for
 311      debug_make_method variant.  The following arguments are the
 312      visibility, whether the variant is const, whether the variant is
 313      volatile, the offset in the virtual function table, and whether
 314      the context is on the type stack (below the variant type).  */
 315   boolean (*class_method_variant) PARAMS ((PTR, const char *,
 316                                            enum debug_visibility,
 317                                            boolean, boolean,
 318                                            bfd_vma, boolean));
 319
 320   /* Describe a static variant to the class method currently being
 321      built.  The arguments are the same as for class_method_variant,
 322      except that the last two arguments are omitted.  */
 323   boolean (*class_static_method_variant) PARAMS ((PTR, const char *,
 324                                                   enum debug_visibility,
 325                                                   boolean, boolean));
 326
 327   /* Finish describing a class method.  */
 328   boolean (*class_end_method) PARAMS ((PTR));
 329
 330   /* Finish describing a class, and push it onto the type stack.  */
 331   boolean (*end_class_type) PARAMS ((PTR));
 332
 333   /* Push a type on the stack which was given a name by an earlier
 334      call to typdef.  */
 335   boolean (*typedef_type) PARAMS ((PTR, const char *));
 336
 337   /* Push a type on the stack which was given a name by an earlier
 338      call to tag.  */
 339   boolean (*tag_type) PARAMS ((PTR, const char *, enum debug_type_kind));
 340
 341   /* Pop the type stack, and typedef it to the given name.  */
 342   boolean (*typdef) PARAMS ((PTR, const char *));
 343
 344   /* Pop the type stack, and declare it as a tagged struct or union or
 345      enum or whatever.  */
 346   boolean (*tag) PARAMS ((PTR, const char *));
 347
 348   /* This is called to record a named integer constant.  */
 349   boolean (*int_constant) PARAMS ((PTR, const char *, bfd_vma));
 350
 351   /* This is called to record a named floating point constant.  */
 352   boolean (*float_constant) PARAMS ((PTR, const char *, double));
 353
 354   /* This is called to record a typed integer constant.  The type is
 355      popped off the type stack.  */
 356   boolean (*typed_constant) PARAMS ((PTR, const char *, bfd_vma));
 357
 358   /* This is called to record a variable.  The type is popped off the
 359      type stack.  */
 360   boolean (*variable) PARAMS ((PTR, const char *, enum debug_var_kind,
 361                                bfd_vma));
 362
 363   /* Start writing out a function.  The return type must be popped off
 364      the stack.  The boolean is true if the function is global.  This
 365      is followed by calls to function_parameter, followed by block
 366      information.  */
 367   boolean (*start_function) PARAMS ((PTR, const char *, boolean));
 368
 369   /* Record a function parameter for the current function.  The type
 370      must be popped off the stack.  */
 371   boolean (*function_parameter) PARAMS ((PTR, const char *,
 372                                          enum debug_parm_kind, bfd_vma));
 373
 374   /* Start writing out a block.  There is at least one top level block
 375      per function.  Blocks may be nested.  The argument is the
 376      starting address of the block.  */
 377   boolean (*start_block) PARAMS ((PTR, bfd_vma));
 378
 379   /* Record line number information for the current block.  */
 380   boolean (*lineno) PARAMS ((PTR, const char *, unsigned long, bfd_vma));
 381
 382   /* Finish writing out a block.  The argument is the ending address
 383      of the block.  */
 384   boolean (*end_block) PARAMS ((PTR, bfd_vma));
 385
 386   /* Finish writing out a function.  */
 387   boolean (*end_function) PARAMS ((PTR));
 388 };
 389
 390 /* Exported functions.  */
 391
 392 /* The first argument to most of these functions is a handle.  This
 393    handle is returned by the debug_init function.  The purpose of the
 394    handle is to permit the debugging routines to not use static
 395    variables, and hence to be reentrant.  This would be useful for a
 396    program which wanted to handle two executables simultaneously.  */
 397
 398 /* Return a debugging handle.  */
 399
 400 extern PTR debug_init PARAMS ((void));
 401
 402 /* Set the source filename.  This implicitly starts a new compilation
 403    unit.  */
 404
 405 extern boolean debug_set_filename PARAMS ((PTR, const char *));
 406
 407 /* Append a string to the source filename.  */
 408
 409 extern boolean debug_append_filename PARAMS ((PTR, const char *));
 410
 411 /* Change source files to the given file name.  This is used for
 412    include files in a single compilation unit.  */
 413
 414 extern boolean debug_start_source PARAMS ((PTR, const char *));
 415
 416 /* Record a function definition.  This implicitly starts a function
 417    block.  The debug_type argument is the type of the return value.
 418    The boolean indicates whether the function is globally visible.
 419    The bfd_vma is the address of the start of the function.  Currently
 420    the parameter types are specified by calls to
 421    debug_record_parameter.  */
 422
 423 extern boolean debug_record_function
 424   PARAMS ((PTR, const char *, debug_type, boolean, bfd_vma));
 425
 426 /* Record a parameter for the current function.  */
 427
 428 extern boolean debug_record_parameter
 429   PARAMS ((PTR, const char *, debug_type, enum debug_parm_kind, bfd_vma));
 430
 431 /* End a function definition.  The argument is the address where the
 432    function ends.  */
 433
 434 extern boolean debug_end_function PARAMS ((PTR, bfd_vma));
 435
 436 /* Start a block in a function.  All local information will be
 437    recorded in this block, until the matching call to debug_end_block.
 438    debug_start_block and debug_end_block may be nested.  The argument
 439    is the address at which this block starts.  */
 440
 441 extern boolean debug_start_block PARAMS ((PTR, bfd_vma));
 442
 443 /* Finish a block in a function.  This matches the call to
 444    debug_start_block.  The argument is the address at which this block
 445    ends.  */
 446
 447 extern boolean debug_end_block PARAMS ((PTR, bfd_vma));
 448
 449 /* Associate a line number in the current source file and function
 450    with a given address.  */
 451
 452 extern boolean debug_record_line PARAMS ((PTR, unsigned long, bfd_vma));
 453
 454 /* Start a named common block.  This is a block of variables that may
 455    move in memory.  */
 456
 457 extern boolean debug_start_common_block PARAMS ((PTR, const char *));
 458
 459 /* End a named common block.  */
 460
 461 extern boolean debug_end_common_block PARAMS ((PTR, const char *));
 462
 463 /* Record a named integer constant.  */
 464
 465 extern boolean debug_record_int_const PARAMS ((PTR, const char *, bfd_vma));
 466
 467 /* Record a named floating point constant.  */
 468
 469 extern boolean debug_record_float_const PARAMS ((PTR, const char *, double));
 470
 471 /* Record a typed constant with an integral value.  */
 472
 473 extern boolean debug_record_typed_const
 474   PARAMS ((PTR, const char *, debug_type, bfd_vma));
 475
 476 /* Record a label.  */
 477
 478 extern boolean debug_record_label
 479   PARAMS ((PTR, const char *, debug_type, bfd_vma));
 480
 481 /* Record a variable.  */
 482
 483 extern boolean debug_record_variable
 484   PARAMS ((PTR, const char *, debug_type, enum debug_var_kind, bfd_vma));
 485
 486 /* Make an indirect type.  The first argument is a pointer to the
 487    location where the real type will be placed.  The second argument
 488    is the type tag, if there is one; this may be NULL; the only
 489    purpose of this argument is so that debug_get_type_name can return
 490    something useful.  This function may be used when a type is
 491    referenced before it is defined.  */
 492
 493 extern debug_type debug_make_indirect_type
 494   PARAMS ((PTR, debug_type *, const char *));
 495
 496 /* Make a void type.  */
 497
 498 extern debug_type debug_make_void_type PARAMS ((PTR));
 499
 500 /* Make an integer type of a given size.  The boolean argument is true
 501    if the integer is unsigned.  */
 502
 503 extern debug_type debug_make_int_type PARAMS ((PTR, unsigned int, boolean));
 504
 505 /* Make a floating point type of a given size.  FIXME: On some
 506    platforms, like an Alpha, you probably need to be able to specify
 507    the format.  */
 508
 509 extern debug_type debug_make_float_type PARAMS ((PTR, unsigned int));
 510
 511 /* Make a boolean type of a given size.  */
 512
 513 extern debug_type debug_make_bool_type PARAMS ((PTR, unsigned int));
 514
 515 /* Make a complex type of a given size.  */
 516
 517 extern debug_type debug_make_complex_type PARAMS ((PTR, unsigned int));
 518
 519 /* Make a structure type.  The second argument is true for a struct,
 520    false for a union.  The third argument is the size of the struct.
 521    The fourth argument is a NULL terminated array of fields.  */
 522
 523 extern debug_type debug_make_struct_type
 524   PARAMS ((PTR, boolean, bfd_vma, debug_field *));
 525
 526 /* Make an object type.  The first three arguments after the handle
 527    are the same as for debug_make_struct_type.  The next arguments are
 528    a NULL terminated array of base classes, a NULL terminated array of
 529    methods, the type of the object holding the virtual function table
 530    if it is not this object, and a boolean which is true if this
 531    object has its own virtual function table.  */
 532
 533 extern debug_type debug_make_object_type
 534   PARAMS ((PTR, boolean, bfd_vma, debug_field *, debug_baseclass *,
 535            debug_method *, debug_type, boolean));
 536
 537 /* Make an enumeration type.  The arguments are a null terminated
 538    array of strings, and an array of corresponding values.  */
 539
 540 extern debug_type debug_make_enum_type
 541   PARAMS ((PTR, const char **, bfd_signed_vma *));
 542
 543 /* Make a pointer to a given type.  */
 544
 545 extern debug_type debug_make_pointer_type
 546   PARAMS ((PTR, debug_type));
 547
 548 /* Make a function returning a given type.  FIXME: We should be able
 549    to record the parameter types.  */
 550
 551 extern debug_type debug_make_function_type PARAMS ((PTR, debug_type));
 552
 553 /* Make a reference to a given type.  */
 554
 555 extern debug_type debug_make_reference_type PARAMS ((PTR, debug_type));
 556
 557 /* Make a range of a given type from a lower to an upper bound.  */
 558
 559 extern debug_type debug_make_range_type
 560   PARAMS ((PTR, debug_type, bfd_signed_vma, bfd_signed_vma));
 561
 562 /* Make an array type.  The second argument is the type of an element
 563    of the array.  The third argument is the type of a range of the
 564    array.  The fourth and fifth argument are the lower and upper
 565    bounds, respectively (if the bounds are not known, lower should be
 566    0 and upper should be -1).  The sixth argument is true if this
 567    array is actually a string, as in C.  */
 568
 569 extern debug_type debug_make_array_type
 570   PARAMS ((PTR, debug_type, debug_type, bfd_signed_vma, bfd_signed_vma,
 571            boolean));
 572
 573 /* Make a set of a given type.  For example, a Pascal set type.  The
 574    boolean argument is true if this set is actually a bitstring, as in
 575    CHILL.  */
 576
 577 extern debug_type debug_make_set_type PARAMS ((PTR, debug_type, boolean));
 578
 579 /* Make a type for a pointer which is relative to an object.  The
 580    second argument is the type of the object to which the pointer is
 581    relative.  The third argument is the type that the pointer points
 582    to.  */
 583
 584 extern debug_type debug_make_offset_type
 585   PARAMS ((PTR, debug_type, debug_type));
 586
 587 /* Make a type for a method function.  The second argument is the
 588    return type, the third argument is the domain, and the fourth
 589    argument is a NULL terminated array of argument types.  The domain
 590    and the argument array may be NULL, in which case this is a stub
 591    method and that information is not available.  Stabs debugging uses
 592    this, and gets the argument types from the mangled name.  */
 593
 594 extern debug_type debug_make_method_type
 595   PARAMS ((PTR, debug_type, debug_type, debug_type *));
 596
 597 /* Make a const qualified version of a given type.  */
 598
 599 extern debug_type debug_make_const_type PARAMS ((PTR, debug_type));
 600
 601 /* Make a volatile qualified version of a given type.  */
 602
 603 extern debug_type debug_make_volatile_type PARAMS ((PTR, debug_type));
 604
 605 /* Make an undefined tagged type.  For example, a struct which has
 606    been mentioned, but not defined.  */
 607
 608 extern debug_type debug_make_undefined_tagged_type
 609   PARAMS ((PTR, const char *, enum debug_type_kind));
 610
 611 /* Make a base class for an object.  The second argument is the base
 612    class type.  The third argument is the bit position of this base
 613    class in the object (always 0 unless doing multiple inheritance).
 614    The fourth argument is whether this is a virtual class.  The fifth
 615    argument is the visibility of the base class.  */
 616
 617 extern debug_baseclass debug_make_baseclass
 618   PARAMS ((PTR, debug_type, bfd_vma, boolean, enum debug_visibility));
 619
 620 /* Make a field for a struct.  The second argument is the name.  The
 621    third argument is the type of the field.  The fourth argument is
 622    the bit position of the field.  The fifth argument is the size of
 623    the field (it may be zero).  The sixth argument is the visibility
 624    of the field.  */
 625
 626 extern debug_field debug_make_field
 627   PARAMS ((PTR, const char *, debug_type, bfd_vma, bfd_vma,
 628            enum debug_visibility));
 629
 630 /* Make a static member of an object.  The second argument is the
 631    name.  The third argument is the type of the member.  The fourth
 632    argument is the physical name of the member (i.e., the name as a
 633    global variable).  The fifth argument is the visibility of the
 634    member.  */
 635
 636 extern debug_field debug_make_static_member
 637   PARAMS ((PTR, const char *, debug_type, const char *,
 638            enum debug_visibility));
 639
 640 /* Make a method.  The second argument is the name, and the third
 641    argument is a NULL terminated array of method variants.  Each
 642    method variant is a method with this name but with different
 643    argument types.  */
 644
 645 extern debug_method debug_make_method
 646   PARAMS ((PTR, const char *, debug_method_variant *));
 647
 648 /* Make a method variant.  The second argument is either the physical
 649    name of the function, or the encoded argument types, depending upon
 650    whether the third argument specifies the argument types or not.
 651    The third argument is the type of the function.  The fourth
 652    argument is the visibility.  The fifth argument is whether this is
 653    a const function.  The sixth argument is whether this is a volatile
 654    function.  The seventh argument is the offset in the virtual
 655    function table, if any.  The eighth argument is the virtual
 656    function context.  FIXME: Are the const and volatile arguments
 657    necessary?  Could we just use debug_make_const_type?  The handling
 658    of the second argument is biased toward the way that stabs works.  */
 659
 660 extern debug_method_variant debug_make_method_variant
 661   PARAMS ((PTR, const char *, debug_type, enum debug_visibility, boolean,
 662            boolean, bfd_vma, debug_type));
 663
 664 /* Make a static method argument.  The arguments are the same as for
 665    debug_make_method_variant, except that the last two are omitted
 666    since a static method can not also be virtual.  */
 667
 668 extern debug_method_variant debug_make_static_method_variant
 669   PARAMS ((PTR, const char *, debug_type, enum debug_visibility, boolean,
 670            boolean));
 671
 672 /* Name a type.  This returns a new type with an attached name.  */
 673
 674 extern debug_type debug_name_type PARAMS ((PTR, const char *, debug_type));
 675
 676 /* Give a tag to a type, such as a struct or union.  This returns a
 677    new type with an attached tag.  */
 678
 679 extern debug_type debug_tag_type PARAMS ((PTR, const char *, debug_type));
 680
 681 /* Record the size of a given type.  */
 682
 683 extern boolean debug_record_type_size PARAMS ((PTR, debug_type, unsigned int));
 684
 685 /* Find a tagged type.  */
 686
 687 extern debug_type debug_find_tagged_type
 688   PARAMS ((PTR, const char *, enum debug_type_kind));
 689
 690 /* Get the name of a type.  */
 691
 692 extern const char *debug_get_type_name PARAMS ((PTR, debug_type));
 693
 694 /* Write out the recorded debugging information.  This takes a set of
 695    function pointers which are called to do the actual writing.  The
 696    first PTR is the debugging handle.  The second PTR is a handle
 697    which is passed to the functions.  */
 698
 699 extern boolean debug_write PARAMS ((PTR, const struct debug_write_fns *, PTR));
 700
 701 #endif /* DEBUG_H */