191df013fSAsim Jamshed<!-- Creator     : groff version 1.22.2 -->
291df013fSAsim Jamshed<!-- CreationDate: Tue Feb  7 13:27:07 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_ioctl</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_ioctl</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_ioctl
4091df013fSAsim Jamshed&minus; control mTCP socket</p>
4191df013fSAsim Jamshed
4291df013fSAsim Jamshed<h2>SYNOPSIS
4391df013fSAsim Jamshed<a name="SYNOPSIS"></a>
4491df013fSAsim Jamshed</h2>
4591df013fSAsim Jamshed
4691df013fSAsim Jamshed
4791df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
4891df013fSAsim Jamshed&lt;mtcp_api.h&gt;</b></p>
4991df013fSAsim Jamshed
5091df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
5191df013fSAsim Jamshedmtcp_ioctl(mctx_t</b> <i>mctx</i><b>, int</b>
5291df013fSAsim Jamshed<i>sockid</i><b>, int</b> <i>request</i><b>, void *</b>
5391df013fSAsim Jamshed<i>argp</i><b>);</b></p>
5491df013fSAsim Jamshed
5591df013fSAsim Jamshed<h2>DESCRIPTION
5691df013fSAsim Jamshed<a name="DESCRIPTION"></a>
5791df013fSAsim Jamshed</h2>
5891df013fSAsim Jamshed
5991df013fSAsim Jamshed
6091df013fSAsim Jamshed
6191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_ioctl</b>()
6291df013fSAsim Jamshedcan be used to retrieve certain attributes from an mTCP (of
6391df013fSAsim Jamshedtype SOCK_STREAM) socket via descriptor id, <i>sockid.</i>
6491df013fSAsim JamshedThe third argument, <i>request</i> is used by the caller to
6591df013fSAsim Jamshedfetch the attribute type. The fourth argument, <i>argp</i>
6691df013fSAsim Jamshedis an untyped pointer to memory that <b>mtcp_ioctl</b>()
6791df013fSAsim Jamsheduses for storing the returning value.</p>
6891df013fSAsim Jamshed
6991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Currently,
7091df013fSAsim Jamshed<b>mtcp_ioctl</b>() only supports 1 type of
7191df013fSAsim Jamshed<i>request.</i></p>
7291df013fSAsim Jamshed
7391df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
7491df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
7591df013fSAsim Jamshed<tr valign="top" align="left">
7691df013fSAsim Jamshed<td width="11%"></td>
7791df013fSAsim Jamshed<td width="12%">
7891df013fSAsim Jamshed
7991df013fSAsim Jamshed
8091df013fSAsim Jamshed<p><b>FIONREAD</b></p></td>
8191df013fSAsim Jamshed<td width="6%"></td>
8291df013fSAsim Jamshed<td width="71%">
8391df013fSAsim Jamshed
8491df013fSAsim Jamshed
8591df013fSAsim Jamshed<p>The number of bytes that can be read from the receive
8691df013fSAsim Jamshedbuffer when <b>mtcp_read</b>() is called. The user should
8791df013fSAsim Jamshedpass <i>argp</i> pointing to a memory region that can store
8891df013fSAsim Jamsheda variable of size <b>ssize_t</b>.</p></td></tr>
8991df013fSAsim Jamshed</table>
9091df013fSAsim Jamshed
9191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Note that
9291df013fSAsim Jamshed<b>mtcp_ioctl()</b> assumes that the CPU core-id (as set
9391df013fSAsim Jamshedinside <i>mctx</i> structure) will be used as the value for
9491df013fSAsim JamshedNIC queue-id, which the mTCP context will eventually access
9591df013fSAsim Jamshedduring its operation. For example, mTCP context running on
9691df013fSAsim Jamshedcore 3 will read traffic from NIC hardware queue-id 3.</p>
9791df013fSAsim Jamshed
9891df013fSAsim Jamshed<h2>RETURN VALUE
9991df013fSAsim Jamshed<a name="RETURN VALUE"></a>
10091df013fSAsim Jamshed</h2>
10191df013fSAsim Jamshed
10291df013fSAsim Jamshed
10391df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on
10491df013fSAsim Jamshedsuccess; -1 on failure. In case of failure, <i>errno</i> is
10591df013fSAsim Jamshedset appropriately.</p>
10691df013fSAsim Jamshed
10791df013fSAsim Jamshed<h2>ERRORS
10891df013fSAsim Jamshed<a name="ERRORS"></a>
10991df013fSAsim Jamshed</h2>
11091df013fSAsim Jamshed
11191df013fSAsim Jamshed
11291df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
11391df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
11491df013fSAsim Jamshed<tr valign="top" align="left">
11591df013fSAsim Jamshed<td width="11%"></td>
11691df013fSAsim Jamshed<td width="9%">
11791df013fSAsim Jamshed
11891df013fSAsim Jamshed
11991df013fSAsim Jamshed<p style="margin-top: 1em"><b>EACCES</b></p></td>
12091df013fSAsim Jamshed<td width="9%"></td>
12191df013fSAsim Jamshed<td width="28%">
12291df013fSAsim Jamshed
12391df013fSAsim Jamshed
12491df013fSAsim Jamshed<p style="margin-top: 1em"><i>mctx</i> is invalid</p></td>
12591df013fSAsim Jamshed<td width="43%">
12691df013fSAsim Jamshed</td></tr>
12791df013fSAsim Jamshed<tr valign="top" align="left">
12891df013fSAsim Jamshed<td width="11%"></td>
12991df013fSAsim Jamshed<td width="9%">
13091df013fSAsim Jamshed
13191df013fSAsim Jamshed
13291df013fSAsim Jamshed<p><b>EBADF</b></p></td>
13391df013fSAsim Jamshed<td width="9%"></td>
13491df013fSAsim Jamshed<td width="28%">
13591df013fSAsim Jamshed
13691df013fSAsim Jamshed
13791df013fSAsim Jamshed<p><i>sockid</i> is invalid.</p></td>
13891df013fSAsim Jamshed<td width="43%">
13991df013fSAsim Jamshed</td></tr>
14091df013fSAsim Jamshed<tr valign="top" align="left">
14191df013fSAsim Jamshed<td width="11%"></td>
14291df013fSAsim Jamshed<td width="9%">
14391df013fSAsim Jamshed
14491df013fSAsim Jamshed
14591df013fSAsim Jamshed<p><b>EFAULT</b></p></td>
14691df013fSAsim Jamshed<td width="9%"></td>
14791df013fSAsim Jamshed<td width="28%">
14891df013fSAsim Jamshed
14991df013fSAsim Jamshed
15091df013fSAsim Jamshed<p><i>argp</i> is NULL.</p></td>
15191df013fSAsim Jamshed<td width="43%">
15291df013fSAsim Jamshed</td></tr>
15391df013fSAsim Jamshed</table>
15491df013fSAsim Jamshed
15591df013fSAsim Jamshed<h2>AUTHORS
15691df013fSAsim Jamshed<a name="AUTHORS"></a>
15791df013fSAsim Jamshed</h2>
15891df013fSAsim Jamshed
15991df013fSAsim Jamshed
16091df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
16191df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
16291df013fSAsim Jamshed
16391df013fSAsim Jamshed<h2>SEE ALSO
16491df013fSAsim Jamshed<a name="SEE ALSO"></a>
16591df013fSAsim Jamshed</h2>
16691df013fSAsim Jamshed
16791df013fSAsim Jamshed
16891df013fSAsim Jamshed
16991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_getsockopt</b>(),
17091df013fSAsim Jamshed<b>mtcp_socket</b>(), <b>mtcp_read</b>()</p>
17191df013fSAsim Jamshed
17291df013fSAsim Jamshed<h2>COLOPHON
17391df013fSAsim Jamshed<a name="COLOPHON"></a>
17491df013fSAsim Jamshed</h2>
17591df013fSAsim Jamshed
17691df013fSAsim Jamshed
17791df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
17891df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
17991df013fSAsim Jamshedof the project, and information about reporting bugs, can be
18091df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
181*e5df9dc1SAsim Jamshed<!-- <hr> -->
182*e5df9dc1SAsim Jamshed<br>
183*e5df9dc1SAsim Jamshed<div class="footer">
184*e5df9dc1SAsim Jamshed  <img src="back-arrow.jpg" width="2%" height="2%"><a href="http://mos.kaist.edu/index_man.html">Back to Index</a>
185*e5df9dc1SAsim Jamshed</div>
186*e5df9dc1SAsim Jamshed</div>
18791df013fSAsim Jamshed</body>
18891df013fSAsim Jamshed</html>
189