/*******************************************************************************
 * Copyright (C) 2017, 2018, MINRES Technologies GmbH
 * 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.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * 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 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 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 DAMAGE.
 *
 * Contributors:
 *       eyck@minres.com - initial API and implementation
 ******************************************************************************/

#ifndef _ISS_PLUGIN_COV_H_
#define _ISS_PLUGIN_COV_H_

#include <iss/vm_plugin.h>
#include "iss/instrumentation_if.h"
#include <json/json.h>
#include <string>
#include <fstream>


namespace iss {
namespace plugin {
class lz4compress_steambuf;
class cov : public iss::vm_plugin {
    struct instr_delay {
        std::string instr_name;
        size_t size;
        size_t not_taken_delay;
        size_t taken_delay;
    };
    BEGIN_BF_DECL(instr_desc, uint32_t)
        BF_FIELD(taken, 24, 8)
        BF_FIELD(not_taken, 16, 8)
        BF_FIELD(is_branch, 8, 8)
        BF_FIELD(size, 0, 8)
        instr_desc(uint32_t size, uint32_t taken, uint32_t not_taken, bool branch): instr_desc() {
            this->size=size;
            this->taken=taken;
            this->not_taken=not_taken;
            this->is_branch=branch;
        }
    END_BF_DECL();

public:

    cov(const cov &) = delete;

    cov(const cov &&) = delete;

    cov(std::string const &);

    virtual ~cov();

    cov &operator=(const cov &) = delete;

    cov &operator=(const cov &&) = delete;

    bool registration(const char *const version, vm_if &arch) override;

    sync_type get_sync() override { return POST_SYNC; };

    void callback(instr_info_t, exec_info const&) override;

private:
    iss::instrumentation_if *instr_if  {nullptr};
    std::ofstream output;
#ifdef WITH_LZ4
    std::unique_ptr<lz4compress_steambuf> strbuf;
    std::ostream ostr;
#endif
    std::string filename;
    std::vector<instr_desc> delays;
    bool jumped{false}, first{true};
};
}
}

#endif /* _ISS_PLUGIN_COV_H_ */