rzzzwilson.pymlac/vimlac/test_cpu.c

/*
 * Test the CPU implementation.
 *
 * We implement a small interpreter to test the CPU.  The test code is read in
 * from a file:
 *
 *    # LAW
 *    setreg ac 012345; setreg l 1; setreg pc 0100; setmem 0100 [LAW 0]; RUN; checkcycles 1; checkreg pc 0101; checkreg ac 0
 *    setreg ac 012345; setreg l 0; setmem 0100 [LAW 0]; RUN 0100
 *            checkcycles 1; checkreg pc 0101; checkreg ac 0
 *
 * The instructions are delimited by ';' characters.  A line beginning with a
 * TAB character is a continuation of the previous line.
 * Lines with '#' in column 1 are comments.
 *
 * The test instructions are:
 *     setreg <name> <value>
 *         where <name> is one of AC, L, PC or DS, value is any value
 *         (all registers are set to 0 initially)
 *
 *     setmem <addr> <value>
 *         where <addr> is an address and value is any value OR
 *         [<instruction>] where the value is the assembled opcode
 *
 *     run [<addr>]
 *         execute one instruction, if optional <addr> is used PC := addr before
 *
 *     checkcycles <number>
 *         check number of executed cycles is <number>
 *
 *     checkreg <name> <value>
 *         check register (AC, L, PC or DS) has value <value>
 *
 *     checkmem <addr> <value>
 *         check that memory at <addr> has <value>
 *
 *     allreg <value>
 *         sets all registers to <value>
 *         a "allreg 0" is assumed before each test
 *
 *     allmem <value>
 *         sets all of memory to <value>
 *         a "allmem 0" is assumed before each test
 *
 * In addition, all of memory is checked for changed values after execution
 * except where an explicit "checkmem <addr> <value>" has been performed.
 * Additionally, registers that aren't explicitly checked are tested to make
 * sure they didn't change.
 *
 * If a test line finds no error, just print the fully assembled test line.
 * If any errors are found, print line followed by all errors.
 */

#include <stdio.h>
#include <stdlib.h>
#include <ctype.h>
#include <getopt.h>

#include "vimlac.h"
#include "cpu.h"
#include "dcpu.h"
#include "memory.h"
#include "error.h"
#include "log.h"


// string comparison macro
#define STREQ(a, b) (strcmp((a), (b)) == 0)

// constants
const char *LstFilename = "_#TEST#_.lst";   // LST filename
const char *AsmFilename = "_#TEST#_.asm";   // ASM filename

const int MaxLineSize = 4096;               // max length of one script line

// command structures
typedef struct _Command
{
    struct _Command *next;
    char *opcode;
    char *field1;
    char *field2;
    char *orig2;
} Command;

typedef struct _Test
{
    struct _Test *next;
    int line_number;
    Command *commands;
} Test;

typedef struct _Assoc
{
    struct _Assoc *next;
} Assoc;


bool DisplayOn = false;
int UsedCycles = 0;
WORD RegAllValue = 0;
WORD MemAllValue = 0;
Assoc *RememberReg;


void
remember(Assoc *head, char *name, WORD value)
{
}

/******************************************************************************
Description : Convert a string value into a WORD integer.
 Parameters : str - address of string holding [0-9] characters
    Returns : A WORD value containing the integer number in 'str'.
   Comments : 'str' may contain a decimal or octal string representation.
 ******************************************************************************/
WORD
str2word(char *str)
{
    WORD value = 0;

    if (*str == '0')
    {   // octal
        sscanf(str, "%o", &value);
    }
    else
    {   // decimal
        sscanf(str, "%d", &value);
    }

    return value;
}


/******************************************************************************
Description : Constructor for a Command struct.
 Parameters : opcode - the opcode value for the struct
    Returns : The address of a new Command struct.
   Comments : The ->next, ->field1 and ->field2 fields are NULL.
 ******************************************************************************/
