fleece.C

/*
 * See fleece/COPYRIGHT for copyright information.
 *
 * This file is a part of Fleece.
 *
 * Fleece is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 3.0 of the License, or (at your option)
 * any later version.
 *  
 * This software is distributed in the hope that it will be useful, but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this software; if not, see www.gnu.org/licenses
*/

#include "fleece.h"

void signalHandler(int sig) {
    if (sig == SIGSEGV) {
        std::cerr << "SEGFAULT\n";
    }
    if (sig == SIGABRT) {
        std::cerr << "ABORT\n";
    }
    Decoder::printErrorStatus();
    exit(-1);
}

int main(int argc, char** argv) {

    signal(SIGSEGV, &signalHandler);
    signal(SIGABRT, &signalHandler);

    /***********************************************************************/
    /*                     PARSING COMMAND LINE ARGS                       */
    /***********************************************************************/

    Options::parse(argc, argv);

    // The user selected the "-help" option, so print help and exit.
    if (Options::get("--help") != NULL || Options::get("-h") != NULL) {
        Info::printOptions();
        exit(0);
    }

    // The user selected the "-version" option, so print the version and exit.
    if (Options::get("--version") != NULL || Options::get("-v") != NULL) {
        Info::printVersion();
        exit(0);
    }
   
    // Should output from decoders be normalized before use?
    bool norm     = (Options::get("-no-norm")  == NULL);

    // Should the input method be random bytes with an (optional) mask?
    bool random   = (Options::get("-rand")  != NULL);

    // Should the raw bytes of an insn be printed right before decoding?
    bool showInsn = (Options::get("-bytes") != NULL);

    // Seed the random number generator with the time or a provided seed.
    const char* strSeed = Options::get("-seed=");
    if (strSeed == NULL) {
        int seed = time(NULL);
        std::cout << "Seed = " << seed << "\n";
        srand(seed);
    } else {
        srand(strtoul(strSeed, NULL, 10));
    }

    // Check which architecture was specified.
    const char* archStr = Options::get("-arch=");
    if (!archStr) {
        std::cerr << "FLEECE FATAL: Must specify architecture!\n";
        exit(1);
    }
    
    // Initialize the architecture with the command line name.
    Architecture::init(archStr);

    // Determine the instruction length. The default value is 15 bytes.
    unsigned long insnLen = Architecture::getMaxInsnLen();
    
    // Check which decoders were specified.
    const char* decStr = Options::get("-decoders=");
    // If there were no valid decoders with the architecture, print all decoder
    // and architecture pairs and continue.
    if (decStr == NULL) {
        std::cout << "FLEECE FATAL: Must specify decoders.\n"; 
        std::cout << "Valid options are:\n";
        Decoder::printAllNames();
        exit(0);
    }

    // The Decoder class has a static method to match architecture and decoder
    // strings.
    std::vector<Decoder*> decoders = Decoder::getDecoders(archStr, decStr);
    size_t decCount = decoders.size();
   
    // If there were no valid decoders with the architecture, print all decoder
    // and architecture pairs and continue.
    if (decCount == 0) {
        std::cout << "FLEECE FATAL: No valid decoders for this architecture.\n"; 
        std::cout << "Valid options are:\n";
        Decoder::printAllNames();
        exit(0);
    }

    // Verify that the user has provided a byte source or specified a number of
    // random instruction.
    unsigned long nRuns = 0;
    const char* strRuns = Options::get("-n=");
    if (strRuns == NULL) {
        std::cout << "FLEECE FATAL: Need \"-n=<# of insns>\"\n";
        exit(0);
    } else {
        nRuns = strtoul(strRuns, NULL, 10);
    }

    // Get the specified output file
    const char* outputDir = Options::get("-o=");
    if (outputDir == NULL) {
        outputDir = "fleece_results";
    }
    int rc = mkdir(outputDir, DIR_ACCESS_PERMS);
    if (rc != 0) {
        if (errno != EEXIST) {
            std::cerr << "FLEECE FATAL: Cannot create output directory:"
                    << outputDir << "\n";
            exit(-1);
        }
    }

    // If the user passes in a mask value, read that in now.
    const char* strMask = Options::get("-mask=");
    bool hasMask = (strMask != NULL);
    Mask* mask = NULL;

    // The mask constructor will do all of the necessary string parsing.
    if (hasMask) {
        mask = new Mask(strMask);
    }

    /************************************************************************/
    /*                   END OF COMMAND LINE ARG PARSING                    */
    /************************************************************************/

    // We'll be needing these, trust me (loop vars).
    unsigned long i, j;

    // Allocate a starting instruction and a temporary instruction to be used
    // during decoding.
    char* baseInsn = (char*)malloc(insnLen);
    char* tempInsn = (char*)malloc(insnLen);

    assert(baseInsn != NULL && tempInsn != NULL);

    // Allocate buffers for the output from each of the decoders.
    char** decBufs = (char**)malloc(decCount * sizeof(char*));
    assert(decBufs != NULL && "Could not allocate decoder buffers!");

    for (size_t i = 0; i < decCount; i++) {
        decoders[i]->setNorm(norm);
        decBufs[i] = (char*)malloc(DECODED_BUFFER_LEN);
        assert(decBufs[i] != NULL && "Could not allocate decoder buffer!");
    }
    
    // Instantiate a reporting context with the chosen output file.
    ReportingContext* repContext = new ReportingContext(outputDir, FLUSH_FREQ);
    assert(repContext != NULL && "Reporting context should not be null!");
    
    // Create reporting directories.
    for (size_t i = 0; i < decCount; i++) { 
        repContext->addDecoder(decoders[i]->getName());
        char dirBuf[REPORT_FILENAME_BUF_LEN];
        snprintf(dirBuf, REPORT_FILENAME_BUF_LEN, "%s/%s", outputDir, \
                decoders[i]->getName());
        int rc = mkdir(dirBuf, DIR_ACCESS_PERMS);
        if (rc != 0) {
            if (errno != EEXIST) {
                std::cerr << "FLEECE FATAL: Cannot create output directory:"
                        << dirBuf << "\n";
                exit(-1);
            }
        }
    }

    // Create a map as a counter for all of the seen formats when queuing new
    // instructions.
    std::map<char*, int, StringUtils::str_cmp> seenMap;
    std::queue<char*> remainingInsns;

    if (!random) {
        for (i = 0; i < nRuns; i++) {
            // Create an initial random instructions for the queue.
            randomizeBuffer(baseInsn, insnLen);

            // Push the random instruction onto the queue.
            remainingInsns.push(baseInsn);
            baseInsn = (char*)malloc(insnLen);
        }
    }

    // Record the time reported and report stats to std::cout regularly.
    unsigned long firstTime = time(NULL);
    unsigned long lastTime = firstTime;

    // The current instruction in the loop.
    char* curInsn = NULL;

    if (random) {
        curInsn = (char*)malloc(insnLen);
    }

    size_t nFormatsSeen = 0;

    i = 0;

    while ((!random && !remainingInsns.empty()) || (random && i < nRuns)) {
        ++i;

        // If it has been 10 seconds, output a new line to std::cerr with data.
        unsigned long newTime = time(NULL);

        if (newTime >= lastTime + 10) {
            lastTime = newTime;
         
            // Output instructions decoded and summary of reporting done.
            std::cout << "Num Insns Tested: " << i << "\n";
            std::cout << "Num Insns To Test: " << remainingInsns.size() << ", ";
            repContext->printSummary(stdout);

            //if (i > 1) exit(-1);

        }

        // Get the next instruction.
        if (random) {

            size_t curOptional = 4;
            while (curOptional > 2) {
                curOptional = 0;
                // Fill the buffer then apply the mask.
                randomizeBuffer(curInsn, insnLen);
                for (j = 0; j < decCount; j++) {
                    Decoder* dec = decoders[j];
                    Assembly insnAsm = Assembly(curInsn, insnLen, dec);
                    if (!insnAsm.isError()) {
                        size_t nBytesUsed = MappedInsn::findNumBytesUsed(curInsn, insnLen, dec);
                        size_t nOptional = 0;
                        for (size_t k = 0; k < nBytesUsed; ++k) {
                            if (MappedInsn::isByteOptional(dec, curInsn, nBytesUsed, k, (FieldList*)insnAsm.getFields())) {
                                ++nOptional;
                            }
                        }
                        if (nOptional > curOptional) {
                            curOptional = nOptional;
                        }
                    }
                }
            }
            
            bool formatStrSeen = true;
            for (j = 0; j < decCount; ++j) {
                Assembly insnAsm = Assembly(curInsn, insnLen, decoders[j]);
                if (!insnAsm.isError()) {
                    char* insnFormatStr = strdup(insnAsm.getTemplate());
                    if (seenMap.insert(std::make_pair(insnFormatStr, 1)).second) {
                        formatStrSeen = false;
                    } else {
                        free(insnFormatStr);
                    }
                }
            }

            if (!formatStrSeen) {
                ++nFormatsSeen;
            }
        
        } else {
         
        // If insns are not random, take them from the queue.
        curInsn = remainingInsns.front();
        remainingInsns.pop();
        }
        if (hasMask) {
            mask->apply(curInsn, insnLen);
            mask->increment();
        }

        // If the user selected to see the instruction before decode, print it
        // now.
        if (showInsn) {
            printByteBuffer(std::cout, curInsn, insnLen);
            std::cout << std::endl;
        }

        if (!random) {

            // If the input is non-random, we need to add to the queue now.
            MappedInsn* mInsn;

            for (size_t j = 0; j < decCount; j++) {
            
                // Each decoder maps the instruction and uses its
                // map to try to find new inputs to add to the queue.
                mInsn = new MappedInsn(curInsn, insnLen, decoders[j]);
                mInsn->queueNewInsns(&remainingInsns, &seenMap, decoders);
                delete mInsn;
            }
        }
        
        std::vector<Assembly*> asmList;

        // Use each decoder to decode the instruction.
        for (j = 0; j < decCount; j++) {
            asmList.push_back(new Assembly(curInsn, insnLen, decoders[j]));
        }

        // Process the resulting decoding and report it if necessary
        repContext->processDecodings(asmList);

        // If the instruction was from the queue, it was malloced at somepoint
        // and we need to free it.
        free(curInsn);
    }

    // Print a summary at the end of execution.
    repContext->printSummary(stdout);
    std::cout << "Num. Formats seen: " << nFormatsSeen << "\n";

    delete repContext;
    
    if (hasMask) {
        delete mask;
    }

    for (size_t i = 0; i < decCount; i++) {
        free(decBufs[i]);
    }
    free(decBufs); 

    if (!random) {
        free(baseInsn);
    }
    free(tempInsn);
   
    Options::destroy();
    return 0;
}