output/outdbg.c

   1 /* ----------------------------------------------------------------------- *
   2  *
   3  *   Copyright 1996-2009 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 FILE *dbgf;
  60 efunc dbgef;
  61
  62 struct ofmt of_dbg;
  63 static void dbg_init(FILE * fp, efunc errfunc, ldfunc ldef, evalfunc eval)
  64 {
  65     (void)eval;
  66
  67     dbgf = fp;
  68     dbgef = errfunc;
  69     dbgsect = NULL;
  70     (void)ldef;
  71     fprintf(fp, "NASM Output format debug dump\n");
  72 }
  73
  74 static void dbg_cleanup(int debuginfo)
  75 {
  76     (void)debuginfo;
  77     of_dbg.current_dfmt->cleanup();
  78     while (dbgsect) {
  79         struct Section *tmp = dbgsect;
  80         dbgsect = dbgsect->next;
  81         nasm_free(tmp->name);
  82         nasm_free(tmp);
  83     }
  84     fclose(dbgf);
  85 }
  86
  87 static int32_t dbg_section_names(char *name, int pass, int *bits)
  88 {
  89     int seg;
  90
  91     /*
  92      * We must have an initial default: let's make it 16.
  93      */
  94     if (!name)
  95         *bits = 16;
  96
  97     if (!name)
  98         fprintf(dbgf, "section_name on init: returning %d\n",
  99                 seg = seg_alloc());
 100     else {
 101         int n = strcspn(name, " \t");
 102         char *sname = nasm_strndup(name, n);
 103         struct Section *s;
 104
 105         seg = NO_SEG;
 106         for (s = dbgsect; s; s = s->next)
 107             if (!strcmp(s->name, sname))
 108                 seg = s->number;
 109
 110         if (seg == NO_SEG) {
 111             s = nasm_malloc(sizeof(*s));
 112             s->name = sname;
 113             s->number = seg = seg_alloc();
 114             s->next = dbgsect;
 115             dbgsect = s;
 116             fprintf(dbgf, "section_name %s (pass %d): returning %d\n",
 117                     name, pass, seg);
 118         }
 119     }
 120     return seg;
 121 }
 122
 123 static void dbg_deflabel(char *name, int32_t segment, int64_t offset,
 124                          int is_global, char *special)
 125 {
 126     fprintf(dbgf, "deflabel %s := %08"PRIx32":%016"PRIx64" %s (%d)%s%s\n",
 127             name, segment, offset,
 128             is_global == 2 ? "common" : is_global ? "global" : "local",
 129             is_global, special ? ": " : "", special);
 130 }
 131
 132 static void dbg_out(int32_t segto, const void *data,
 133                     enum out_type type, uint64_t size,
 134                     int32_t segment, int32_t wrt)
 135 {
 136     int32_t ldata;
 137     int id;
 138
 139     fprintf(dbgf, "out to %"PRIx32", len = %"PRIu64": ", segto, size);
 140
 141     switch (type) {
 142     case OUT_RESERVE:
 143         fprintf(dbgf, "reserved.\n");
 144         break;
 145     case OUT_RAWDATA:
 146         fprintf(dbgf, "raw data = ");
 147         while (size--) {
 148             id = *(uint8_t *)data;
 149             data = (char *)data + 1;
 150             fprintf(dbgf, "%02x ", id);
 151         }
 152         fprintf(dbgf, "\n");
 153         break;
 154     case OUT_ADDRESS:
 155         ldata = *(int64_t *)data;
 156         fprintf(dbgf, "addr %08"PRIx32" (seg %08"PRIx32", wrt %08"PRIx32")\n", ldata,
 157                 segment, wrt);
 158         break;
 159     case OUT_REL2ADR:
 160         fprintf(dbgf, "rel2adr %04"PRIx16" (seg %08"PRIx32")\n",
 161                 (uint16_t)*(int64_t *)data, segment);
 162         break;
 163     case OUT_REL4ADR:
 164         fprintf(dbgf, "rel4adr %08"PRIx32" (seg %08"PRIx32")\n",
 165                 (uint32_t)*(int64_t *)data,
 166                 segment);
 167         break;
 168     case OUT_REL8ADR:
 169         fprintf(dbgf, "rel8adr %016"PRIx64" (seg %08"PRIx32")\n",
 170                 (uint64_t)*(int64_t *)data, segment);
 171         break;
 172     default:
 173         fprintf(dbgf, "unknown\n");
 174         break;
 175     }
 176 }
 177
 178 static int32_t dbg_segbase(int32_t segment)
 179 {
 180     return segment;
 181 }
 182
 183 static int dbg_directive(char *directive, char *value, int pass)
 184 {
 185     fprintf(dbgf, "directive [%s] value [%s] (pass %d)\n",
 186             directive, value, pass);
 187     return 1;
 188 }
 189
 190 static void dbg_filename(char *inname, char *outname, efunc error)
 191 {
 192     standard_extension(inname, outname, ".dbg", error);
 193 }
 194
 195 static int dbg_set_info(enum geninfo type, char **val)
 196 {
 197     (void)type;
 198     (void)val;
 199     return 0;
 200 }
 201
 202 char *types[] = {
 203     "unknown", "label", "byte", "word", "dword", "float", "qword", "tbyte"
 204 };
 205 void dbgdbg_init(struct ofmt *of, void *id, FILE * fp, efunc error)
 206 {
 207     (void)of;
 208     (void)id;
 209     (void)fp;
 210     (void)error;
 211     fprintf(fp, "   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(dbgf, "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(dbgf, "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(dbgf, "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(dbgf, "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_segbase,
 276     dbg_directive,
 277     dbg_filename,
 278     dbg_cleanup
 279 };
 280
 281 #endif                          /* OF_DBG */