191df013fSAsim Jamshed<!-- Creator     : groff version 1.22.2 -->
291df013fSAsim Jamshed<!-- CreationDate: Thu Feb  2 01:56:08 2017 -->
391df013fSAsim Jamshed<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
491df013fSAsim Jamshed"http://www.w3.org/TR/html4/loose.dtd">
591df013fSAsim Jamshed<html>
691df013fSAsim Jamshed<head>
791df013fSAsim Jamshed<meta name="generator" content="groff -Thtml, see www.gnu.org">
891df013fSAsim Jamshed<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
991df013fSAsim Jamshed<meta name="Content-Style" content="text/css">
1091df013fSAsim Jamshed<style type="text/css">
1191df013fSAsim Jamshed       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
1291df013fSAsim Jamshed       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
1391df013fSAsim Jamshed       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
1491df013fSAsim Jamshed       h1      { text-align: center }
1591df013fSAsim Jamshed</style>
1691df013fSAsim Jamshed<title>mtcp_socket</title>
17*e5df9dc1SAsim Jamshed<link rel="stylesheet" href="./common.css">
1891df013fSAsim Jamshed</head>
1991df013fSAsim Jamshed<body>
20*e5df9dc1SAsim Jamshed<div class="main">
2191df013fSAsim Jamshed<h1 align="center">mtcp_socket</h1>
22*e5df9dc1SAsim Jamshed<!--
2391df013fSAsim Jamshed<a href="#NAME">NAME</a><br>
2491df013fSAsim Jamshed<a href="#SYNOPSIS">SYNOPSIS</a><br>
2591df013fSAsim Jamshed<a href="#DESCRIPTION">DESCRIPTION</a><br>
2691df013fSAsim Jamshed<a href="#RETURN VALUE">RETURN VALUE</a><br>
2791df013fSAsim Jamshed<a href="#ERRORS">ERRORS</a><br>
2891df013fSAsim Jamshed<a href="#AUTHORS">AUTHORS</a><br>
2991df013fSAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br>
3091df013fSAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br>
3191df013fSAsim Jamshed<hr>
32*e5df9dc1SAsim Jamshed-->
3391df013fSAsim Jamshed
3491df013fSAsim Jamshed<h2>NAME
3591df013fSAsim Jamshed<a name="NAME"></a>
3691df013fSAsim Jamshed</h2>
3791df013fSAsim Jamshed
3891df013fSAsim Jamshed
3991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_socket
4091df013fSAsim Jamshed&minus; instantiate an mTCP socket for communication or
4191df013fSAsim Jamshedmonitoring</p>
4291df013fSAsim Jamshed
4391df013fSAsim Jamshed<h2>SYNOPSIS
4491df013fSAsim Jamshed<a name="SYNOPSIS"></a>
4591df013fSAsim Jamshed</h2>
4691df013fSAsim Jamshed
4791df013fSAsim Jamshed
4891df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
4991df013fSAsim Jamshed&lt;mtcp_api.h&gt;</b></p>
5091df013fSAsim Jamshed
5191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
5291df013fSAsim Jamshedmtcp_socket(mctx_t</b> <i>mctx</i><b>, int</b>
5391df013fSAsim Jamshed<i>domain</i><b>, int</b> <i>type</i><b>, int</b>
5491df013fSAsim Jamshed<i>protocol</i><b>);</b></p>
5591df013fSAsim Jamshed
5691df013fSAsim Jamshed<h2>DESCRIPTION
5791df013fSAsim Jamshed<a name="DESCRIPTION"></a>
5891df013fSAsim Jamshed</h2>
5991df013fSAsim Jamshed
6091df013fSAsim Jamshed
6191df013fSAsim Jamshed
6291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_socket</b>()
6391df013fSAsim Jamshedcan be used to create either a communication endpoint or a
6491df013fSAsim Jamshedmiddlebox viewpoint for mTCP-based network connection. In
6591df013fSAsim Jamshedmany ways, it behaves similar to a BSD socket. An
6691df013fSAsim Jamshed<b>mtcp_socket</b>() call takes an additional argument named
6791df013fSAsim Jamshed<i>mctx</i> that represents the per-core mTCP context in an
6891df013fSAsim Jamshedapplication (see <b>mtcp_create_context()</b> for
6991df013fSAsim Jamsheddetails).</p>
7091df013fSAsim Jamshed
7191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">The
7291df013fSAsim Jamshed<i>domain</i> argument is used to specify a communication
7391df013fSAsim Jamsheddomain; in mTCP, the only available protocol family for the
7491df013fSAsim Jamsheddomain is <b>AF_INET</b> which represents IPv4 Internet
7591df013fSAsim Jamshedprotocol.</p>
7691df013fSAsim Jamshed
7791df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">The socket has
7891df013fSAsim Jamshedthe indicated <i>type ,</i> which specifies the
7991df013fSAsim Jamshedcommunication semantics. Currently defined types in mTCP
8091df013fSAsim Jamshedare:</p>
8191df013fSAsim Jamshed
8291df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
8391df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
8491df013fSAsim Jamshed<tr valign="top" align="left">
8591df013fSAsim Jamshed<td width="11%"></td>
8691df013fSAsim Jamshed<td width="35%">
8791df013fSAsim Jamshed
8891df013fSAsim Jamshed
8991df013fSAsim Jamshed<p><b>SOCK_STREAM</b></p></td>
9091df013fSAsim Jamshed<td width="3%"></td>
9191df013fSAsim Jamshed<td width="51%">
9291df013fSAsim Jamshed
9391df013fSAsim Jamshed
9491df013fSAsim Jamshed<p>Provides sequenced, reliable, full-duplex,
9591df013fSAsim Jamshedconnection-based byte streams.</p></td></tr>
9691df013fSAsim Jamshed<tr valign="top" align="left">
9791df013fSAsim Jamshed<td width="11%"></td>
9891df013fSAsim Jamshed<td width="35%">
9991df013fSAsim Jamshed
10091df013fSAsim Jamshed
10191df013fSAsim Jamshed<p><b>MOS_SOCK_MONITOR_STREAM</b></p></td>
10291df013fSAsim Jamshed<td width="3%"></td>
10391df013fSAsim Jamshed<td width="51%">
10491df013fSAsim Jamshed
10591df013fSAsim Jamshed
10691df013fSAsim Jamshed<p>Provides a middlebox viewpoint for ongoing
10791df013fSAsim Jamshedconnection-oriented flows.</p></td></tr>
10891df013fSAsim Jamshed<tr valign="top" align="left">
10991df013fSAsim Jamshed<td width="11%"></td>
11091df013fSAsim Jamshed<td width="35%">
11191df013fSAsim Jamshed
11291df013fSAsim Jamshed
11391df013fSAsim Jamshed<p><b>MOS_SOCK_MONITOR_RAW</b></p></td>
11491df013fSAsim Jamshed<td width="3%"></td>
11591df013fSAsim Jamshed<td width="51%">
11691df013fSAsim Jamshed
11791df013fSAsim Jamshed
11891df013fSAsim Jamshed<p>Provides a middlebox viewpoint for connection-less
11991df013fSAsim Jamshedflows. This can be used as a tap to glean unsynchronized TCP
12091df013fSAsim Jamshedpackets (no connection handshakes) or any other IP
12191df013fSAsim Jamsheddatagrams.</p> </td></tr>
12291df013fSAsim Jamshed</table>
12391df013fSAsim Jamshed
12491df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">The
12591df013fSAsim Jamshed<i>protocol</i> argument represents the specific protocol ID
12691df013fSAsim Jamshedto be used with the socket. mTCP assumes this argument to be
12791df013fSAsim Jamshed0 (since it only supports single-protocol sockets).</p>
12891df013fSAsim Jamshed
12991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Sockets of type
13091df013fSAsim Jamshed<b>SOCK_STREAM</b> represent full-duplex bytestreams. A
13191df013fSAsim Jamshedstream socket must be in <b>ESTABLISHED</b> TCP state before
13291df013fSAsim Jamsheddata can be sent or received on it. A connection to another
13391df013fSAsim Jamshedpeer endpoint can be created with an <b>mtcp_connect()</b>
13491df013fSAsim Jamshedcall. Once connected, data may be exchanged using
13591df013fSAsim Jamshed<b>mtcp_read()</b> and <b>mtcp_write()</b> calls. When a
13691df013fSAsim Jamshedsession needs to be terminated, <b>mtcp_close()</b> can be
13791df013fSAsim Jamshedcalled. Socket operations can be manipulated using socket
13891df013fSAsim Jamshedlevel options via <b>mtcp_setsockopt()</b> and
13991df013fSAsim Jamshed<b>mtcp_getsockopt()</b> function calls. mTCP sockets run in
14091df013fSAsim Jamshednon-blocking mode by default.</p>
14191df013fSAsim Jamshed
14291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Sockets of type
14391df013fSAsim Jamshed<b>MOS_SOCK_MONITOR_STREAM</b> represent middlebox viewpoint
14491df013fSAsim Jamshedof full-duplex bytestreams. A monitoring stream socket must
14591df013fSAsim Jamshedbe in <b>ESTABLISHED</b> TCP state before TCP bytestreams
14691df013fSAsim Jamshedcan be snooped from the TCP ring buffers of either client or
14791df013fSAsim Jamshedserver TCP emulated stacks using either <b>mtcp_peek()</b>
14891df013fSAsim Jamshedor <b>mtcp_ppeek()</b> functions. A stream monitoring socket
14991df013fSAsim Jamshedcan be bound with a connection filter using
15091df013fSAsim Jamshed<b>mtcp_bind_monitor_filter()</b> function. The user can use
15191df013fSAsim Jamshed<b>mtcp_register_callback()</b> function to register the
15291df013fSAsim Jamshedsocket with relevant mOS events. These can either be
15391df013fSAsim Jamshedbuilt-in events or user-defined (custom) events. Like
15491df013fSAsim Jamshed<b>SOCK_STREAM</b> sockets, operations can be manipulated
15591df013fSAsim Jamshedusing socket level options via <b>mtcp_setsockopt()</b> and
15691df013fSAsim Jamshed<b>mtcp_getsockopt()</b> function calls. A call to
15791df013fSAsim Jamshed<b>mtcp_close()</b> function unregisters all flow events for
15891df013fSAsim Jamshedthe socket, but it does not terminate the ongoing
15991df013fSAsim Jamshedconnection.</p>
16091df013fSAsim Jamshed
16191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Sockets of type
16291df013fSAsim Jamshed<b>MOS_SOCK_MONITOR_RAW</b> can be used to monitor network
16391df013fSAsim Jamshedtraffic without connection semantics. Only packet-based
16491df013fSAsim Jamshedfunctions such as <b>mtcp_getlastpkt()</b> can be utilized
16591df013fSAsim Jamshedusing these sockets.</p>
16691df013fSAsim Jamshed
16791df013fSAsim Jamshed<h2>RETURN VALUE
16891df013fSAsim Jamshed<a name="RETURN VALUE"></a>
16991df013fSAsim Jamshed</h2>
17091df013fSAsim Jamshed
17191df013fSAsim Jamshed
17291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns an mTCP
17391df013fSAsim Jamsheddescriptor ID on success; -1 on failure. In case of failure,
17491df013fSAsim Jamshed<i>errno</i> is set appropriately. Please note that each
17591df013fSAsim JamshedmTCP context (referred to by <i>mctx</i> ) creates its own
17691df013fSAsim Jamsheddedicated pool of sockets.</p>
17791df013fSAsim Jamshed
17891df013fSAsim Jamshed<h2>ERRORS
17991df013fSAsim Jamshed<a name="ERRORS"></a>
18091df013fSAsim Jamshed</h2>
18191df013fSAsim Jamshed
18291df013fSAsim Jamshed
18391df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
18491df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
18591df013fSAsim Jamshed<tr valign="top" align="left">
18691df013fSAsim Jamshed<td width="11%"></td>
18791df013fSAsim Jamshed<td width="18%">
18891df013fSAsim Jamshed
18991df013fSAsim Jamshed
19091df013fSAsim Jamshed<p style="margin-top: 1em"><b>EACCES</b></p></td>
19191df013fSAsim Jamshed<td width="5%"></td>
19291df013fSAsim Jamshed<td width="66%">
19391df013fSAsim Jamshed
19491df013fSAsim Jamshed
19591df013fSAsim Jamshed<p style="margin-top: 1em"><i>mctx</i> is not valid.</p></td></tr>
19691df013fSAsim Jamshed<tr valign="top" align="left">
19791df013fSAsim Jamshed<td width="11%"></td>
19891df013fSAsim Jamshed<td width="18%">
19991df013fSAsim Jamshed
20091df013fSAsim Jamshed
20191df013fSAsim Jamshed<p><b>EAFNOSUPPORT</b></p></td>
20291df013fSAsim Jamshed<td width="5%"></td>
20391df013fSAsim Jamshed<td width="66%">
20491df013fSAsim Jamshed
20591df013fSAsim Jamshed
20691df013fSAsim Jamshed<p><i>domain</i> is not supported.</p></td></tr>
20791df013fSAsim Jamshed<tr valign="top" align="left">
20891df013fSAsim Jamshed<td width="11%"></td>
20991df013fSAsim Jamshed<td width="18%">
21091df013fSAsim Jamshed
21191df013fSAsim Jamshed
21291df013fSAsim Jamshed<p><b>EINVAL</b></p></td>
21391df013fSAsim Jamshed<td width="5%"></td>
21491df013fSAsim Jamshed<td width="66%">
21591df013fSAsim Jamshed
21691df013fSAsim Jamshed
21791df013fSAsim Jamshed<p>The socket <i>type</i> is invalid.</p></td></tr>
21891df013fSAsim Jamshed<tr valign="top" align="left">
21991df013fSAsim Jamshed<td width="11%"></td>
22091df013fSAsim Jamshed<td width="18%">
22191df013fSAsim Jamshed
22291df013fSAsim Jamshed
22391df013fSAsim Jamshed<p><b>ENFILE</b></p></td>
22491df013fSAsim Jamshed<td width="5%"></td>
22591df013fSAsim Jamshed<td width="66%">
22691df013fSAsim Jamshed
22791df013fSAsim Jamshed
22891df013fSAsim Jamshed<p>No socket descriptor is available in the pool at the
22991df013fSAsim Jamshedmoment.</p> </td></tr>
23091df013fSAsim Jamshed</table>
23191df013fSAsim Jamshed
23291df013fSAsim Jamshed<h2>AUTHORS
23391df013fSAsim Jamshed<a name="AUTHORS"></a>
23491df013fSAsim Jamshed</h2>
23591df013fSAsim Jamshed
23691df013fSAsim Jamshed
23791df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
23891df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
23991df013fSAsim Jamshed
240*e5df9dc1SAsim Jamshed<!----------------------------------------------------------->
241*e5df9dc1SAsim Jamshed<h2>EXAMPLES
242*e5df9dc1SAsim Jamshed<a name="EXAMPLES"></a>
243*e5df9dc1SAsim Jamshed</h2>
244*e5df9dc1SAsim Jamshed
245*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">
246*e5df9dc1SAsim Jamshed  <a href="http://mos.kaist.edu/guide/programmer/05_api_example.html#per-core-initialization-routine">
247*e5df9dc1SAsim Jamshed	http://mos.kaist.edu/guide/programmer/05_api_example.html#per-core-initialization-routine
248*e5df9dc1SAsim Jamshed	</a>
249*e5df9dc1SAsim Jamshed</p>
250*e5df9dc1SAsim Jamshed<!----------------------------------------------------------->
251*e5df9dc1SAsim Jamshed
252*e5df9dc1SAsim Jamshed
25391df013fSAsim Jamshed<h2>SEE ALSO
25491df013fSAsim Jamshed<a name="SEE ALSO"></a>
25591df013fSAsim Jamshed</h2>
25691df013fSAsim Jamshed
25791df013fSAsim Jamshed
25891df013fSAsim Jamshed
25991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_bind</b>(),
26091df013fSAsim Jamshed<b>mtcp_listen</b>(), <b>mtcp_accept</b>(),
26191df013fSAsim Jamshed<b>mtcp_connect</b>(), <b>mtcp_read</b>(),
26291df013fSAsim Jamshed<b>mtcp_write</b>(), <b>mtcp_peek</b>(),
26391df013fSAsim Jamshed<b>mtcp_ppeek</b>(), <b>mtcp_bind_monitor_filter</b>(),
26491df013fSAsim Jamshed<b>mtcp_register_callback</b>(),
26591df013fSAsim Jamshed<b>mtcp_getlastpkt</b>()</p>
26691df013fSAsim Jamshed
26791df013fSAsim Jamshed<h2>COLOPHON
26891df013fSAsim Jamshed<a name="COLOPHON"></a>
26991df013fSAsim Jamshed</h2>
27091df013fSAsim Jamshed
27191df013fSAsim Jamshed
27291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
27391df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
27491df013fSAsim Jamshedof the project, and information about reporting bugs, can be
27591df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
276*e5df9dc1SAsim Jamshed<!-- <hr> -->
277*e5df9dc1SAsim Jamshed<br>
278*e5df9dc1SAsim Jamshed<div class="footer">
279*e5df9dc1SAsim Jamshed  <img src="back-arrow.jpg" width="2%" height="2%"><a href="http://mos.kaist.edu/index_man.html">Back to Index</a>
280*e5df9dc1SAsim Jamshed</div>
281*e5df9dc1SAsim Jamshed</div>
28291df013fSAsim Jamshed</body>
28391df013fSAsim Jamshed</html>
284