Command *
new_Command(char *opcode)
{
    Command *result = (Command *) malloc(sizeof(Command));

    result->opcode = (char *) malloc(strlen(opcode)+1);
    strcpy(result->opcode, opcode);
    for (char *cptr = result->opcode; *cptr; ++cptr)
        *cptr = tolower(*cptr);

    result->next = NULL;
    result->field1 = NULL;
    result->field2 = NULL;
    result->orig2 = NULL;

    return result;
}


/******************************************************************************
Description : Constructor for a Command struct.
 Parameters : line_number - the number of the line that created the Test
            : commands    - address of chain of commands for Test
    Returns : The address of a new Test struct.
   Comments : The ->next field is NULL.
 ******************************************************************************/
Test *
new_Test(int line_number, Command *commands)
{
    Test *result = (Test *) malloc(sizeof(Test));

    result->next = NULL;
    result->line_number = line_number;
    result->commands = commands;

    return result;
}


/******************************************************************************
Description : Function to provide help to the befuddled user.
 Parameters : msg - if not NULL, a message to display
    Returns : 
   Comments : String is converted to upper case.
 ******************************************************************************/
char *
new_String(char *str)
{
    char *result = (char *) malloc(strlen(str)+1);
    strcpy(result, str);
    for (char *cptr = result; *cptr; ++cptr)
        *cptr = tolower(*cptr);
    return result;
}


/******************************************************************************
Description : Function to provide help to the befuddled user.
 Parameters : msg - if not NULL, a message to display
    Returns : 
   Comments : 
 ******************************************************************************/
void
usage(char *msg)
{
    char *delim = "******************************"
                  "******************************";

    if (msg != NULL)
    {
        fprintf(stderr, "%s\n", delim);
        fprintf(stderr, "%s\n", msg);
        fprintf(stderr, "%s\n\n", delim);
    }

    fprintf(stderr, "Test pymlac CPU opcodes DIRECTLY.\n\n");

    fprintf(stderr, "Usage: test_CPU.py [<options>] <filename>\n\n");

    fprintf(stderr, "where <filename> is a file of test instructions and\n");
    fprintf(stderr, "      <options> is one or more of\n");
    fprintf(stderr, "          -h    prints this help and stops\n");
}


/******************************************************************************
Description : Function to return the imlac binary opcode of an instruction.
 Parameters : addr   - address of the instruction
            : opcode - string containing the instruction
    Returns : 
   Comments : We generate an ASM file, assemble it and pick out the binary
            : opcode from the LST file.
 ******************************************************************************/
WORD
assemble(WORD addr, char *opcode)
{
    FILE *fd;
    char buffer[128];
    WORD result;

    // create the ASM file
    fd = fopen(AsmFilename, "wb");
    fprintf(fd, "\torg\t%07o\n", addr);
    fprintf(fd, "\t%s\n", opcode);
    fprintf(fd, "\tend\n");
    fclose(fd);

    // assemble the file
    sprintf(buffer, "../iasm/iasm -l %s %s", LstFilename, AsmFilename);
    if (system(buffer) == -1)
        error("Error doing: %s", buffer);
   
    // read LST file for opcode on second line
    fd = fopen(LstFilename, "rb");
    if (fgets(buffer, sizeof(buffer), fd) == NULL)
        error("Error reading %s", LstFilename);
    if (fgets(buffer, sizeof(buffer), fd) == NULL)
        error("Error reading %s", LstFilename);
    if (sscanf(buffer, "%o", &result) != 1)
        error("Badly formatted assembler output: %s", buffer);
    fclose(fd);

    return result;   
}
   

/******************************************************************************
Description : Decide if buffer kine should be skipped.
 Parameters : buffer - address of line buffer
    Returns : 'true' if line should be skipped (no commands)
   Comments : Skip if line empty or column 1 is '#'.
 ******************************************************************************/
