1*91df013fSAsim Jamshed<!-- Creator     : groff version 1.22.2 -->
2*91df013fSAsim Jamshed<!-- CreationDate: Wed Feb  1 23:55:12 2017 -->
3*91df013fSAsim Jamshed<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4*91df013fSAsim Jamshed"http://www.w3.org/TR/html4/loose.dtd">
5*91df013fSAsim Jamshed<html>
6*91df013fSAsim Jamshed<head>
7*91df013fSAsim Jamshed<meta name="generator" content="groff -Thtml, see www.gnu.org">
8*91df013fSAsim Jamshed<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
9*91df013fSAsim Jamshed<meta name="Content-Style" content="text/css">
10*91df013fSAsim Jamshed<style type="text/css">
11*91df013fSAsim Jamshed       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
12*91df013fSAsim Jamshed       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
13*91df013fSAsim Jamshed       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
14*91df013fSAsim Jamshed       h1      { text-align: center }
15*91df013fSAsim Jamshed</style>
16*91df013fSAsim Jamshed<title>mtcp_init_rss</title>
17*91df013fSAsim Jamshed
18*91df013fSAsim Jamshed</head>
19*91df013fSAsim Jamshed<body>
20*91df013fSAsim Jamshed
21*91df013fSAsim Jamshed<h1 align="center">mtcp_init_rss</h1>
22*91df013fSAsim Jamshed
23*91df013fSAsim Jamshed<a href="#NAME">NAME</a><br>
24*91df013fSAsim Jamshed<a href="#SYNOPSIS">SYNOPSIS</a><br>
25*91df013fSAsim Jamshed<a href="#DESCRIPTION">DESCRIPTION</a><br>
26*91df013fSAsim Jamshed<a href="#RETURN VALUE">RETURN VALUE</a><br>
27*91df013fSAsim Jamshed<a href="#NOTES">NOTES</a><br>
28*91df013fSAsim Jamshed<a href="#ERRORS">ERRORS</a><br>
29*91df013fSAsim Jamshed<a href="#NOTES">NOTES</a><br>
30*91df013fSAsim Jamshed<a href="#AUTHORS">AUTHORS</a><br>
31*91df013fSAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br>
32*91df013fSAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br>
33*91df013fSAsim Jamshed
34*91df013fSAsim Jamshed<hr>
35*91df013fSAsim Jamshed
36*91df013fSAsim Jamshed
37*91df013fSAsim Jamshed<h2>NAME
38*91df013fSAsim Jamshed<a name="NAME"></a>
39*91df013fSAsim Jamshed</h2>
40*91df013fSAsim Jamshed
41*91df013fSAsim Jamshed
42*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_init_rss
43*91df013fSAsim Jamshed&minus; initialize RSS-based NIC-queue-to-TCP-port numbers
44*91df013fSAsim Jamshedmapping pool</p>
45*91df013fSAsim Jamshed
46*91df013fSAsim Jamshed<h2>SYNOPSIS
47*91df013fSAsim Jamshed<a name="SYNOPSIS"></a>
48*91df013fSAsim Jamshed</h2>
49*91df013fSAsim Jamshed
50*91df013fSAsim Jamshed
51*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
52*91df013fSAsim Jamshed&lt;mtcp_api.h&gt;</b></p>
53*91df013fSAsim Jamshed
54*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
55*91df013fSAsim Jamshedmtcp_init_rss(mctx_t</b> <i>mctx</i><b>, in_addr_t</b>
56*91df013fSAsim Jamshed<i>srcip</i><b>, int</b> <i>num_addr</i><b>, in_addr_t</b>
57*91df013fSAsim Jamshed<i>dstip</i><b>, in_addr_t</b> <i>dport</i><b>);</b></p>
58*91df013fSAsim Jamshed
59*91df013fSAsim Jamshed<h2>DESCRIPTION
60*91df013fSAsim Jamshed<a name="DESCRIPTION"></a>
61*91df013fSAsim Jamshed</h2>
62*91df013fSAsim Jamshed
63*91df013fSAsim Jamshed
64*91df013fSAsim Jamshed
65*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_init_rss</b>()
66*91df013fSAsim Jamshedcreates a pool of TCP source ports that can be used by a
67*91df013fSAsim Jamshedclient to generate outgoing connections for an arbitrary
68*91df013fSAsim Jamshedtuple of &lt; <i>srcip, dstip,</i> and, <i>dport</i> &gt;
69*91df013fSAsim Jamshedwhere ( <i>srcip</i> = source IPv4 address, <i>dstip</i> =
70*91df013fSAsim Jamsheddestination IPv4 address, and <i>dport</i> = destination
71*91df013fSAsim Jamshedport number respectively). Choosing the appropriate set of
72*91df013fSAsim Jamshedsource ports for each mTCP context, <i>mctx</i> (running on
73*91df013fSAsim Jamshedeach CPU) is important for connecting to peer TCP endpoints:
74*91df013fSAsim JamshedmTCP relies on the underlying symmetric RSS-based hash
75*91df013fSAsim Jamshedalgorithm (based on Toeplitz function) to read traffic from
76*91df013fSAsim JamshedNIC hardware queues. This function ensures that all packets,
77*91df013fSAsim Jamshedirrespective of the flow direction, are processed in the
78*91df013fSAsim Jamshedsame CPU core.</p>
79*91df013fSAsim Jamshed
80*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Please note
81*91df013fSAsim Jamshedthat <b>mtcp_init_rss()</b> assumes that the CPU core-id (as
82*91df013fSAsim Jamshedset inside <i>mctx</i> structure) will be used as the value
83*91df013fSAsim Jamshedfor NIC queue-id, which the mTCP context will eventually
84*91df013fSAsim Jamshedaccess during its operation. For example, mTCP context
85*91df013fSAsim Jamshedrunning on core 3 will read traffic from NIC hardware
86*91df013fSAsim Jamshedqueue-id 3.</p>
87*91df013fSAsim Jamshed
88*91df013fSAsim Jamshed
89*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><i>num_addr</i>
90*91df013fSAsim Jamshedis a reserved argument whose value should be set to 1 for
91*91df013fSAsim Jamshedthe time being.</p>
92*91df013fSAsim Jamshed
93*91df013fSAsim Jamshed<h2>RETURN VALUE
94*91df013fSAsim Jamshed<a name="RETURN VALUE"></a>
95*91df013fSAsim Jamshed</h2>
96*91df013fSAsim Jamshed
97*91df013fSAsim Jamshed
98*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on
99*91df013fSAsim Jamshedsuccess; -1 on failure. In case of failure, <i>errno</i> is
100*91df013fSAsim Jamshedset appropriately.</p>
101*91df013fSAsim Jamshed
102*91df013fSAsim Jamshed<h2>NOTES
103*91df013fSAsim Jamshed<a name="NOTES"></a>
104*91df013fSAsim Jamshed</h2>
105*91df013fSAsim Jamshed
106*91df013fSAsim Jamshed
107*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">The default RSS
108*91df013fSAsim Jamshedalgorithm set in NIC device is normally asymmetric. During
109*91df013fSAsim JamshedNIC driver initialization, the mTCP core ensures that the
110*91df013fSAsim Jamshedseed for the RSS algorithm is re-set to make traffic
111*91df013fSAsim Jamshedreception symmetric. Also, during the driver intialization
112*91df013fSAsim Jamshedstage, the mTCP core assigns NIC queue(s) binding with
113*91df013fSAsim Jamshedarbitrary CPU core(s).</p>
114*91df013fSAsim Jamshed
115*91df013fSAsim Jamshed<h2>ERRORS
116*91df013fSAsim Jamshed<a name="ERRORS"></a>
117*91df013fSAsim Jamshed</h2>
118*91df013fSAsim Jamshed
119*91df013fSAsim Jamshed
120*91df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
121*91df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
122*91df013fSAsim Jamshed<tr valign="top" align="left">
123*91df013fSAsim Jamshed<td width="11%"></td>
124*91df013fSAsim Jamshed<td width="9%">
125*91df013fSAsim Jamshed
126*91df013fSAsim Jamshed
127*91df013fSAsim Jamshed<p style="margin-top: 1em"><b>ENOMEM</b></p></td>
128*91df013fSAsim Jamshed<td width="6%"></td>
129*91df013fSAsim Jamshed<td width="74%">
130*91df013fSAsim Jamshed
131*91df013fSAsim Jamshed
132*91df013fSAsim Jamshed<p style="margin-top: 1em">Failure to create mapping pool
133*91df013fSAsim Jamsheddue to insufficient memory.</p></td></tr>
134*91df013fSAsim Jamshed</table>
135*91df013fSAsim Jamshed
136*91df013fSAsim Jamshed<h2>NOTES
137*91df013fSAsim Jamshed<a name="NOTES"></a>
138*91df013fSAsim Jamshed</h2>
139*91df013fSAsim Jamshed
140*91df013fSAsim Jamshed
141*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">See
142*91df013fSAsim Jamshed<b>http://an.kaist.ac.kr/~shinae/paper/2012-srss.pdf</b> for
143*91df013fSAsim Jamsheddetails on symmetric Receive-Side Scaling (RSS).</p>
144*91df013fSAsim Jamshed
145*91df013fSAsim Jamshed<h2>AUTHORS
146*91df013fSAsim Jamshed<a name="AUTHORS"></a>
147*91df013fSAsim Jamshed</h2>
148*91df013fSAsim Jamshed
149*91df013fSAsim Jamshed
150*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
151*91df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
152*91df013fSAsim Jamshed
153*91df013fSAsim Jamshed<h2>SEE ALSO
154*91df013fSAsim Jamshed<a name="SEE ALSO"></a>
155*91df013fSAsim Jamshed</h2>
156*91df013fSAsim Jamshed
157*91df013fSAsim Jamshed
158*91df013fSAsim Jamshed
159*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_init</b>(),
160*91df013fSAsim Jamshed<b>mtcp_destroy</b>()</p>
161*91df013fSAsim Jamshed
162*91df013fSAsim Jamshed<h2>COLOPHON
163*91df013fSAsim Jamshed<a name="COLOPHON"></a>
164*91df013fSAsim Jamshed</h2>
165*91df013fSAsim Jamshed
166*91df013fSAsim Jamshed
167*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
168*91df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
169*91df013fSAsim Jamshedof the project, and information about reporting bugs, can be
170*91df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
171*91df013fSAsim Jamshed<hr>
172*91df013fSAsim Jamshed</body>
173*91df013fSAsim Jamshed</html>
174