Quelle  aicasm.c   Sprache: C

/*
 * Aic7xxx SCSI host adapter firmware assembler
 *
 * Copyright (c) 1997, 1998, 2000, 2001 Justin T. Gibbs.
 * Copyright (c) 2001, 2002 Adaptec Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 *
 * $Id: //depot/aic7xxx/aic7xxx/aicasm/aicasm.c#23 $
 *
 * $FreeBSD$
 */
#include <sys/types.h>
#include <sys/mman.h>

#include <ctype.h>
#include <inttypes.h>
#include <regex.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sysexits.h>
#include <unistd.h>

#if linux
#include <endian.h>
#else
#include <machine/endian.h>
#endif

#include "aicasm.h"
#include "aicasm_symbol.h"
#include "aicasm_insformat.h"

typedef struct patch {
 STAILQ_ENTRY(patch) links;
 int  patch_func;
 u_int  begin;
 u_int  skip_instr;
 u_int  skip_patch;
} patch_t;

STAILQ_HEAD(patch_list, patch) patches;

static void usage(void);
static void back_patch(void);
static void output_code(void);
static void output_listing(char *ifilename);
static void dump_scope(scope_t *scope);
static void emit_patch(scope_t *scope, int patch);
static int check_patch(patch_t **start_patch, int start_instr,
         int *skip_addr, int *func_vals);

struct path_list search_path;
int includes_search_curdir;
char *appname;
char *stock_include_file;
FILE *ofile;
char *ofilename;
char *regfilename;
FILE *regfile;
char *listfilename;
FILE *listfile;
char *regdiagfilename;
FILE *regdiagfile;
int   src_mode;
int   dst_mode;

static STAILQ_HEAD(,instruction) seq_program;
struct cs_tailq cs_tailq;
struct scope_list scope_stack;
symlist_t patch_functions;

#if DEBUG
extern int yy_flex_debug;
extern int mm_flex_debug;
extern int yydebug;
extern int mmdebug;
#endif
extern FILE *yyin;
extern int yyparse(void);

int main(int argc, char *argv[]);

