|
- /* Copyright (C) 2014-2015 Ben Kurtovic <ben.kurtovic@gmail.com>
- Released under the terms of the MIT License. See LICENSE for details. */
-
- #include <libgen.h>
- #include <limits.h>
- #include <stdint.h>
- #include <stdio.h>
- #include <stdlib.h>
- #include <string.h>
-
- #include "preprocessor.h"
- #include "directives.h"
- #include "errors.h"
- #include "io.h"
- #include "parse_util.h"
- #include "../logging.h"
- #include "../util.h"
-
- #define MAX_REGION_SIZE 32
-
- /* Helper defines for preprocess() */
-
- #define SAVE_ARG(line, first, oldval, newval) \
- if (first && oldval != newval) { \
- ei = error_info_create(line, ET_PREPROC, ED_PP_DUPLICATE); \
- error_info_append(ei, first); \
- asm_lines_free(condemned); \
- return ei; \
- } \
- oldval = newval; \
- first = line;
-
- #define FAIL_ON_COND(cond, err_desc) \
- if ((cond)) { \
- asm_lines_free(condemned); \
- return error_info_create(line, ET_PREPROC, err_desc); \
- }
-
- #define REQUIRE_ARG(line, d) \
- FAIL_ON_COND(!DIRECTIVE_HAS_ARG(line, d), ED_PP_NO_ARG)
-
- #define VALIDATE(retval) \
- FAIL_ON_COND(!(retval), ED_PP_BAD_ARG)
-
- #define RANGE_CHECK(arg, bound) \
- FAIL_ON_COND(arg > bound, ED_PP_ARG_RANGE)
-
- /*
- Preprocess a single source line (source, length) into a normalized ASMLine.
-
- *Only* the data and length fields in the ASMLine object are populated. The
- normalization process converts tabs to spaces, lowercases all alphabetical
- characters, and removes runs of multiple spaces (outside of string
- literals), strips comments, and other things.
-
- Return NULL if an ASM line was not generated from the source, i.e. if it is
- blank after being stripped.
- */
- static ASMLine* normalize_line(const char *source, size_t length)
- {
- char *data = malloc(sizeof(char) * length);
- if (!data)
- OUT_OF_MEMORY()
-
- size_t si, di, slashes = 0;
- bool has_content = false, space_pending = false, in_string = false;
- for (si = di = 0; si < length; si++) {
- char c = source[si];
-
- if (c == '\\')
- slashes++;
- else
- slashes = 0;
-
- if (in_string) {
- if (c == '"' && (slashes % 2) == 0)
- in_string = false;
-
- data[di++] = c;
- } else {
- if (c == ';')
- break;
- if (c == '"' && (slashes % 2) == 0)
- in_string = true;
- if (c >= 'A' && c <= 'Z')
- c += 'a' - 'A';
-
- if (c == ' ' || c == '\t')
- space_pending = true;
- else {
- if (space_pending) {
- if (has_content)
- data[di++] = ' ';
- space_pending = false;
- }
- has_content = true;
- data[di++] = c;
- }
- }
- }
-
- if (!has_content) {
- free(data);
- return NULL;
- }
-
- ASMLine *line = malloc(sizeof(ASMLine));
- if (!line)
- OUT_OF_MEMORY()
-
- data = realloc(data, sizeof(char) * di);
- if (!data)
- OUT_OF_MEMORY()
-
- line->data = data;
- line->length = di;
- return line;
- }
-
- /*
- Read and return the target path from an include directive.
-
- This function allocates a buffer to store the filename; it must be free()'d
- after calling read_source_file(). If a syntax error occurs while trying to
- read the path, it returns NULL.
- */
- static char* read_include_path(const ASMLine *line)
- {
- size_t maxlen = strlen(line->filename) + line->length, i, start, slashes;
- if (maxlen >= INT_MAX) // Allows us to safely downcast to int later
- return NULL;
-
- char *path = malloc(sizeof(char) * maxlen);
- if (!path)
- OUT_OF_MEMORY()
-
- if (!(i = DIRECTIVE_OFFSET(line, DIR_INCLUDE)))
- goto error;
- if (line->length - i <= 4) // Not long enough to hold a non-zero argument
- goto error;
- if (line->data[i++] != ' ' || line->data[i++] != '"')
- goto error;
-
- // TODO: parse escaped characters properly
- for (start = i, slashes = 0; i < line->length; i++) {
- if (line->data[i] == '"' && (slashes % 2) == 0)
- break;
- if (line->data[i] == '\\')
- slashes++;
- else
- slashes = 0;
- }
-
- if (i != line->length - 1) // Junk present after closing quote
- goto error;
-
- char *dup = strdup(line->filename);
- if (!dup)
- OUT_OF_MEMORY()
-
- // TODO: should normalize filenames in some way to prevent accidental dupes
- snprintf(path, maxlen, "%s/%.*s", dirname(dup), (int) (i - start),
- line->data + start);
- free(dup);
- return path;
-
- error:
- free(path);
- return NULL;
- }
-
- /*
- Return whether the given path has already been loaded.
- */
- static bool path_has_been_loaded(
- const char *path, const LineBuffer *root, const ASMInclude *include)
- {
- if (!strcmp(path, root->filename))
- return true;
-
- while (include) {
- if (!strcmp(path, include->lines->filename))
- return true;
- include = include->next;
- }
- return false;
- }
-
- /*
- Build a LineBuffer into a ASMLines, normalizing them along the way.
-
- This function operates recursively to handle includes, but handles no other
- preprocessor directives.
-
- On success, NULL is returned; *head points to the head of the new ASMLine
- list, and *tail to its tail (assuming it is non-NULL). On error, an
- ErrorInfo object is returned, and *head and *tail are not modified.
- *includes may be updated in either case.
- */
- static ErrorInfo* build_asm_lines(
- const LineBuffer *root, const LineBuffer *source, ASMLine **head,
- ASMLine **tail, ASMInclude **includes)
- {
- ASMLine dummy = {.next = NULL};
- ASMLine *line, *prev = &dummy;
- const Line *orig, *next_orig = source->lines;
-
- while ((orig = next_orig)) {
- line = normalize_line(orig->data, orig->length);
- next_orig = orig->next;
- if (!line)
- continue;
-
- // Populate ASMLine fields not set by normalize_line():
- line->original = orig;
- line->filename = source->filename;
- line->next = NULL;
-
- if (IS_DIRECTIVE(line, DIR_INCLUDE)) {
- ErrorInfo *ei;
- char *path = read_include_path(line);
- if (!path) {
- ei = error_info_create(line, ET_INCLUDE, ED_INC_BAD_ARG);
- asm_lines_free(line);
- asm_lines_free(dummy.next);
- return ei;
- }
-
- if (path_has_been_loaded(path, root, *includes)) {
- ei = error_info_create(line, ET_INCLUDE, ED_INC_RECURSION);
- asm_lines_free(line);
- asm_lines_free(dummy.next);
- free(path);
- return ei;
- }
-
- DEBUG("- reading included file: %s", path)
- LineBuffer *incbuffer = read_source_file(path, false);
- free(path);
- if (!incbuffer) {
- ei = error_info_create(line, ET_INCLUDE, ED_INC_FILE_READ);
- asm_lines_free(line);
- asm_lines_free(dummy.next);
- return ei;
- }
-
- ASMInclude *include = malloc(sizeof(ASMInclude));
- if (!include)
- OUT_OF_MEMORY()
-
- include->lines = incbuffer;
- include->next = *includes;
- *includes = include;
-
- ASMLine *inchead, *inctail;
- if ((ei = build_asm_lines(root, incbuffer, &inchead, &inctail,
- includes))) {
- error_info_append(ei, line);
- asm_lines_free(line);
- asm_lines_free(dummy.next);
- return ei;
- }
-
- prev->next = inchead;
- prev = inctail;
- asm_lines_free(line); // Destroy only the .include line
- }
- else {
- prev->next = line;
- prev = line;
- }
- }
-
- *head = dummy.next;
- if (tail)
- *tail = prev;
- return NULL;
- }
-
- /*
- Parse the region code string in an ASMLine and store it in *result.
-
- Return true on success and false on failure; in the latter case, *result is
- not modified.
- */
- static bool parse_region_string(uint8_t *result, const ASMLine *line)
- {
- char buffer[MAX_REGION_SIZE];
-
- size_t offset = DIRECTIVE_OFFSET(line, DIR_ROM_REGION) + 1;
- const char *arg = line->data + offset;
- ssize_t len = line->length - offset;
-
- if (len <= 2 || len >= MAX_REGION_SIZE + 2) // Account for double quotes
- return false;
- if (arg[0] != '"' || arg[len - 1] != '"')
- return false;
-
- strncpy(buffer, arg + 1, len - 2);
- buffer[len - 2] = '\0';
-
- uint8_t code = region_string_to_code(buffer);
- if (code)
- return (*result = code), true;
- return false;
- }
-
- /*
- Preprocess the LineBuffer into ASMLines. Change some state along the way.
-
- This function processes include directives, so read_source_file() may be
- called multiple times (along with the implications that has), and
- state->includes may be modified.
-
- On success, NULL is returned. On error, an ErrorInfo object is returned.
- state->lines and state->includes may still be modified.
- */
- ErrorInfo* preprocess(AssemblerState *state, const LineBuffer *source)
- {
- DEBUG("Running preprocessor:")
-
- ErrorInfo* ei;
- if ((ei = build_asm_lines(source, source, &state->lines, NULL,
- &state->includes)))
- return ei;
-
- ASMLine dummy = {.next = state->lines};
- ASMLine *prev, *line = &dummy, *next = state->lines, *condemned = NULL;
-
- const ASMLine *first_optimizer = NULL, *first_checksum = NULL,
- *first_product = NULL, *first_version = NULL,
- *first_region = NULL;
-
- while ((prev = line, line = next)) {
- next = line->next;
- if (line->data[0] == DIRECTIVE_MARKER) {
- if (IS_DIRECTIVE(line, DIR_ORIGIN))
- continue; // Origins are handled by tokenizer
-
- DEBUG("- handling directive: %.*s", (int) line->length, line->data)
-
- if (IS_DIRECTIVE(line, DIR_OPTIMIZER)) {
- REQUIRE_ARG(line, DIR_OPTIMIZER)
- bool arg;
- VALIDATE(parse_bool(&arg, line, DIR_OPTIMIZER, false))
- SAVE_ARG(line, first_optimizer, state->optimizer, arg)
- }
- else if (IS_DIRECTIVE(line, DIR_ROM_SIZE)) {
- // TODO
- // state->rom_size <-- value check
- }
- else if (IS_DIRECTIVE(line, DIR_ROM_HEADER)) {
- // TODO
- // state->header.offset <-- check in list of acceptable values
- }
- else if (IS_DIRECTIVE(line, DIR_ROM_CHECKSUM)) {
- REQUIRE_ARG(line, DIR_ROM_CHECKSUM)
- bool arg;
- VALIDATE(parse_bool(&arg, line, DIR_ROM_CHECKSUM, true))
- SAVE_ARG(line, first_checksum, state->header.checksum, arg)
- }
- else if (IS_DIRECTIVE(line, DIR_ROM_PRODUCT)) {
- REQUIRE_ARG(line, DIR_ROM_PRODUCT)
- uint32_t arg;
- VALIDATE(parse_uint32(&arg, line, DIR_ROM_PRODUCT))
- RANGE_CHECK(arg, 160000)
- SAVE_ARG(line, first_product, state->header.product_code, arg)
- }
- else if (IS_DIRECTIVE(line, DIR_ROM_VERSION)) {
- REQUIRE_ARG(line, DIR_ROM_VERSION)
- uint8_t arg;
- VALIDATE(parse_uint8(&arg, line, DIR_ROM_VERSION))
- RANGE_CHECK(arg, 0x10)
- SAVE_ARG(line, first_version, state->header.version, arg)
- }
- else if (IS_DIRECTIVE(line, DIR_ROM_REGION)) {
- REQUIRE_ARG(line, DIR_ROM_REGION)
- uint8_t arg;
- if (parse_uint8(&arg, line, DIR_ROM_REGION)) {
- RANGE_CHECK(arg, 0x10)
- VALIDATE(region_code_to_string(arg))
- } else {
- VALIDATE(parse_region_string(&arg, line))
- }
- SAVE_ARG(line, first_region, state->header.region, arg)
- }
- else if (IS_DIRECTIVE(line, DIR_ROM_DECLSIZE)) {
- // TODO
- // state->header.rom_size <-- value/range check
- }
- else {
- asm_lines_free(condemned);
- return error_info_create(line, ET_PREPROC, ED_PP_UNKNOWN);
- }
-
- // Remove directive from lines, and schedule it for deletion:
- line->next = condemned;
- condemned = line;
- prev->next = next;
- line = prev;
- }
- }
-
- // TODO: if giving rom size, check header offset is in rom size range
- // TODO: if giving reported and actual rom size, check reported is <= actual
-
- state->rom_size = 8; // TODO
-
- asm_lines_free(condemned);
- state->lines = dummy.next; // Fix list head if first line was a directive
-
- #ifdef DEBUG_MODE
- DEBUG("Dumping ASMLines:")
- const ASMLine *temp = state->lines;
- while (temp) {
- DEBUG("- %-40.*s [%s:%02zu]", (int) temp->length, temp->data,
- temp->filename, temp->original->lineno)
- temp = temp->next;
- }
- #endif
-
- return NULL;
- }
|