orcasim::models::hermes::HermesRouter Class Reference

#include <HermesRouter.hpp>

Inheritance diagram for orcasim::models::hermes::HermesRouter:

Public Member Functions
uint32_t	GetRR ()
Buffer< FlitType > *	GetOutputBuffer (uint32_t p)
	Get a pointer to one of the output buffers. More...
Buffer< FlitType > *	GetInputBuffer (uint32_t p)
void	SetOutputBuffer (Buffer< FlitType > *b, uint32_t port)
SimulationTime	Run ()
	Implementation of the Process' interface. More...
uint32_t	GetRouteXY (FlitType flit)
	return this More...
	HermesRouter (std::string name, uint32_t x_pos, uint32_t y_pos)
	Ctor. More...
	~HermesRouter ()
	Dtor. More...
std::string	GetPortName (int port)
	Get the name of the port of id equals to <port> More...
void	Reset ()
	Resets the instance to its starting state. More...
std::string	ToString ()
a name that identifies the model, advisably not empty.
Default ctor.
std::string	GetName ()
	Getter method for the <_name> field. More...
void	SetName (std::string s)
	Setter method for the <_name> field. More...

Private Attributes
int16_t	_switch_control [5]
int16_t	_flits_to_send [5]
uint32_t	_round_robin
uint32_t	_x
uint32_t	_y
Buffer< FlitType > *	_ob [5]
Buffer< FlitType > *	_ib [5]

Detailed Description

Definition at line 61 of file HermesRouter.hpp.

Constructor & Destructor Documentation

HermesRouter()

HermesRouter::HermesRouter	(	std::string	name,
		uint32_t	x_pos,
		uint32_t	y_pos
	)

Ctor.

Parameters

name	Name of the instance (proccess impl)
x_pos	X coordinate (first part of router addr)
y_pos	Y coordinate (second part of router addr)

Definition at line 57 of file HermesRouter.cpp.

                                                                        :
    TimedModel(name) {
    _x = x_pos;
    _y = y_pos;

    // for all ports, create a new input buffer; Note that data is bufferred by
    // input buffers, since output buffers come from somewhere else;
    for (int i = 0; i < 5; i++) {
        std::string bname = GetName() +  ".IN-" + this->GetPortName(i);
        _ob[i] = nullptr;
        _ib[i] = new Buffer<FlitType>(bname, BUFFER_CAPACITY);
    }

    #ifdef ROUTER_ENABLE_COUNTERS
    // if counters are enabled, initiate the respective signals
    // please note that these signals are not mapped to anywhere yet
    _counter_active = new Signal<uint32_t>(GetName() + ".counters.active");
    #endif

    this->Reset();
}

~HermesRouter()

HermesRouter::~HermesRouter

(

)

Dtor.

Free allocated memory if any.

Definition at line 82 of file HermesRouter.cpp.

                            {
    #ifdef ROUTER_ENABLE_COUNTERS
    delete _counter_active;
    #endif

    for (int i = 0; i < 5; i++)
        delete(_ib[i]);
}

Member Function Documentation

GetInputBuffer()

Buffer< FlitType > * HermesRouter::GetInputBuffer

(

uint32_t

p

)

Definition at line 241 of file HermesRouter.cpp.

                                                         {
    return _ib[r];
}

GetName()

std::string Model::GetName ( )

inherited

Getter method for the <_name> field.

Definition at line 34 of file Model.cpp.

                         {
    return _name;
}

GetOutputBuffer()

Buffer< FlitType > * HermesRouter::GetOutputBuffer

(

uint32_t

r

)

Get a pointer to one of the output buffers.

Parameters

r	The port from which get the pointer.

Returns

A pointer to the buffer.

Definition at line 237 of file HermesRouter.cpp.

                                                          {
    return _ob[r];
}

GetPortName()

std::string HermesRouter::GetPortName

(

int

port

)

Get the name of the port of id equals to <port>

Parameters

port	the id of the port

Returns

and instance of std::string containing port's name

Definition at line 41 of file HermesRouter.cpp.

                                            {
    switch (port) {
        case SOUTH: return "SOUTH";
        case NORTH: return "NORTH";
        case WEST:  return "WEST";
        case EAST:  return "EAST";
        default: return "LOCAL";
    }
    return "???";
}

GetRouteXY()

uint32_t HermesRouter::GetRouteXY

(

FlitType

flit

)

return this

Calculate the port to route a given flit.

Parameters

flit	to be routed

Returns

the port to where te packet must go

Definition at line 214 of file HermesRouter.cpp.

                                               {
    FlitType tx = (flit & 0x00F0) >> 4;
    FlitType ty = flit & 0x000F;

    // if X=0, then route "vertically" (Y)
    if (_x == tx) {
        return (_y == ty)
            ? LOCAL
            : (_y > ty)
                ? SOUTH
                : NORTH;
    // route X
    } else {
        return (_x > tx)
            ? WEST
            : EAST;
    }
}

GetRR()

uint32_t HermesRouter::GetRR

(

)

Definition at line 102 of file HermesRouter.cpp.

                             {
    return _round_robin;
}

Reset()

void HermesRouter::Reset ( )

virtual

Resets the instance to its starting state.

Must be implemented by subclasses

Implements orcasim::base::TimedModel.

Definition at line 91 of file HermesRouter.cpp.

                         {
    _round_robin = LOCAL;  // starts checking on local port

    for (int i = 0; i < 5; i++) {
        _flits_to_send[i] = 0;
        _switch_control[i] = -1;
    }

    // TODO(ad): reset buffers
}