bool
should_skip(char *buffer)
{
    char *scan = buffer;

    if (buffer[0] == '#')
        return true;

    while (*scan)
    {
        if (!isspace(*scan))
            return false;
        ++scan;
    }

    return true;
}


/******************************************************************************
Description : Parse one command string and populate a new Command struct.
 Parameters : scan - address of command string
    Returns : Address of the new Command struct.
   Comments : result->next is set to NULL.
            : A command is one, two or three fields.
 ******************************************************************************/
Command *
parse_one_cmd(char *scan)
{
    Command *result = NULL;
    char *opcode;
    char *field1 = NULL;
    char *field2 = NULL;
    char *orig2 = NULL;
    char tmpbuff[16];


    // find start and end of opcode
    while (*scan && isspace(*scan))     // skip leading space
        ++scan;
    opcode = scan;
    while (*scan && !isspace(*scan))
        ++scan;
    if (*scan)
        *(scan++) = '\0';

    // start/end of field1 (if there)
    while (*scan && isspace(*scan))     // skip leading space
        ++scan;
    if (*scan)
    {   // we have field1, at least
        field1 = scan;
        while (*scan && !isspace(*scan))
            ++scan;
        if (*scan)
            *(scan++) = '\0';

        // field2
        while (*scan && isspace(*scan)) // skip leading space
            ++scan;
        if (*scan)
        {
            field2 = scan;
            if (*field2 == '[')
            {   // assembler field
                orig2 = new_String(field2);
                ++field2;
                while (*scan && !(*scan == ']'))
                    ++scan;
                *scan = '\0';
                WORD v = str2word(field1);
                v = assemble(str2word(field1), field2);
                sprintf(tmpbuff, "%d", v);
                field2 = tmpbuff;
            }
            else
            {
                while (*scan && !isspace(*scan))
                    ++scan;
                *scan = '\0';
            }
        }
    }

    // create new Command struct
    result = new_Command(opcode);

    if (field1)
        result->field1 = new_String(field1);
    else
        result->field1 = NULL;

    if (field2)
        result->field2 = new_String(field2);
    else
        result->field2 = NULL;

    result->orig2 = orig2;

    return result;
}


/******************************************************************************
Description : Read the command buffer and create a chain of Command structs.
 Parameters : scriptpath - script filename
    Returns : Pointer to a chain of Test structs.
   Comments : 
 ******************************************************************************/
Command *
parse_cmds(char *scan)
{
    Command *result = NULL;
    Command *last_result = NULL;
    char *end_cmd = NULL;
    Command *new_cmd = NULL;

    // scan the buffer for commands
    do
    {
        char *new_scan = NULL;

        while (*scan && isspace(*scan))
            ++scan;

        end_cmd = strchr(scan, ';');
        if (end_cmd)
        {
            new_scan = end_cmd + 1;
            *end_cmd = '\0';
        }

        new_cmd = parse_one_cmd(scan);

        if (result == NULL)
        {
            result = new_cmd;
            last_result = result;
        }
        else
        {
            last_result->next = new_cmd;
            last_result = new_cmd;
        }

        scan = new_scan;
    } while (scan && *scan);


    return result;
}


/******************************************************************************
Description : Read the script file and create a chain of Test structs.
 Parameters : scriptpath - script filename
    Returns : Pointer to a chain of Test structs.
   Comments : 
 ******************************************************************************/
