/*
 * Copyright (c) 2015, University of Kaiserslautern
 * 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.
 *
 * Authors:
 *    Janik Schlemminger
 *    Matthias Jung
 */

#ifndef CONTROLLER_STATE_H_
#define CONTROLLER_STATE_H_

#include <systemc.h>
#include "RowBufferStates.h"
#include "core/Slots.h"
#include "core/configuration/Configuration.h"
#include <map>
#include <set>
#include <list>

class ControllerState
{
public:
    ControllerState(std::string ownerName,
                    Configuration *config) : bus(config->memSpec.clk), ownerName(ownerName),
        config(config)
    {
        rowBufferStates = new RowBufferState(ownerName);
    }
    virtual ~ControllerState() {}

    const ScheduledCommand getLastCommand(Command command, Bank bank);
    const ScheduledCommand getLastCommand(Command command);
    const ScheduledCommand getLastScheduledCommand(Bank bank);
    const ScheduledCommand getLastScheduledCommand();

    void change(const ScheduledCommand &scheduledCommand);
    void cleanUp(sc_time time);

    RowBufferState *rowBufferStates;

    //used by the various checkers
    std::map<Command, std::map<Bank, ScheduledCommand> >
    lastScheduledByCommandAndBank;
    std::map<Command, ScheduledCommand> lastScheduledByCommand;
    std::map<Bank, ScheduledCommand> lastScheduledByBank;
    ScheduledCommand lastScheduled;

    Slots bus;
    std::vector<ScheduledCommand> lastDataStrobeCommands;
    std::map<sc_time, ScheduledCommand> lastActivates;
    std::map<sc_time, ScheduledCommand> lastActivatesB;

private:
    std::string ownerName;
    Configuration *config;
    void printDebugMessage(std::string message);
};

#endif /* CONTROLLER_STATE_H_ */