int
main(int argc, char *argv[])
{
 extern char *optarg;
 extern int optind;
 int  ch;
 int  retval;
 char *inputfilename;
 scope_t *sentinal;

 STAILQ_INIT(&patches);
 SLIST_INIT(&search_path);
 STAILQ_INIT(&seq_program);
 TAILQ_INIT(&cs_tailq);
 SLIST_INIT(&scope_stack);

 /* Set Sentinal scope node */
 sentinal = scope_alloc();
 sentinal->type = SCOPE_ROOT;
 
 includes_search_curdir = 1;
 appname = *argv;
 regfile = NULL;
 listfile = NULL;
#if DEBUG
 yy_flex_debug = 0;
 mm_flex_debug = 0;
 yydebug = 0;
 mmdebug = 0;
#endif
 while ((ch = getopt(argc, argv, "d:i:l:n:o:p:r:I:")) != -1) {
  switch(ch) {
  case 'd':
#if DEBUG
   if (strcmp(optarg, "s") == 0) {
    yy_flex_debug = 1;
    mm_flex_debug = 1;
   } else if (strcmp(optarg, "p") == 0) {
    yydebug = 1;
    mmdebug = 1;
   } else {
    fprintf(stderr, "%s: -d Requires either an "
     "'s' or 'p' argument\n", appname);
    usage();
   }
#else
   stop("-d: Assembler not built with debugging "
        "information", EX_SOFTWARE);
#endif
   break;
  case 'i':
   stock_include_file = optarg;
   break;
  case 'l':
   /* Create a program listing */
   if ((listfile = fopen(optarg, "w")) == NULL) {
    perror(optarg);
    stop(NULL, EX_CANTCREAT);
   }
   listfilename = optarg;
   break;
  case 'n':
   /* Don't complain about the -nostdinc directrive */
   if (strcmp(optarg, "ostdinc")) {
    fprintf(stderr, "%s: Unknown option -%c%s\n",
     appname, ch, optarg);
    usage();
    /* NOTREACHED */
   }
   break;
  case 'o':
   if ((ofile = fopen(optarg, "w")) == NULL) {
    perror(optarg);
    stop(NULL, EX_CANTCREAT);
   }
   ofilename = optarg;
   break;
  case 'p':
   /* Create Register Diagnostic "printing" Functions */
   if ((regdiagfile = fopen(optarg, "w")) == NULL) {
    perror(optarg);
    stop(NULL, EX_CANTCREAT);
   }
   regdiagfilename = optarg;
   break;
  case 'r':
   if ((regfile = fopen(optarg, "w")) == NULL) {
    perror(optarg);
    stop(NULL, EX_CANTCREAT);
   }
   regfilename = optarg;
   break;
  case 'I':
  {
   path_entry_t include_dir;

   if (strcmp(optarg, "-") == 0) {
    if (includes_search_curdir == 0) {
     fprintf(stderr, "%s: Warning - '-I-' "
       "specified multiple "
       "times\n", appname);
    }
    includes_search_curdir = 0;
    for (include_dir = SLIST_FIRST(&search_path);
         include_dir != NULL;
         include_dir = SLIST_NEXT(include_dir,
             links))
     /*
 * All entries before a '-I-' only
 * apply to includes specified with
 * quotes instead of "<>".
 */
     include_dir->quoted_includes_only = 1;
   } else {
    include_dir =
        (path_entry_t)malloc(sizeof(*include_dir));
    if (include_dir == NULL) {
     perror(optarg);
     stop(NULL, EX_OSERR);
    }
    include_dir->directory = strdup(optarg);
    if (include_dir->directory == NULL) {
     perror(optarg);
     stop(NULL, EX_OSERR);
    }
    include_dir->quoted_includes_only = 0;
    SLIST_INSERT_HEAD(&search_path, include_dir,
        links);
   }
   break;
  }
  case '?':
  default:
   usage();
   /* NOTREACHED */
  }
 }
 argc -= optind;
 argv += optind;

 if (argc != 1) {
  fprintf(stderr, "%s: No input file specified\n", appname);
  usage();
  /* NOTREACHED */
 }

 if (regdiagfile != NULL
  && (regfile == NULL || stock_include_file == NULL)) {
  fprintf(stderr,
   "%s: The -p option requires the -r and -i options.\n",
   appname);
  usage();
  /* NOTREACHED */
 }
 symtable_open();
 inputfilename = *argv;
 include_file(*argv, SOURCE_FILE);
 retval = yyparse();
 if (retval == 0) {
  if (SLIST_FIRST(&scope_stack) == NULL
   || SLIST_FIRST(&scope_stack)->type != SCOPE_ROOT) {
   stop("Unterminated conditional expression", EX_DATAERR);
   /* NOTREACHED */
  }

  /* Process outmost scope */
  process_scope(SLIST_FIRST(&scope_stack));
  /*
 * Decend the tree of scopes and insert/emit
 * patches as appropriate.  We perform a depth first
 * traversal, recursively handling each scope.
 */
  /* start at the root scope */
  dump_scope(SLIST_FIRST(&scope_stack));

  /* Patch up forward jump addresses */
  back_patch();

  if (ofile != NULL)
   output_code();
  if (regfile != NULL)
   symtable_dump(regfile, regdiagfile);
  if (listfile != NULL)
   output_listing(inputfilename);
 }

 stop(NULL, 0);
 /* NOTREACHED */
 return (0);
}

static void
usage()
{

 (void)fprintf(stderr,
"usage: %-16s [-nostdinc] [-I-] [-I directory] [-o output_file]\n"
" [-r register_output_file [-p register_diag_file -i includefile]]\n"
" [-l program_list_file]\n"
" input_file\n", appname);
 exit(EX_USAGE);
}

