output/outdbg.c

   1 /* ----------------------------------------------------------------------- *
   2  *
   3  *   Copyright 1996-2017 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
  46 #include "nasm.h"
  47 #include "nasmlib.h"
  48 #include "outform.h"
  49 #include "outlib.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 const 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(void)
  67 {
  68     dfmt->cleanup();
  69     while (dbgsect) {
  70         struct Section *tmp = dbgsect;
  71         dbgsect = dbgsect->next;
  72         nasm_free(tmp->name);
  73         nasm_free(tmp);
  74     }
  75 }
  76
  77 static int32_t dbg_section_names(char *name, int pass, int *bits)
  78 {
  79     int seg;
  80
  81     /*
  82      * We must have an initial default: let's make it 16.
  83      */
  84     if (!name)
  85         *bits = 16;
  86
  87     if (!name)
  88         fprintf(ofile, "section_name on init: returning %d\n",
  89                 seg = seg_alloc());
  90     else {
  91         int n = strcspn(name, " \t");
  92         char *sname = nasm_strndup(name, n);
  93         struct Section *s;
  94
  95         seg = NO_SEG;
  96         for (s = dbgsect; s; s = s->next)
  97             if (!strcmp(s->name, sname))
  98                 seg = s->number;
  99
 100         if (seg == NO_SEG) {
 101             s = nasm_malloc(sizeof(*s));
 102             s->name = sname;
 103             s->number = seg = seg_alloc();
 104             s->next = dbgsect;
 105             dbgsect = s;
 106             fprintf(ofile, "section_name %s (pass %d): returning %d\n",
 107                     name, pass, seg);
 108         }
 109     }
 110     return seg;
 111 }
 112
 113 static void dbg_deflabel(char *name, int32_t segment, int64_t offset,
 114                          int is_global, char *special)
 115 {
 116     fprintf(ofile, "deflabel %s := %08"PRIx32":%016"PRIx64" %s (%d)%s%s\n",
 117             name, segment, offset,
 118             is_global == 2 ? "common" : is_global ? "global" : "local",
 119             is_global, special ? ": " : "", special);
 120 }
 121
 122 static void dbg_out(int32_t segto, const void *data,
 123                     enum out_type type, uint64_t size,
 124                     int32_t segment, int32_t wrt)
 125 {
 126     int32_t ldata;
 127     int id;
 128
 129     if (type == OUT_ADDRESS)
 130         fprintf(ofile, "out to %"PRIx32", len = %d: ", segto, (int)abs((int)size));
 131     else
 132         fprintf(ofile, "out to %"PRIx32", len = %"PRIu64": ", segto, size);
 133
 134     switch (type) {
 135     case OUT_RESERVE:
 136         fprintf(ofile, "reserved.\n");
 137         break;
 138     case OUT_RAWDATA:
 139         fprintf(ofile, "raw data = ");
 140         while (size--) {
 141             id = *(uint8_t *)data;
 142             data = (char *)data + 1;
 143             fprintf(ofile, "%02x ", id);
 144         }
 145         fprintf(ofile, "\n");
 146         break;
 147     case OUT_ADDRESS:
 148         ldata = *(int64_t *)data;
 149         fprintf(ofile, "addr %08"PRIx32" (seg %08"PRIx32", wrt %08"PRIx32")\n",
 150                 ldata, segment, wrt);
 151         break;
 152     case OUT_REL1ADR:
 153         fprintf(ofile, "rel1adr %02"PRIx8" (seg %08"PRIx32")\n",
 154                 (uint8_t)*(int64_t *)data, segment);
 155         break;
 156     case OUT_REL2ADR:
 157         fprintf(ofile, "rel2adr %04"PRIx16" (seg %08"PRIx32")\n",
 158                 (uint16_t)*(int64_t *)data, segment);
 159         break;
 160     case OUT_REL4ADR:
 161         fprintf(ofile, "rel4adr %08"PRIx32" (seg %08"PRIx32")\n",
 162                 (uint32_t)*(int64_t *)data,
 163                 segment);
 164         break;
 165     case OUT_REL8ADR:
 166         fprintf(ofile, "rel8adr %016"PRIx64" (seg %08"PRIx32")\n",
 167                 (uint64_t)*(int64_t *)data, segment);
 168         break;
 169     default:
 170         fprintf(ofile, "unknown\n");
 171         break;
 172     }
 173 }
 174
 175 static void dbg_sectalign(int32_t seg, unsigned int value)
 176 {
 177     fprintf(ofile, "set alignment (%d) for segment (%u)\n",
 178             seg, value);
 179 }
 180
 181 static int32_t dbg_segbase(int32_t segment)
 182 {
 183     return segment;
 184 }
 185
 186 static enum directive_result
 187 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 DIRR_OK;
 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 static const char * const 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 const 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     NULL                        /* pragma list */
 256 };
 257
 258 static const struct dfmt * const debug_debug_arr[3] = {
 259     &debug_debug_form,
 260     &null_debug_form,
 261     NULL
 262 };
 263
 264 const struct ofmt of_dbg = {
 265     "Trace of all info passed to output stage",
 266     "dbg",
 267     OFMT_TEXT,
 268     64,
 269     debug_debug_arr,
 270     &debug_debug_form,
 271     NULL,
 272     dbg_init,
 273     dbg_set_info,
 274     nasm_do_legacy_output,
 275     dbg_out,
 276     dbg_deflabel,
 277     dbg_section_names,
 278     dbg_sectalign,
 279     dbg_segbase,
 280     dbg_directive,
 281     dbg_filename,
 282     dbg_cleanup,
 283     NULL                        /* pragma list */
 284 };
 285
 286 #endif                          /* OF_DBG */