Test *
parse_script(char *scriptpath)
{
    Test *head_test = NULL;         // head of Test chain
    Test *last_test = NULL;         // pointer to last Test found
    Command *last_cmd = NULL;       // pointer to last Command found
    char buffer[MaxLineSize];       // buffer to read each line into
    char *scan;                     // buffer scan pointer
    FILE *fd;
    int line_number = 0;

    // open script file
    fd = fopen(scriptpath, "rb");

    // read script file, handle each line
    while (true)
    {
        // NULL fill buffer so we can tell if line too long
        memset(buffer, (char) NULL, sizeof(buffer));

        // get next line, break out of loop on end of file
        if (fgets(buffer, sizeof(buffer), fd) == NULL)
            break;

        // bump line number and make sure buffer '\0' terminated
        ++line_number;
        buffer[MaxLineSize-1] = '\0';

        // decide if line is too long, look for '\n'
        scan = strchr (buffer, '\n');
        if (scan == NULL)
        {   // '\n' not found, line too long!
            error("File %s: line too long at line number %d",
                    scriptpath, line_number);
        }
        *scan = '\0';                   // remove trailing '\n'

        // if comment or blank line, try again
        if (should_skip(buffer))
            continue;

        // decide if line is new test or continuation
        if (isspace(buffer[0]))
        {   // continuation
            // test for continuation without first part of test
            if (head_test == NULL)
                error("Test continuation on first code line of test file!?");

            Command *new_cmds = parse_cmds(buffer);

            last_cmd->next = new_cmds;
            while (last_cmd->next)
                last_cmd = last_cmd->next;
        }
        else
        {   // new test
            Test *new_test = new_Test(line_number, parse_cmds(buffer));

            if (head_test == NULL)
            {   // first test
                last_test = head_test = new_test;
            }
            else
            {   // add to end of Test chain
                last_test->next = new_test;
                last_test = new_test;
            }

            // move 'last_cmd' to end of command chain
            for (last_cmd = last_test->commands; last_cmd->next != NULL; last_cmd = last_cmd->next)
                ;
        }
    }

    // close script file
    fclose(fd);

    return head_test;
}


/******************************************************************************
Description : Set a register to a value
 Parameters : test - pointer to a Test struct
    Returns : The number of errors encountered (0 or 1).
   Comments : Sets globals used to check after execution.
 ******************************************************************************/
int
setreg(char *name, char *fld2)
{
    int result = 0;
    WORD value = str2word(fld2);

    vlog("Setting register %s to %07o", name, value);

    if (STREQ(name, "ac"))
        cpu_set_AC(value);
    else if (STREQ(name, "l"))
        cpu_set_L(value);
    else if (STREQ(name, "pc"))
        cpu_set_PC(value);
    else if (STREQ(name, "ds"))
        cpu_set_DS(value);
    else
    {
        vlog("setreg: bad register name: %s", name);
        printf("setreg: bad register name: %s\n", name);
        result = 1;
    }

    return result;
}

/******************************************************************************
Description : Set the display ON or OFF.
 Parameters : state - string containing 'on' or 'off'
            : var2  - unused
    Returns : The number of errors encountered (0 or 1).
   Comments : 
 ******************************************************************************/
int
setd(char *state, char *var2)
{
    vlog("Setting display '%s'", state);

    if (STREQ(state, "on"))
        dcpu_start();
    else if (STREQ(state, "off"))
        dcpu_stop();
    else
    {
        vlog("setd: bad state: %s", state);
        printf("setd: bad state: %s", state);
        return 1;
    }

    return 0;
}


/******************************************************************************
Description : Set a memory cell to a value;
 Parameters : addr - address of memory cell (string)
            : fld2 - value to put into cell (string)
    Returns : The number of errors encountered (0 or 1).
   Comments : Sets globals used to check after execution.
 ******************************************************************************/
int
setmem(char *addr, char *fld2)
{
    WORD address = str2word(addr);
    WORD value = str2word(fld2);

    vlog("Setting memory at %07o to %07o", address, value);

    mem_put(address, false, value);

    return 0;
}


/******************************************************************************
Description : Set all registers to a value.
 Parameters : value - value to put into registers (string)
            : var2  - unused
    Returns : The number of errors encountered (0 or 1).
   Comments : 
 ******************************************************************************/
int
allreg(char *value, char *var2)
{
    int val = str2word(value);

    vlog("Setting all registers to %07o", val);

    RegAllValue = val;

    cpu_set_AC(val);
    cpu_set_L(val && 1);
    cpu_set_PC(val);
    cpu_set_DS(val);

    return 0;
}