Run()

SimulationTime HermesRouter::Run ( )

virtual

Implementation of the Process' interface.

Implementation of the Run method from the Proccess abstract class.

Returns

time taken for perming next cycle

The next time to schedule the event.

Implements orcasim::base::TimedModel.

Definition at line 110 of file HermesRouter.cpp.

                                 {
    // CROSSBAR CONTROL: connect priority port to destination if it has any
    // packet to send but is waiting for the destination to free
    if (_ib[_round_robin]->size() > 0 && _switch_control[_round_robin] == -1) {
        // find the destination using the address in the first flit
        uint8_t target_port = this->GetRouteXY(_ib[_round_robin]->top());

        // check whether the destination port is bound to some other source port
        bool bound = false;

        for (int i = 0; i < 5; i++) {
            if (_switch_control[i] == target_port) {
                bound = true;
                break;
            }
        }

        // if the port is not bind, binds it to the source
        if (!bound) {
            // set crossbar connection
            _switch_control[_round_robin] = target_port;
            // -2 means "the size flit has not arrived yet"
            _flits_to_send[_round_robin] = -2;
        }
      }

    // drive flits into destination ports
    for (int i = 0; i < 5; i++) {
        // check whether the switch control is closed for some port
        if (_switch_control[i] != -1) {
            // prevent routing to a non-existing router
            #ifdef ROUTER_PORT_CONNECTED_CHECKING
            if (_ob[_switch_control[i]] == nullptr) {
                stringstream ss;
                ss << this->GetName() << ": unable to route to unknown port"
                    << std::endl;
                std::runtime_error(ss.str());
            }

            if (_ib[i] == nullptr) {
                stringstream ss;
                ss << this->GetName() << ": unable to route from unknown port"
                    << std::endl;
                std::runtime_error(ss.str());
            }
            #endif
            // check whether the output is able to receive new flits.
            // buffer must have some room
            if (!_ob[_switch_control[i]]->full() && _ib[i]->size() > 0) {
                // if -2, we send the address flit
                if (_flits_to_send[i] == -2) {
                    // push one flit to destination port
                    _ob[_switch_control[i]]->push(_ib[i]->top());
                    _flits_to_send[i] = -1;
                    _ib[i]->pop();  // remove flit from source port

                // if -1, we set the size flit and send it
                } else if (_flits_to_send[i] == -1) {
                    _flits_to_send[i] = _ib[i]->top();
                     // push one flit to destination port
                    _ob[_switch_control[i]]->push(_ib[i]->top());
                    _ib[i]->pop();  // remove flit from source port

                } else {
                    _flits_to_send[i] -= 1;
                     // push one flit to destination port
                    _ob[_switch_control[i]]->push(_ib[i]->top());
                    _ib[i]->pop();  // remove flit from source port
                }

                #ifdef ROUTER_ENABLE_COUNTERS
                _is_active = true;
                #endif

                // free port
                if (_flits_to_send[i] == 0)
                    _switch_control[i] = -1;
            }
        }
    }

    // round robin update
    _round_robin = (_round_robin + 1) % 5;

    #ifdef ROUTER_ENABLE_COUNTERS
    if (is_active) {
        _counter_active->Inc(1);
        _is_active = false;
    }
    #endif
    return 1;
}

SetName()

void Model::SetName ( std::string  s )

inherited

Setter method for the <_name> field.

Parameters

s	Value to be set

Definition at line 38 of file Model.cpp.

                                        {
    _name = name;
}

SetOutputBuffer()

void HermesRouter::SetOutputBuffer	(	Buffer< FlitType > *	b,
		uint32_t	port
	)

Definition at line 245 of file HermesRouter.cpp.

                                                                     {
    _ob[port] = b;
}

ToString()

std::string HermesRouter::ToString

(

)

Definition at line 249 of file HermesRouter.cpp.

                                 {
    std::stringstream ss;
    ss << this->GetName() + ": ";

    for (int i = 0; i < 5; i++) {
        if (_ob[i] != nullptr)
            ss << "{" << _ob[i]->GetName() << "} ";
    }

    return ss.str();
}

Member Data Documentation

_flits_to_send

int16_t orcasim::models::hermes::HermesRouter::_flits_to_send[5]

private

Definition at line 78 of file HermesRouter.hpp.

_ib

Buffer<FlitType>* orcasim::models::hermes::HermesRouter::_ib[5]

private

Definition at line 90 of file HermesRouter.hpp.

_ob

Buffer<FlitType>* orcasim::models::hermes::HermesRouter::_ob[5]

private

Definition at line 87 of file HermesRouter.hpp.

_round_robin

uint32_t orcasim::models::hermes::HermesRouter::_round_robin

private

Definition at line 81 of file HermesRouter.hpp.

_switch_control

int16_t orcasim::models::hermes::HermesRouter::_switch_control[5]

private

Definition at line 75 of file HermesRouter.hpp.

_x

uint32_t orcasim::models::hermes::HermesRouter::_x

private

Definition at line 84 of file HermesRouter.hpp.

_y

uint32_t orcasim::models::hermes::HermesRouter::_y

private

Definition at line 84 of file HermesRouter.hpp.

---

The documentation for this class was generated from the following files:

• models/hermes-router/include/HermesRouter.hpp
• models/hermes-router/src/HermesRouter.cpp