nsz Git - libfirm/blob - ir/be/bedwarf.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief   Dwarf debug output support.
  23  * @author  Matthias Braun
  24  */
  25 #ifndef FIRM_BE_BEDWARF_H
  26 #define FIRM_BE_BEDWARF_H
  27
  28 #include "beabi.h"
  29
  30 typedef struct parameter_dbg_info_t {
  31         const ir_entity       *entity;
  32         const arch_register_t *reg;
  33 } parameter_dbg_info_t;
  34
  35 /** initialize and open debug handle */
  36 void be_dwarf_open(void);
  37
  38 /** close a debug handler. */
  39 void be_dwarf_close(void);
  40
  41 /** start a compilation unit */
  42 void be_dwarf_unit_begin(const char *filename);
  43
  44 /** end compilation unit */
  45 void be_dwarf_unit_end(void);
  46
  47 /** output debug info necessary right before defining a method */
  48 void be_dwarf_method_before(const ir_entity *ent,
  49                             const parameter_dbg_info_t *infos);
  50
  51 /** output debug info right before beginning to output assembly instructions */
  52 void be_dwarf_method_begin(void);
  53
  54 /** debug for a method end */
  55 void be_dwarf_method_end(void);
  56
  57 /** dump a variable in the global type */
  58 void be_dwarf_variable(const ir_entity *ent);
  59
  60 /** Set "location" in the sourcefile corresponding to the following
  61  * assembly instructions */
  62 void be_dwarf_location(dbg_info *dbgi);
  63
  64 /** set base register that points to callframe */
  65 void be_dwarf_callframe_register(const arch_register_t *reg);
  66
  67 /** set offset from base register that points to the callframe.
  68  * Note: callframe is defined as in the dwarf documentation here which is the
  69  * stackpointer before the call has happened. (Which would be the beginning of
  70  * the between type in our backend) */
  71 void be_dwarf_callframe_offset(int offset);
  72
  73 /**
  74  * Indicate at which offset (relative to the CFA) a caller saved register has
  75  * been saved.
  76  */
  77 void be_dwarf_callframe_spilloffset(const arch_register_t *reg, int offset);
  78
  79 #endif