/******************************************************************************
Description : Set all memory locations to a value.
 Parameters : value - value to put into memory (string)
            : var2  - unused
    Returns : The number of errors encountered (0 or 1).
   Comments : 
 ******************************************************************************/
int
allmem(char *value, char *var2)
{
    int val = str2word(value);

    vlog("Setting all memory to %07o", val);

    MemAllValue = val;

    for (WORD adr = 0; adr < MEM_SIZE; ++adr)
        mem_put(adr, false, val);

    return 0;
}


/******************************************************************************
Description : Run one instruction on the CPU.
 Parameters : addr - address of memory cell (string, may be NULL)
            : fld2 - unused
    Returns : The number of errors encountered (0 or 1).
   Comments : 
 ******************************************************************************/
int
run_one(char *addr, char *fld2)
{
    WORD address = str2word(addr);

    vlog("Executing single instruction at %s", (addr) ? addr : "PC");

    if (addr)
    {   // force PC to given address
        cpu_set_PC(address);
    }

    cpu_start();
    UsedCycles = cpu_execute_one();
    cpu_stop();

    return 0;
}


/******************************************************************************
Description : Check that the number of cycles used is as expected.
 Parameters : cycles - address of memory cell (string)
            : var2   - unused
    Returns : The number of errors encountered (0 or 1).
   Comments : 
 ******************************************************************************/
int
checkcycles(char *cycles, char *fld2)
{
    WORD c = str2word(cycles);

    if (c != UsedCycles)
    {
        vlog("Test used %d cycles, expected %d!?", UsedCycles, c);
        printf("Test used %d cycles, expected %d!?\n", UsedCycles, c);
        return 1;
    }

    return 0;
}


/******************************************************************************
Description : Check that a register contents is as expected.
 Parameters : reg   - string holding register name
            : value - expected register value (string)
    Returns : The number of errors encountered (0 or 1).
   Comments : 
 ******************************************************************************/
int
checkreg(char *reg, char *value)
{
    WORD val = str2word(value);

    if (STREQ(reg, "ac"))
    {
        remember(RememberReg, reg, cpu_get_AC());
        if (cpu_get_AC() != val)
        {
            vlog("AC is %07o, should be %07o", cpu_get_AC(), val);
            printf("AC is %07o, should be %07o\n", cpu_get_AC(), val);
            return 1;
        }
    }
    else if (STREQ(reg, "l"))
    {
        remember(RememberReg, reg, cpu_get_L());
        if (cpu_get_L() != val)
        {
            vlog("L is %02o, should be %02o", cpu_get_L(), val);
            printf("L is %02o, should be %02o\n", cpu_get_L(), val);
            return 1;
        }
    }
    else if (STREQ(reg, "pc"))
    {
        remember(RememberReg, reg, cpu_get_PC());
        if (cpu_get_PC() != val)
        {
            vlog("PC is %07o, should be %07o", cpu_get_PC(), val);
            printf("PC is %07o, should be %07o\n", cpu_get_PC(), val);
            return 1;
        }
    }
    else if (STREQ(reg, "ds"))
    {
        remember(RememberReg, reg, cpu_get_DS());
        if (cpu_get_DS() != val)
        {
            vlog("DS is %07o, should be %07o", cpu_get_DS(), val);
            printf("DS is %07o, should be %07o\n", cpu_get_DS(), val);
            return 1;
        }
    }
    else
    {
        vlog("checkreg: bad register name: %s", reg);
        printf("checkreg: bad register name: %s\n", reg);
        return 1;
    }

    return 0;
}


/******************************************************************************
Description : Check that the display is in the correct state.
 Parameters : state  - string holding expected display state ('on' or 'off)
            : unused - unused
    Returns : The number of errors encountered (0 or 1).
   Comments : 
 ******************************************************************************/