static void
back_patch()
{
 struct instruction *cur_instr;

 for (cur_instr = STAILQ_FIRST(&seq_program);
      cur_instr != NULL;
      cur_instr = STAILQ_NEXT(cur_instr, links)) {
  if (cur_instr->patch_label != NULL) {
   struct ins_format3 *f3_instr;
   u_int address;

   if (cur_instr->patch_label->type != LABEL) {
    char buf[255];

    snprintf(buf, sizeof(buf),
      "Undefined label %s",
      cur_instr->patch_label->name);
    stop(buf, EX_DATAERR);
    /* NOTREACHED */
   }
   f3_instr = &cur_instr->format.format3;
   address = f3_instr->address;
   address += cur_instr->patch_label->info.linfo->address;
   f3_instr->address = address;
  }
 }
}

static void
output_code()
{
 struct instruction *cur_instr;
 patch_t *cur_patch;
 critical_section_t *cs;
 symbol_node_t *cur_node;
 int instrcount;

 instrcount = 0;
 fprintf(ofile,
"/*\n"
" * DO NOT EDIT - This file is automatically generated\n"
" * from the following source files:\n"
" *\n"
"%s */\n", versions);

 fprintf(ofile, "static const uint8_t seqprog[] = {\n");
 for (cur_instr = STAILQ_FIRST(&seq_program);
      cur_instr != NULL;
      cur_instr = STAILQ_NEXT(cur_instr, links)) {

  fprintf(ofile, "%s\t0x%02x, 0x%02x, 0x%02x, 0x%02x",
   cur_instr == STAILQ_FIRST(&seq_program) ? "" : ",\n",
#ifdef __LITTLE_ENDIAN
   cur_instr->format.bytes[0],
   cur_instr->format.bytes[1],
   cur_instr->format.bytes[2],
   cur_instr->format.bytes[3]);
#else
   cur_instr->format.bytes[3],
   cur_instr->format.bytes[2],
   cur_instr->format.bytes[1],
   cur_instr->format.bytes[0]);
#endif
  instrcount++;
 }
 fprintf(ofile, "\n};\n\n");

 if (patch_arg_list == NULL)
  stop("Patch argument list not defined",
       EX_DATAERR);

 /*
 *  Output patch information.  Patch functions first.
 */
 fprintf(ofile,
"typedef int %spatch_func_t (%s);\n", prefix, patch_arg_list);

 for (cur_node = SLIST_FIRST(&patch_functions);
      cur_node != NULL;
      cur_node = SLIST_NEXT(cur_node,links)) {
  fprintf(ofile,
"static %spatch_func_t %spatch%d_func;\n"
"\n"
"static int\n"
"%spatch%d_func(%s)\n"
"{\n"
" return (%s);\n"
"}\n\n",
   prefix,
   prefix,
   cur_node->symbol->info.condinfo->func_num,
   prefix,
   cur_node->symbol->info.condinfo->func_num,
   patch_arg_list,
   cur_node->symbol->name);
 }

 fprintf(ofile,
"static const struct patch {\n"
" %spatch_func_t *patch_func;\n"
" uint32_t begin :10,\n"
" skip_instr :10,\n"
" skip_patch :12;\n"
"} patches[] = {\n", prefix);

 for (cur_patch = STAILQ_FIRST(&patches);
      cur_patch != NULL;
      cur_patch = STAILQ_NEXT(cur_patch,links)) {
  fprintf(ofile, "%s\t{ %spatch%d_func, %d, %d, %d }",
   cur_patch == STAILQ_FIRST(&patches) ? "" : ",\n",
   prefix,
   cur_patch->patch_func, cur_patch->begin,
   cur_patch->skip_instr, cur_patch->skip_patch);
 }

 fprintf(ofile, "\n};\n\n");

 fprintf(ofile,
"static const struct cs {\n"
" uint16_t begin;\n"
" uint16_t end;\n"
"} critical_sections[] = {\n");

 for (cs = TAILQ_FIRST(&cs_tailq);
      cs != NULL;
      cs = TAILQ_NEXT(cs, links)) {
  fprintf(ofile, "%s\t{ %d, %d }",
   cs == TAILQ_FIRST(&cs_tailq) ? "" : ",\n",
   cs->begin_addr, cs->end_addr);
 }

 fprintf(ofile, "\n};\n\n");

 fprintf(ofile,
 "#define NUM_CRITICAL_SECTIONS ARRAY_SIZE(critical_sections)\n");

 fprintf(stderr, "%s: %d instructions used\n", appname, instrcount);
}

