library.h

Go to the documentation of this file.

/*
 *  This file is part of SST/macroscale:
 *               The macroscale architecture simulator from the SST suite.
 *  Copyright (c) 2009 Sandia Corporation.
 *  This software is distributed under the BSD License.
 *  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
 *  the U.S. Government retains certain rights in this software.
 *  For more information, see the LICENSE file in the top
 *  SST/macroscale directory.
 */

#ifndef SSTMAC_SOFTWARE_LIBRARIES_LIBRARY_H_INCLUDED
#define SSTMAC_SOFTWARE_LIBRARIES_LIBRARY_H_INCLUDED

#include <sstmac/common/sst_event_fwd.h>
#include <sstmac/common/event_location.h>
#include <sstmac/software/process/key.h>
#include <sstmac/software/process/software_id.h>
#include <sstmac/software/process/operating_system_fwd.h>
#include <sstmac/software/libraries/library_fwd.h>
#include <sprockit/sim_parameters_fwd.h>
#include <map>


namespace sstmac {
namespace sw {

class library  {

 public:
  virtual void
  unregister_all_libs();

  virtual std::string
  to_string() const {
    return libname_;
  }

  virtual std::string
  lib_name() const {
    return libname_;
  }

  virtual void
  init_os(operating_system* os);

  virtual void
  consume_params(sprockit::sim_parameters* params);

  virtual void
  incoming_event(event* ev) = 0;

  operating_system*
  os() const {
    return os_;
  }

  software_id
  sid() const {
    return sid_;
  }

  virtual ~library();

 protected:
  library(const std::string& libname, software_id sid) :
    sid_(sid), libname_(libname), os_(0)
  {
  }

  library(const char* prefix, software_id sid) :
    sid_(sid), libname_(sprockit::printf("%s%s", prefix, sid.to_string().c_str())), os_(0)
  {
  }

  /**
   * This function is provided so that libraries can instantiate, register, and use other libraries.
   * @param lib the library to register
   */
  void
  register_lib(library* lib);

 protected:
  operating_system* os_;
  key::category key_cat_;
  software_id sid_;

 private:
  std::string libname_;

};

class blocking_library :
  public library
{
 protected:
  blocking_library(const char* prefix, software_id sid) :
    library(prefix, sid)
  {
  }

  blocking_library(const std::string& libname, software_id sid) :
    library(libname, sid)
  {
  }

  void wait_event(event* ev, key::category = key::general);

  virtual void
  incoming_event(event *ev);

 private:
  std::map<event*,key*> blocked_events_;

};


}
} //end of namespace sstmac

#endif