int
checkd(char *state, char *unused)
{
    if ((STREQ(state, "on")) && !DisplayOn)
    {
        vlog("Display CPU run state is %s, should be 'ON'",
                (DisplayOn ? "ON": "OFF"));
        printf("Display CPU run state is %s, should be 'ON'\n",
                (DisplayOn ? "ON": "OFF"));
        return 1;
    }
    else if ((STREQ(state, "off")) && DisplayOn)
    {
        vlog("DCPU run state is %s, should be 'OFF'",
                (DisplayOn ? "ON": "OFF"));
        printf("DCPU run state is %s, should be 'OFF'\n",
                (DisplayOn ? "ON": "OFF"));
        return 1;
    }
    else
    {
        vlog("checkd: state should be 'on' or 'OFF', got %s", state);
        printf("checkd: state should be 'on' or 'off', got %s\n", state);
        return 1;
    }

    return 0;
}


/******************************************************************************
Description : Check that a memory address contents is as expected.
 Parameters : address - memory address to check (string)
            : value   - expected memory value (string)
    Returns : The number of errors encountered (0 or 1).
   Comments : 
 ******************************************************************************/
int
checkmem(char *address, char *value)
{
    WORD adr = str2word(address);
    WORD val = str2word(value);
    WORD memvalue = mem_get(adr, false);

    if (memvalue != val)
    {
        vlog("Memory at address %07o is %07o, should be %07o",
                adr, memvalue, val);
        printf("Memory at address %07o is %07o, should be %07o\n",
                adr, memvalue, val);
        return 1;
    }

    return 0;
}


/******************************************************************************
Description : Check that the CPU run state is as expected.
 Parameters : state  - the expected CPU state (string, 'ON' or 'OFF')
            : unused - unused
    Returns : The number of errors encountered (0 or 1).
   Comments : 
 ******************************************************************************/
int
checkrun(char *state, char *unused)
{

    if (STREQ(state, "on"))
    {
        vlog("CPU run state is '%s', should be '%s'",
                (cpu_get_state() ? "on": "off"), state);
        printf("CPU run state is '%s', should be '%s'\n",
                (cpu_get_state() ? "on": "off"), state);
        return 1;
    }
    else if (STREQ(state, "off"))
    {
        vlog("CPU run state is '%s', should be '%s'",
                (cpu_get_state() ? "on": "off"), state);
        printf("CPU run state is '%s', should be '%s'\n",
                (cpu_get_state() ? "on": "off"), state);
        return 1;
    }
    else
    {
        vlog("checkrun: state should be 'on' or 'off', got '%s'", state);
        printf("checkrun: state should be 'on' or 'off', got '%s'\n", state);
        return 1;
    }

    return 0;
}


/******************************************************************************
Description : Run all commands in one test line.
 Parameters : test - pointer to a Test struct
    Returns : The number of errors encountered (0 or 1).
   Comments : 
 ******************************************************************************/
int
run_one_test(Test *test)
{
    int error = 0;
    char buffer[256];

    for (Command *cmd = test->commands; cmd; cmd = cmd->next)
    {
        char *opcode = cmd->opcode;
        char *fld1 = cmd->field1;
        char *fld2 = cmd->field2;

        if (fld2)
            sprintf(buffer, "%s %s %07o%s",
                    opcode, fld1, atoi(fld2), (cmd->orig2) ? cmd->orig2 : "");
        else
            sprintf(buffer, "%s %s", opcode, fld1);
        LogPrefix = new_String(buffer);

        if (STREQ(opcode, "setreg"))
            error += setreg(fld1, fld2);
        else if (STREQ(opcode, "setmem"))
            error += setmem(fld1, fld2);
        else if (STREQ(opcode, "run"))
            error += run_one(fld1, fld2);
        else if (STREQ(opcode, "checkcycles"))
            error += checkcycles(fld1, fld2);
        else if (STREQ(opcode, "checkreg"))
            error += checkreg(fld1, fld2);
        else if (STREQ(opcode, "checkmem"))
            error += checkmem(fld1, fld2);
        else if (STREQ(opcode, "allreg"))
            error += allreg(fld1, fld2);
        else if (STREQ(opcode, "allmem"))
            error += allmem(fld1, fld2);
        else if (STREQ(opcode, "checkrun"))
            error += checkrun(fld1, fld2);
        else if (STREQ(opcode, "setd"))
            error += setd(fld1, fld2);
        else if (STREQ(opcode, "checkd"))
            error += checkd(fld1, fld2);
        else
        {
            printf("Unrecognized operation '%s' at line %d\n",
                    opcode, test->line_number);
            error += 1;
        }
    }

    return error;
}