static void
dump_scope(scope_t *scope)
{
 scope_t *cur_scope;

 /*
 * Emit the first patch for this scope
 */
 emit_patch(scope, 0);

 /*
 * Dump each scope within this one.
 */
 cur_scope = TAILQ_FIRST(&scope->inner_scope);

 while (cur_scope != NULL) {

  dump_scope(cur_scope);

  cur_scope = TAILQ_NEXT(cur_scope, scope_links);
 }

 /*
 * Emit the second, closing, patch for this scope
 */
 emit_patch(scope, 1);
}

void
emit_patch(scope_t *scope, int patch)
{
 patch_info_t *pinfo;
 patch_t *new_patch;

 pinfo = &scope->patches[patch];

 if (pinfo->skip_instr == 0)
  /* No-Op patch */
  return;

 new_patch = (patch_t *)malloc(sizeof(*new_patch));

 if (new_patch == NULL)
  stop("Could not malloc patch structure", EX_OSERR);

 memset(new_patch, 0, sizeof(*new_patch));

 if (patch == 0) {
  new_patch->patch_func = scope->func_num;
  new_patch->begin = scope->begin_addr;
 } else {
  new_patch->patch_func = 0;
  new_patch->begin = scope->end_addr;
 }
 new_patch->skip_instr = pinfo->skip_instr;
 new_patch->skip_patch = pinfo->skip_patch;
 STAILQ_INSERT_TAIL(&patches, new_patch, links);
}

