1/*
2 * Copyright (c) 2015 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software

--- 21 unchanged lines hidden (view full) ---

30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Gabor Dozsa
38 * Mohammad Alian
39 */
40
41/* @file
42 * TCP stream socket based interface class for dist-gem5 runs.
43 *
44 * For a high level description about dist-gem5 see comments in
45 * header file dist_iface.hh.
46 *
47 * Each gem5 process connects to the server (another gem5 process which
48 * simulates a switch box) via a stream socket. The server process
49 * transfers messages and co-ordinates the synchronisation among the gem5
50 * peers.
51 */
52#ifndef __DEV_NET_TCP_IFACE_HH__
53#define __DEV_NET_TCP_IFACE_HH__
54
55
56#include <string>
57
58#include "dev/net/dist_iface.hh"
59
60class EventManager;
61
62class TCPIface : public DistIface
63{
64 private:
65 /**
66 * The stream socket to connect to the server.
67 */
68 int sock;
69
70 std::string serverName;
71 int serverPort;
72
73 bool isSwitch;
74
75 bool listening;
76 static bool anyListening;
77 static int fdStatic;
78
79 /**
80 * Compute node info and storage for the very first connection from each
81 * node (used by the switch)
82 */
83 struct NodeInfo
84 {
85 unsigned rank;
86 unsigned distIfaceId;
87 unsigned distIfaceNum;
88 };
89 static std::vector<std::pair<NodeInfo, int> > nodes;
90 /**
91 * Storage for all opened sockets
92 */
93 static std::vector<int> sockRegistry;
94
95 private:
96
97 /**
98 * Send out a message through a TCP stream socket.
99 *
100 * @param sock TCP stream socket.
101 * @param buf Start address of the message.
102 * @param length Size of the message in bytes.
103 */
104 void
105 sendTCP(int sock, const void *buf, unsigned length);
106
107 /**
108 * Receive the next incoming message through a TCP stream socket.
109 *
110 * @param sock TCP stream socket.
111 * @param buf Start address of buffer to store the message.
112 * @param length Exact size of the expected message in bytes.
113 */
114 bool recvTCP(int sock, void *buf, unsigned length);
115 bool listen(int port);
116 void accept();
117 void connect();
118 int getfdStatic() const { return fdStatic; }
119 bool islistening() const { return listening; }
120 bool anyislistening() const { return anyListening; }
121 void establishConnection();
122
123 protected:
124
125 void sendPacket(const Header &header,
126 const EthPacketPtr &packet) override;
127
128 void sendCmd(const Header &header) override;
129
130 bool recvHeader(Header &header) override;
131
132 void recvPacket(const Header &header, EthPacketPtr &packet) override;
133
134 void initTransport() override;
135
136 public:
137 /**
138 * The ctor creates and connects the stream socket to the server.
139 * @param server_name The name (or IP address) of the host running the
140 * server process.
141 * @param server_port The port number the server listening for new
142 * connections.
143 * @param sync_start The tick for the first dist synchronisation.
144 * @param sync_repeat The frequency of dist synchronisation.
145 * @param em The EventManager object associated with the simulated
146 * Ethernet link.
147 */
148 TCPIface(std::string server_name, unsigned server_port,
149 unsigned dist_rank, unsigned dist_size,
150 Tick sync_start, Tick sync_repeat, EventManager *em,
151 bool is_switch, int num_nodes);
152
153 ~TCPIface() override;
154};
155
156#endif // __DEV_NET_TCP_IFACE_HH__