/******************************************************************************
Description : Run tests and collect number of errors.
 Parameters : test - pointer to a chain if Test structs
    Returns : The number of errors encountered.
   Comments : 
 ******************************************************************************/
int
run(Test *test)
{
    int errors = 0;
    char buffer[1024];

    while (test)
    {
        sprintf(buffer, "%03d", test->line_number);
        LogPrefix = new_String(buffer);
        strcpy(buffer, "");

        printf("%03d:", test->line_number);

        for (Command *cscan = test->commands; cscan != NULL; cscan = cscan->next)
        {
            if (cscan->field2)
            {
                printf(" %s %s %07o%s;",
                        cscan->opcode, cscan->field1, atoi(cscan->field2), (cscan->orig2) ? cscan->orig2 : "");
                sprintf(buffer+strlen(buffer), " %s %s %07o%s;",
                        cscan->opcode, cscan->field1, atoi(cscan->field2), (cscan->orig2) ? cscan->orig2 : "");
            }
            else
            {
                if (cscan->field1)
                {
                    printf(" %s %s;", cscan->opcode, cscan->field1);
                    sprintf(buffer+strlen(buffer), " %s %s;", cscan->opcode, cscan->field1);
                }
                else
                {
                    printf(" %s;", cscan->opcode);
                    sprintf(buffer+strlen(buffer), " %s;", cscan->opcode);
                }
            }
        }

        vlog(buffer+1);
        printf("\n");

        errors += run_one_test(test);
        test = test->next;
    }

    return errors;
}


/******************************************************************************
Description : Function to execute test script.
 Parameters : script - path to script file to execute
    Returns : 
   Comments : 
 ******************************************************************************/
int
execute(char *script)
{
    Test *test = NULL;                      // chain of test commands

    // get test commands into massaged form in memory
    test = parse_script(script);

#ifdef DEBUG
    // DEBUG - print contents of 'test'
    for (Test *tscan = test; tscan != NULL; tscan = tscan->next)
    {
        printf("%03d: ", tscan->line_number);

        for (Command *cscan = tscan->commands; cscan != NULL; cscan = cscan->next)
            printf("%s %s %s; ", cscan->opcode, cscan->field1, cscan->field2);

        printf("\n");
        fflush(stdout);
    }
#endif

    // execute tests
    return run(test);
}


int
main(int argc, char *argv[])
{
    int errors = 0;
    int option = 0;
    char *script = NULL;
    FILE *script_fd;

    // check parameters
    while ((option = getopt(argc, argv, "h")) != -1)
    {
        switch (option)
        {
            case 'h':
                usage(NULL);
                exit(EXIT_SUCCESS);
            default:
                usage(NULL);
                exit(EXIT_FAILURE);
        }
    }

    if (optind >= argc)
    {
        usage("Expected test instructions filename after options");
        exit(EXIT_FAILURE);
    }

    // get filename and make sure it's there
    script = argv[optind];
    if ((script_fd = fopen(script, "rb")) == NULL)
        error("File %s doesn't exist or isn't readable: %d\n",
                script, errno);
    fclose(script_fd);

    errors = execute(script);

    printf("%d errors found\n", errors);

    return errors;
}