void
output_listing(char *ifilename)
{
 char buf[1024];
 FILE *ifile;
 struct instruction *cur_instr;
 patch_t *cur_patch;
 symbol_node_t *cur_func;
 int *func_values;
 int instrcount;
 int instrptr;
 int line;
 int func_count;
 int skip_addr;

 instrcount = 0;
 instrptr = 0;
 line = 1;
 skip_addr = 0;
 if ((ifile = fopen(ifilename, "r")) == NULL) {
  perror(ifilename);
  stop(NULL, EX_DATAERR);
 }

 /*
 * Determine which options to apply to this listing.
 */
 for (func_count = 0, cur_func = SLIST_FIRST(&patch_functions);
     cur_func != NULL;
     cur_func = SLIST_NEXT(cur_func, links))
  func_count++;

 func_values = NULL;
 if (func_count != 0) {
  func_values = (int *)malloc(func_count * sizeof(int));

  if (func_values == NULL)
   stop("Could not malloc", EX_OSERR);
  
  func_values[0] = 0; /* FALSE func */
  func_count--;

  /*
 * Ask the user to fill in the return values for
 * the rest of the functions.
 */
  
  
  for (cur_func = SLIST_FIRST(&patch_functions);
       cur_func != NULL && SLIST_NEXT(cur_func, links) != NULL;
       cur_func = SLIST_NEXT(cur_func, links), func_count--) {
   int input;
   
   fprintf(stdout, "\n(%s)\n", cur_func->symbol->name);
   fprintf(stdout,
    "Enter the return value for "
    "this expression[T/F]:");

   while (1) {

    input = getchar();
    input = toupper(input);

    if (input == 'T') {
     func_values[func_count] = 1;
     break;
    } else if (input == 'F') {
     func_values[func_count] = 0;
     break;
    }
   }
   if (isatty(fileno(stdin)) == 0)
    putchar(input);
  }
  fprintf(stdout, "\nThanks!\n");
 }

 /* Now output the listing */
 cur_patch = STAILQ_FIRST(&patches);
 for (cur_instr = STAILQ_FIRST(&seq_program);
      cur_instr != NULL;
      cur_instr = STAILQ_NEXT(cur_instr, links), instrcount++) {

  if (check_patch(&cur_patch, instrcount,
    &skip_addr, func_values) == 0) {
   /* Don't count this instruction as it is in a patch
 * that was removed.
 */
                        continue;
  }

  while (line < cur_instr->srcline) {
   fgets(buf, sizeof(buf), ifile);
    fprintf(listfile, " \t%s", buf);
    line++;
  }
  fprintf(listfile, "%04x %02x%02x%02x%02x", instrptr,
#ifdef __LITTLE_ENDIAN
   cur_instr->format.bytes[0],
   cur_instr->format.bytes[1],
   cur_instr->format.bytes[2],
   cur_instr->format.bytes[3]);
#else
   cur_instr->format.bytes[3],
   cur_instr->format.bytes[2],
   cur_instr->format.bytes[1],
   cur_instr->format.bytes[0]);
#endif
  /*
 * Macro expansions can cause several instructions
 * to be output for a single source line.  Only
 * advance the line once in these cases.
 */
  if (line == cur_instr->srcline) {
   fgets(buf, sizeof(buf), ifile);
   fprintf(listfile, "\t%s", buf);
   line++;
  } else {
   fprintf(listfile, "\n");
  }
  instrptr++;
 }
 /* Dump the remainder of the file */
 while(fgets(buf, sizeof(buf), ifile) != NULL)
  fprintf(listfile, " %s", buf);

 fclose(ifile);
}

static int
check_patch(patch_t **start_patch, int start_instr,
     int *skip_addr, int *func_vals)
{
 patch_t *cur_patch;

 cur_patch = *start_patch;

 while (cur_patch != NULL && start_instr == cur_patch->begin) {
  if (func_vals[cur_patch->patch_func] == 0) {
   int skip;

   /* Start rejecting code */
   *skip_addr = start_instr + cur_patch->skip_instr;
   for (skip = cur_patch->skip_patch;
        skip > 0 && cur_patch != NULL;
        skip--)
    cur_patch = STAILQ_NEXT(cur_patch, links);
  } else {
   /* Accepted this patch.  Advance to the next
 * one and wait for our intruction pointer to
 * hit this point.
 */
   cur_patch = STAILQ_NEXT(cur_patch, links);
  }
 }

 *start_patch = cur_patch;
 if (start_instr < *skip_addr)
  /* Still skipping */
  return (0);

 return (1);
}

/*
 * Print out error information if appropriate, and clean up before
 * terminating the program.
 */
void
stop(const char *string, int err_code)
{
 if (string != NULL) {
  fprintf(stderr, "%s: ", appname);
  if (yyfilename != NULL) {
   fprintf(stderr, "Stopped at file %s, line %d - ",
    yyfilename, yylineno);
  }
  fprintf(stderr, "%s\n", string);
 }

 if (ofile != NULL) {
  fclose(ofile);
  if (err_code != 0) {
   fprintf(stderr, "%s: Removing %s due to error\n",
    appname, ofilename);
   unlink(ofilename);
  }
 }

 if (regfile != NULL) {
  fclose(regfile);
  if (err_code != 0) {
   fprintf(stderr, "%s: Removing %s due to error\n",
    appname, regfilename);
   unlink(regfilename);
  }
 }

 if (listfile != NULL) {
  fclose(listfile);
  if (err_code != 0) {
   fprintf(stderr, "%s: Removing %s due to error\n",
    appname, listfilename);
   unlink(listfilename);
  }
 }

 symlist_free(&patch_functions);
 symtable_close();

 exit(err_code);
}

