src/mem/ruby/libruby.hh

   1
   2 #ifndef LIBRUBY_H
   3 #define LIBRUBY_H
   4
   5 #include <stdint.h>
   6 #include <ostream>
   7
   8 typedef void* RubyPortHandle;
   9 enum RubyRequestType {
  10   RubyRequestType_NULL,
  11   RubyRequestType_IFETCH,
  12   RubyRequestType_LD,
  13   RubyRequestType_ST,
  14   RubyRequestType_Locked_Read,
  15   RubyRequestType_Locked_Write,
  16   RubyRequestType_RMW_Read,
  17   RubyRequestType_RMW_Write,
  18   RubyRequestType_NUM
  19 };
  20
  21 enum RubyAccessMode {
  22   RubyAccessMode_User,
  23   RubyAccessMode_Supervisor,
  24   RubyAccessMode_Device
  25 };
  26
  27 struct RubyRequest {
  28   uint64_t paddr;
  29   uint8_t* data;
  30   int len;
  31   uint64_t pc;
  32   RubyRequestType type;
  33   RubyAccessMode access_mode;
  34   unsigned proc_id;
  35
  36   RubyRequest() {}
  37   RubyRequest(uint64_t _paddr, uint8_t* _data, int _len, uint64_t _pc, RubyRequestType _type, RubyAccessMode _access_mode, unsigned _proc_id = 100)
  38     : paddr(_paddr), data(_data), len(_len), pc(_pc), type(_type), access_mode(_access_mode), proc_id(_proc_id)
  39   {}
  40 };
  41
  42 std::ostream& operator<<(std::ostream& out, const RubyRequest& obj);
  43
  44 /**
  45  * Initialize the system.  cfg_file is a Ruby-lang configuration script
  46  */
  47 void libruby_init(const char* cfg_file);
  48
  49 /**
  50  * Tear down a configured system.  Must be invoked after a call to libruby_init.
  51  */
  52 void libruby_destroy();
  53
  54 /**
  55  * Print the last error encountered by ruby.  Currently unimplemented.
  56  */
  57 const char* libruby_last_error();
  58
  59 /**
  60  *  Retrieve a handle to a RubyPort object, identified by name in the
  61  *  configuration.  You also pass in the callback function you want
  62  *  this port to use when a request completes.  Only one handle to a
  63  *  port is allowed at a time.
  64  */
  65 RubyPortHandle libruby_get_port(const char* name, void (*hit_callback)(int64_t access_id));
  66
  67 /**
  68  *  Retrieve a handle to a RubyPort object, identified by name in the
  69  *  configuration.
  70  */
  71 RubyPortHandle libruby_get_port_by_name(const char* name);
  72
  73
  74 /**
  75  * libruby_issue_request error return codes
  76  */
  77 #define LIBRUBY_BUFFER_FULL -2
  78 #define LIBRUBY_ALIASED_REQUEST -3
  79
  80 /**
  81  * issue_request returns a unique access_id to identify the ruby
  82  * transaction. This access_id is later returned to the caller via
  83  * hit_callback (passed to libruby_get_port)
  84  */
  85 int64_t libruby_issue_request(RubyPortHandle p, struct RubyRequest request);
  86
  87 /**
  88  * writes data directly into Ruby's data array.  Note that this
  89  * ignores caches, and should be considered incoherent after
  90  * simulation starts.
  91  */
  92 void libruby_write_ram(uint64_t paddr, uint8_t * data, int len);
  93
  94 /**
  95  * reads data directory from Ruby's data array.  Note that this
  96  * ignores caches, and should be considered incoherent after
  97  * simulation starts
  98  */
  99 void libruby_read_ram(uint64_t paddr, uint8_t * data, int len);
 100
 101 /**
 102  * tick the system n cycles.  Eventually, will return the number of
 103  * cycles until the next event, but for now it always returns 0
 104  */
 105 int libruby_tick(int n);
 106
 107 /**
 108  *  self explainitory
 109  */
 110 void libruby_print_config(std::ostream & out);
 111
 112 /**
 113  * self explainitory
 114  */
 115 void libruby_print_stats(std::ostream & out);
 116
 117 /**
 118  * does not return until done
 119  */
 120 void libruby_playback_trace(char * trace_filename);
 121
 122 /*
 123  * enables the tracer and opens the trace file
 124  */
 125 void libruby_start_tracing(char * record_filename);
 126
 127 /*
 128  * closes the trace file
 129  */
 130 void libruby_stop_tracing();
 131
 132 /**
 133  * get time
 134  */
 135 uint64_t libruby_get_time();
 136 #endif