1*91df013fSAsim Jamshed<!-- Creator     : groff version 1.22.2 -->
2*91df013fSAsim Jamshed<!-- CreationDate: Tue Feb  7 13:27:07 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_ioctl</title>
17*91df013fSAsim Jamshed
18*91df013fSAsim Jamshed</head>
19*91df013fSAsim Jamshed<body>
20*91df013fSAsim Jamshed
21*91df013fSAsim Jamshed<h1 align="center">mtcp_ioctl</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="#ERRORS">ERRORS</a><br>
28*91df013fSAsim Jamshed<a href="#AUTHORS">AUTHORS</a><br>
29*91df013fSAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br>
30*91df013fSAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br>
31*91df013fSAsim Jamshed
32*91df013fSAsim Jamshed<hr>
33*91df013fSAsim Jamshed
34*91df013fSAsim Jamshed
35*91df013fSAsim Jamshed<h2>NAME
36*91df013fSAsim Jamshed<a name="NAME"></a>
37*91df013fSAsim Jamshed</h2>
38*91df013fSAsim Jamshed
39*91df013fSAsim Jamshed
40*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_ioctl
41*91df013fSAsim Jamshed&minus; control mTCP socket</p>
42*91df013fSAsim Jamshed
43*91df013fSAsim Jamshed<h2>SYNOPSIS
44*91df013fSAsim Jamshed<a name="SYNOPSIS"></a>
45*91df013fSAsim Jamshed</h2>
46*91df013fSAsim Jamshed
47*91df013fSAsim Jamshed
48*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
49*91df013fSAsim Jamshed&lt;mtcp_api.h&gt;</b></p>
50*91df013fSAsim Jamshed
51*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
52*91df013fSAsim Jamshedmtcp_ioctl(mctx_t</b> <i>mctx</i><b>, int</b>
53*91df013fSAsim Jamshed<i>sockid</i><b>, int</b> <i>request</i><b>, void *</b>
54*91df013fSAsim Jamshed<i>argp</i><b>);</b></p>
55*91df013fSAsim Jamshed
56*91df013fSAsim Jamshed<h2>DESCRIPTION
57*91df013fSAsim Jamshed<a name="DESCRIPTION"></a>
58*91df013fSAsim Jamshed</h2>
59*91df013fSAsim Jamshed
60*91df013fSAsim Jamshed
61*91df013fSAsim Jamshed
62*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_ioctl</b>()
63*91df013fSAsim Jamshedcan be used to retrieve certain attributes from an mTCP (of
64*91df013fSAsim Jamshedtype SOCK_STREAM) socket via descriptor id, <i>sockid.</i>
65*91df013fSAsim JamshedThe third argument, <i>request</i> is used by the caller to
66*91df013fSAsim Jamshedfetch the attribute type. The fourth argument, <i>argp</i>
67*91df013fSAsim Jamshedis an untyped pointer to memory that <b>mtcp_ioctl</b>()
68*91df013fSAsim Jamsheduses for storing the returning value.</p>
69*91df013fSAsim Jamshed
70*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Currently,
71*91df013fSAsim Jamshed<b>mtcp_ioctl</b>() only supports 1 type of
72*91df013fSAsim Jamshed<i>request.</i></p>
73*91df013fSAsim Jamshed
74*91df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
75*91df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
76*91df013fSAsim Jamshed<tr valign="top" align="left">
77*91df013fSAsim Jamshed<td width="11%"></td>
78*91df013fSAsim Jamshed<td width="12%">
79*91df013fSAsim Jamshed
80*91df013fSAsim Jamshed
81*91df013fSAsim Jamshed<p><b>FIONREAD</b></p></td>
82*91df013fSAsim Jamshed<td width="6%"></td>
83*91df013fSAsim Jamshed<td width="71%">
84*91df013fSAsim Jamshed
85*91df013fSAsim Jamshed
86*91df013fSAsim Jamshed<p>The number of bytes that can be read from the receive
87*91df013fSAsim Jamshedbuffer when <b>mtcp_read</b>() is called. The user should
88*91df013fSAsim Jamshedpass <i>argp</i> pointing to a memory region that can store
89*91df013fSAsim Jamsheda variable of size <b>ssize_t</b>.</p></td></tr>
90*91df013fSAsim Jamshed</table>
91*91df013fSAsim Jamshed
92*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Note that
93*91df013fSAsim Jamshed<b>mtcp_ioctl()</b> assumes that the CPU core-id (as set
94*91df013fSAsim Jamshedinside <i>mctx</i> structure) will be used as the value for
95*91df013fSAsim JamshedNIC queue-id, which the mTCP context will eventually access
96*91df013fSAsim Jamshedduring its operation. For example, mTCP context running on
97*91df013fSAsim Jamshedcore 3 will read traffic from NIC hardware queue-id 3.</p>
98*91df013fSAsim Jamshed
99*91df013fSAsim Jamshed<h2>RETURN VALUE
100*91df013fSAsim Jamshed<a name="RETURN VALUE"></a>
101*91df013fSAsim Jamshed</h2>
102*91df013fSAsim Jamshed
103*91df013fSAsim Jamshed
104*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on
105*91df013fSAsim Jamshedsuccess; -1 on failure. In case of failure, <i>errno</i> is
106*91df013fSAsim Jamshedset appropriately.</p>
107*91df013fSAsim Jamshed
108*91df013fSAsim Jamshed<h2>ERRORS
109*91df013fSAsim Jamshed<a name="ERRORS"></a>
110*91df013fSAsim Jamshed</h2>
111*91df013fSAsim Jamshed
112*91df013fSAsim Jamshed
113*91df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
114*91df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
115*91df013fSAsim Jamshed<tr valign="top" align="left">
116*91df013fSAsim Jamshed<td width="11%"></td>
117*91df013fSAsim Jamshed<td width="9%">
118*91df013fSAsim Jamshed
119*91df013fSAsim Jamshed
120*91df013fSAsim Jamshed<p style="margin-top: 1em"><b>EACCES</b></p></td>
121*91df013fSAsim Jamshed<td width="9%"></td>
122*91df013fSAsim Jamshed<td width="28%">
123*91df013fSAsim Jamshed
124*91df013fSAsim Jamshed
125*91df013fSAsim Jamshed<p style="margin-top: 1em"><i>mctx</i> is invalid</p></td>
126*91df013fSAsim Jamshed<td width="43%">
127*91df013fSAsim Jamshed</td></tr>
128*91df013fSAsim Jamshed<tr valign="top" align="left">
129*91df013fSAsim Jamshed<td width="11%"></td>
130*91df013fSAsim Jamshed<td width="9%">
131*91df013fSAsim Jamshed
132*91df013fSAsim Jamshed
133*91df013fSAsim Jamshed<p><b>EBADF</b></p></td>
134*91df013fSAsim Jamshed<td width="9%"></td>
135*91df013fSAsim Jamshed<td width="28%">
136*91df013fSAsim Jamshed
137*91df013fSAsim Jamshed
138*91df013fSAsim Jamshed<p><i>sockid</i> is invalid.</p></td>
139*91df013fSAsim Jamshed<td width="43%">
140*91df013fSAsim Jamshed</td></tr>
141*91df013fSAsim Jamshed<tr valign="top" align="left">
142*91df013fSAsim Jamshed<td width="11%"></td>
143*91df013fSAsim Jamshed<td width="9%">
144*91df013fSAsim Jamshed
145*91df013fSAsim Jamshed
146*91df013fSAsim Jamshed<p><b>EFAULT</b></p></td>
147*91df013fSAsim Jamshed<td width="9%"></td>
148*91df013fSAsim Jamshed<td width="28%">
149*91df013fSAsim Jamshed
150*91df013fSAsim Jamshed
151*91df013fSAsim Jamshed<p><i>argp</i> is NULL.</p></td>
152*91df013fSAsim Jamshed<td width="43%">
153*91df013fSAsim Jamshed</td></tr>
154*91df013fSAsim Jamshed</table>
155*91df013fSAsim Jamshed
156*91df013fSAsim Jamshed<h2>AUTHORS
157*91df013fSAsim Jamshed<a name="AUTHORS"></a>
158*91df013fSAsim Jamshed</h2>
159*91df013fSAsim Jamshed
160*91df013fSAsim Jamshed
161*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
162*91df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
163*91df013fSAsim Jamshed
164*91df013fSAsim Jamshed<h2>SEE ALSO
165*91df013fSAsim Jamshed<a name="SEE ALSO"></a>
166*91df013fSAsim Jamshed</h2>
167*91df013fSAsim Jamshed
168*91df013fSAsim Jamshed
169*91df013fSAsim Jamshed
170*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_getsockopt</b>(),
171*91df013fSAsim Jamshed<b>mtcp_socket</b>(), <b>mtcp_read</b>()</p>
172*91df013fSAsim Jamshed
173*91df013fSAsim Jamshed<h2>COLOPHON
174*91df013fSAsim Jamshed<a name="COLOPHON"></a>
175*91df013fSAsim Jamshed</h2>
176*91df013fSAsim Jamshed
177*91df013fSAsim Jamshed
178*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
179*91df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
180*91df013fSAsim Jamshedof the project, and information about reporting bugs, can be
181*91df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
182*91df013fSAsim Jamshed<hr>
183*91df013fSAsim Jamshed</body>
184*91df013fSAsim Jamshed</html>
185