/*
 * Copyright (c) 2002-2004 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * 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;
 * neither the name of the copyright holders 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
 * OWNER 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.
 */

#ifndef __SYSTEM_HH__
#define __SYSTEM_HH__

#include <string>
#include <vector>

#include "base/loader/symtab.hh"
#include "base/statistics.hh"
#include "cpu/pc_event.hh"
#include "kern/system_events.hh"
#include "sim/sim_object.hh"
#include "sim/sw_context.hh"

class MemoryController;
class PhysicalMemory;
class Platform;
class RemoteGDB;
class GDBListener;

class ExecContext;

class System : public SimObject
{
    // lisa's binning stuff
  private:
    std::map<const std::string, Stats::MainBin *> fnBins;
    std::map<const Addr, SWContext *> swCtxMap;

  protected:
    std::vector<FnEvent *> fnEvents;

  public:
    Stats::Scalar<> fnCalls;
    Stats::MainBin *Kernel;
    Stats::MainBin *User;

    Stats::MainBin * getBin(const std::string &name);
    bool findCaller(std::string, std::string) const;

    SWContext *findContext(Addr pcb);
    bool addContext(Addr pcb, SWContext *ctx) {
        return (swCtxMap.insert(make_pair(pcb, ctx))).second;
    }
    void remContext(Addr pcb) {
        swCtxMap.erase(pcb);
        return;
    }
    void dumpState(ExecContext *xc) const;

    virtual void serialize(std::ostream &os);
    virtual void unserialize(Checkpoint *cp, const std::string &section);


  private:
    std::multimap<const std::string, std::string> callerMap;
    void populateMap(std::string caller, std::string callee);
//

  public:
    const uint64_t init_param;
    MemoryController *memCtrl;
    PhysicalMemory *physmem;
    Platform *platform;
    bool bin;
    std::vector<string> binned_fns;

    PCEventQueue pcEventQueue;

    std::vector<ExecContext *> execContexts;

    std::string readfile;

    virtual int registerExecContext(ExecContext *xc);
    virtual void replaceExecContext(int xcIndex, ExecContext *xc);

  public:
    System(const std::string _name, const uint64_t _init_param,
           MemoryController *, PhysicalMemory *, const bool,
           const std::vector<string> &binned_fns);
    ~System();

    virtual Addr getKernelStart() const = 0;
    virtual Addr getKernelEnd() const = 0;
    virtual Addr getKernelEntry() const = 0;
    virtual bool breakpoint() = 0;

  public:
    ////////////////////////////////////////////
    //
    // STATIC GLOBAL SYSTEM LIST
    //
    ////////////////////////////////////////////

    static std::vector<System *> systemList;
    static int numSystemsRunning;

    static void printSystems();
};

#endif // __SYSTEM_HH__