struct instruction *
seq_alloc()
{
 struct instruction *new_instr;

 new_instr = (struct instruction *)malloc(sizeof(struct instruction));
 if (new_instr == NULL)
  stop("Unable to malloc instruction object", EX_SOFTWARE);
 memset(new_instr, 0, sizeof(*new_instr));
 STAILQ_INSERT_TAIL(&seq_program, new_instr, links);
 new_instr->srcline = yylineno;
 return new_instr;
}

critical_section_t *
cs_alloc()
{
 critical_section_t *new_cs;

 new_cs= (critical_section_t *)malloc(sizeof(critical_section_t));
 if (new_cs == NULL)
  stop("Unable to malloc critical_section object", EX_SOFTWARE);
 memset(new_cs, 0, sizeof(*new_cs));
 
 TAILQ_INSERT_TAIL(&cs_tailq, new_cs, links);
 return new_cs;
}

scope_t *
scope_alloc()
{
 scope_t *new_scope;

 new_scope = (scope_t *)malloc(sizeof(scope_t));
 if (new_scope == NULL)
  stop("Unable to malloc scope object", EX_SOFTWARE);
 memset(new_scope, 0, sizeof(*new_scope));
 TAILQ_INIT(&new_scope->inner_scope);
 
 if (SLIST_FIRST(&scope_stack) != NULL) {
  TAILQ_INSERT_TAIL(&SLIST_FIRST(&scope_stack)->inner_scope,
      new_scope, scope_links);
 }
 /* This patch is now the current scope */
 SLIST_INSERT_HEAD(&scope_stack, new_scope, scope_stack_links);
 return new_scope;
}

void
process_scope(scope_t *scope)
{
 /*
 * We are "leaving" this scope.  We should now have
 * enough information to process the lists of scopes
 * we encapsulate.
 */
 scope_t *cur_scope;
 u_int skip_patch_count;
 u_int skip_instr_count;

 cur_scope = TAILQ_LAST(&scope->inner_scope, scope_tailq);
 skip_patch_count = 0;
 skip_instr_count = 0;
 while (cur_scope != NULL) {
  u_int patch0_patch_skip;

  patch0_patch_skip = 0;
  switch (cur_scope->type) {
  case SCOPE_IF:
  case SCOPE_ELSE_IF:
   if (skip_instr_count != 0) {
    /* Create a tail patch */
    patch0_patch_skip++;
    cur_scope->patches[1].skip_patch =
        skip_patch_count + 1;
    cur_scope->patches[1].skip_instr =
        skip_instr_count;
   }

   /* Count Head patch */
   patch0_patch_skip++;

   /* Count any patches contained in our inner scope */
   patch0_patch_skip += cur_scope->inner_scope_patches;

   cur_scope->patches[0].skip_patch = patch0_patch_skip;
   cur_scope->patches[0].skip_instr =
       cur_scope->end_addr - cur_scope->begin_addr;

   skip_instr_count += cur_scope->patches[0].skip_instr;

   skip_patch_count += patch0_patch_skip;
   if (cur_scope->type == SCOPE_IF) {
    scope->inner_scope_patches += skip_patch_count;
    skip_patch_count = 0;
           skip_instr_count = 0;
   }
   break;
  case SCOPE_ELSE:
   /* Count any patches contained in our innter scope */
   skip_patch_count += cur_scope->inner_scope_patches;

   skip_instr_count += cur_scope->end_addr
       - cur_scope->begin_addr;
   break;
  case SCOPE_ROOT:
   stop("Unexpected scope type encountered", EX_SOFTWARE);
   /* NOTREACHED */
  }

  cur_scope = TAILQ_PREV(cur_scope, scope_tailq, scope_links);
 }
}