output/outdbg.c

   1 /* ----------------------------------------------------------------------- *
   2  *
   3  *   Copyright 1996-2013 The NASM Authors - All Rights Reserved
   4  *   See the file AUTHORS included with the NASM distribution for
   5  *   the specific copyright holders.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following
   9  *   conditions are met:
  10  *
  11  *   * Redistributions of source code must retain the above copyright
  12  *     notice, this list of conditions and the following disclaimer.
  13  *   * Redistributions in binary form must reproduce the above
  14  *     copyright notice, this list of conditions and the following
  15  *     disclaimer in the documentation and/or other materials provided
  16  *     with the distribution.
  17  *
  18  *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  19  *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  20  *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  21  *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22  *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  23  *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25  *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26  *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * ----------------------------------------------------------------------- */
  33
  34 /*
  35  * outdbg.c     output routines for the Netwide Assembler to produce
  36  *              a debugging trace
  37  */
  38
  39 #include "compiler.h"
  40
  41 #include <stdio.h>
  42 #include <stdlib.h>
  43 #include <string.h>
  44 #include <ctype.h>
  45 #include <inttypes.h>
  46
  47 #include "nasm.h"
  48 #include "nasmlib.h"
  49 #include "output/outform.h"
  50
  51 #ifdef OF_DBG
  52
  53 struct Section {
  54     struct Section *next;
  55     int32_t number;
  56     char *name;
  57 } *dbgsect;
  58
  59 struct ofmt of_dbg;
  60 static void dbg_init(void)
  61 {
  62     dbgsect = NULL;
  63     fprintf(ofile, "NASM Output format debug dump\n");
  64 }
  65
  66 static void dbg_cleanup(int debuginfo)
  67 {
  68     (void)debuginfo;
  69     of_dbg.current_dfmt->cleanup();
  70     while (dbgsect) {
  71         struct Section *tmp = dbgsect;
  72         dbgsect = dbgsect->next;
  73         nasm_free(tmp->name);
  74         nasm_free(tmp);
  75     }
  76 }
  77
  78 static int32_t dbg_section_names(char *name, int pass, int *bits)
  79 {
  80     int seg;
  81
  82     /*
  83      * We must have an initial default: let's make it 16.
  84      */
  85     if (!name)
  86         *bits = 16;
  87
  88     if (!name)
  89         fprintf(ofile, "section_name on init: returning %d\n",
  90                 seg = seg_alloc());
  91     else {
  92         int n = strcspn(name, " \t");
  93         char *sname = nasm_strndup(name, n);
  94         struct Section *s;
  95
  96         seg = NO_SEG;
  97         for (s = dbgsect; s; s = s->next)
  98             if (!strcmp(s->name, sname))
  99                 seg = s->number;
 100
 101         if (seg == NO_SEG) {
 102             s = nasm_malloc(sizeof(*s));
 103             s->name = sname;
 104             s->number = seg = seg_alloc();
 105             s->next = dbgsect;
 106             dbgsect = s;
 107             fprintf(ofile, "section_name %s (pass %d): returning %d\n",
 108                     name, pass, seg);
 109         }
 110     }
 111     return seg;
 112 }
 113
 114 static void dbg_deflabel(char *name, int32_t segment, int64_t offset,
 115                          int is_global, char *special)
 116 {
 117     fprintf(ofile, "deflabel %s := %08"PRIx32":%016"PRIx64" %s (%d)%s%s\n",
 118             name, segment, offset,
 119             is_global == 2 ? "common" : is_global ? "global" : "local",
 120             is_global, special ? ": " : "", special);
 121 }
 122
 123 static void dbg_out(int32_t segto, const void *data,
 124                     enum out_type type, uint64_t size,
 125                     int32_t segment, int32_t wrt)
 126 {
 127     int32_t ldata;
 128     int id;
 129
 130     if (type == OUT_ADDRESS)
 131         fprintf(ofile, "out to %"PRIx32", len = %d: ", segto, (int)size);
 132     else
 133         fprintf(ofile, "out to %"PRIx32", len = %"PRIu64": ", segto, size);
 134
 135     switch (type) {
 136     case OUT_RESERVE:
 137         fprintf(ofile, "reserved.\n");
 138         break;
 139     case OUT_RAWDATA:
 140         fprintf(ofile, "raw data = ");
 141         while (size--) {
 142             id = *(uint8_t *)data;
 143             data = (char *)data + 1;
 144             fprintf(ofile, "%02x ", id);
 145         }
 146         fprintf(ofile, "\n");
 147         break;
 148     case OUT_ADDRESS:
 149         ldata = *(int64_t *)data;
 150         fprintf(ofile, "addr %08"PRIx32" (seg %08"PRIx32", wrt %08"PRIx32")\n",
 151                 ldata, segment, wrt);
 152         break;
 153     case OUT_REL1ADR:
 154         fprintf(ofile, "rel1adr %02"PRIx8" (seg %08"PRIx32")\n",
 155                 (uint8_t)*(int64_t *)data, segment);
 156         break;
 157     case OUT_REL2ADR:
 158         fprintf(ofile, "rel2adr %04"PRIx16" (seg %08"PRIx32")\n",
 159                 (uint16_t)*(int64_t *)data, segment);
 160         break;
 161     case OUT_REL4ADR:
 162         fprintf(ofile, "rel4adr %08"PRIx32" (seg %08"PRIx32")\n",
 163                 (uint32_t)*(int64_t *)data,
 164                 segment);
 165         break;
 166     case OUT_REL8ADR:
 167         fprintf(ofile, "rel8adr %016"PRIx64" (seg %08"PRIx32")\n",
 168                 (uint64_t)*(int64_t *)data, segment);
 169         break;
 170     default:
 171         fprintf(ofile, "unknown\n");
 172         break;
 173     }
 174 }
 175
 176 static void dbg_sectalign(int32_t seg, unsigned int value)
 177 {
 178     fprintf(ofile, "set alignment (%d) for segment (%u)\n",
 179             seg, value);
 180 }
 181
 182 static int32_t dbg_segbase(int32_t segment)
 183 {
 184     return segment;
 185 }
 186
 187 static int dbg_directive(enum directives directive, char *value, int pass)
 188 {
 189     fprintf(ofile, "directive [%s] value [%s] (pass %d)\n",
 190             directives[directive], value, pass);
 191     return 1;
 192 }
 193
 194 static void dbg_filename(char *inname, char *outname)
 195 {
 196     standard_extension(inname, outname, ".dbg");
 197 }
 198
 199 static int dbg_set_info(enum geninfo type, char **val)
 200 {
 201     (void)type;
 202     (void)val;
 203     return 0;
 204 }
 205
 206 char *types[] = {
 207     "unknown", "label", "byte", "word", "dword", "float", "qword", "tbyte"
 208 };
 209 static void dbgdbg_init(void)
 210 {
 211     fprintf(ofile, "   With debug info\n");
 212 }
 213 static void dbgdbg_cleanup(void)
 214 {
 215 }
 216
 217 static void dbgdbg_linnum(const char *lnfname, int32_t lineno, int32_t segto)
 218 {
 219     fprintf(ofile, "dbglinenum %s(%"PRId32") := %08"PRIx32"\n",
 220             lnfname, lineno, segto);
 221 }
 222 static void dbgdbg_deflabel(char *name, int32_t segment,
 223                             int64_t offset, int is_global, char *special)
 224 {
 225     fprintf(ofile, "dbglabel %s := %08"PRIx32":%016"PRIx64" %s (%d)%s%s\n",
 226             name,
 227             segment, offset,
 228             is_global == 2 ? "common" : is_global ? "global" : "local",
 229             is_global, special ? ": " : "", special);
 230 }
 231 static void dbgdbg_define(const char *type, const char *params)
 232 {
 233     fprintf(ofile, "dbgdirective [%s] value [%s]\n", type, params);
 234 }
 235 static void dbgdbg_output(int output_type, void *param)
 236 {
 237     (void)output_type;
 238     (void)param;
 239 }
 240 static void dbgdbg_typevalue(int32_t type)
 241 {
 242     fprintf(ofile, "new type: %s(%"PRIX32")\n",
 243             types[TYM_TYPE(type) >> 3], TYM_ELEMENTS(type));
 244 }
 245 static struct dfmt debug_debug_form = {
 246     "Trace of all info passed to debug stage",
 247     "debug",
 248     dbgdbg_init,
 249     dbgdbg_linnum,
 250     dbgdbg_deflabel,
 251     dbgdbg_define,
 252     dbgdbg_typevalue,
 253     dbgdbg_output,
 254     dbgdbg_cleanup,
 255 };
 256
 257 static struct dfmt *debug_debug_arr[3] = {
 258     &debug_debug_form,
 259     &null_debug_form,
 260     NULL
 261 };
 262
 263 struct ofmt of_dbg = {
 264     "Trace of all info passed to output stage",
 265     "dbg",
 266     OFMT_TEXT,
 267     debug_debug_arr,
 268     &debug_debug_form,
 269     NULL,
 270     dbg_init,
 271     dbg_set_info,
 272     dbg_out,
 273     dbg_deflabel,
 274     dbg_section_names,
 275     dbg_sectalign,
 276     dbg_segbase,
 277     dbg_directive,
 278     dbg_filename,
 279     dbg_cleanup
 280 };
 281
 282 #endif                          /* OF_DBG */