<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>libnl: lib/route/sch/fifo.c Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libnl <span id="projectnumber">1.1</span></div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> </ul> </div> <div class="header"> <div class="headertitle"> <h1>lib/route/sch/fifo.c</h1> </div> </div> <div class="contents"> <div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> * lib/route/sch/fifo.c (p|b)fifo</span> <a name="l00003"></a>00003 <span class="comment"> *</span> <a name="l00004"></a>00004 <span class="comment"> * This library is free software; you can redistribute it and/or</span> <a name="l00005"></a>00005 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span> <a name="l00006"></a>00006 <span class="comment"> * License as published by the Free Software Foundation version 2.1</span> <a name="l00007"></a>00007 <span class="comment"> * of the License.</span> <a name="l00008"></a>00008 <span class="comment"> *</span> <a name="l00009"></a>00009 <span class="comment"> * Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch></span> <a name="l00010"></a>00010 <span class="comment"> */</span> <a name="l00011"></a>00011 <span class="comment"></span> <a name="l00012"></a>00012 <span class="comment">/**</span> <a name="l00013"></a>00013 <span class="comment"> * @ingroup qdisc_api</span> <a name="l00014"></a>00014 <span class="comment"> * @defgroup fifo Packet/Bytes FIFO (pfifo/bfifo)</span> <a name="l00015"></a>00015 <span class="comment"> * @brief</span> <a name="l00016"></a>00016 <span class="comment"> *</span> <a name="l00017"></a>00017 <span class="comment"> * The FIFO qdisc comes in two flavours:</span> <a name="l00018"></a>00018 <span class="comment"> * @par bfifo (Byte FIFO)</span> <a name="l00019"></a>00019 <span class="comment"> * Allows enqueuing until the currently queued volume in bytes exceeds</span> <a name="l00020"></a>00020 <span class="comment"> * the configured limit.backlog contains currently enqueued volume in bytes.</span> <a name="l00021"></a>00021 <span class="comment"> *</span> <a name="l00022"></a>00022 <span class="comment"> * @par pfifo (Packet FIFO)</span> <a name="l00023"></a>00023 <span class="comment"> * Allows enquueing until the currently queued number of packets</span> <a name="l00024"></a>00024 <span class="comment"> * exceeds the configured limit.</span> <a name="l00025"></a>00025 <span class="comment"> *</span> <a name="l00026"></a>00026 <span class="comment"> * The configuration is exactly the same, the decision which of</span> <a name="l00027"></a>00027 <span class="comment"> * the two variations is going to be used is made based on the</span> <a name="l00028"></a>00028 <span class="comment"> * kind of the qdisc (rtnl_qdisc_set_kind()).</span> <a name="l00029"></a>00029 <span class="comment"> * @{</span> <a name="l00030"></a>00030 <span class="comment"> */</span> <a name="l00031"></a>00031 <a name="l00032"></a>00032 <span class="preprocessor">#include <netlink-local.h></span> <a name="l00033"></a>00033 <span class="preprocessor">#include <netlink-tc.h></span> <a name="l00034"></a>00034 <span class="preprocessor">#include <netlink/netlink.h></span> <a name="l00035"></a>00035 <span class="preprocessor">#include <netlink/route/qdisc.h></span> <a name="l00036"></a>00036 <span class="preprocessor">#include <netlink/route/qdisc-modules.h></span> <a name="l00037"></a>00037 <span class="preprocessor">#include <netlink/route/sch/fifo.h></span> <a name="l00038"></a>00038 <span class="preprocessor">#include <netlink/utils.h></span> <a name="l00039"></a>00039 <span class="comment"></span> <a name="l00040"></a>00040 <span class="comment">/** @cond SKIP */</span> <a name="l00041"></a>00041 <span class="preprocessor">#define SCH_FIFO_ATTR_LIMIT 1</span> <a name="l00042"></a>00042 <span class="preprocessor"></span><span class="comment">/** @endcond */</span> <a name="l00043"></a>00043 <a name="l00044"></a>00044 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">struct </span>rtnl_fifo *fifo_qdisc(<span class="keyword">struct</span> rtnl_qdisc *qdisc) <a name="l00045"></a>00045 { <a name="l00046"></a>00046 <span class="keywordflow">return</span> (<span class="keyword">struct</span> rtnl_fifo *) qdisc->q_subdata; <a name="l00047"></a>00047 } <a name="l00048"></a>00048 <a name="l00049"></a>00049 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">struct </span>rtnl_fifo *fifo_alloc(<span class="keyword">struct</span> rtnl_qdisc *qdisc) <a name="l00050"></a>00050 { <a name="l00051"></a>00051 <span class="keywordflow">if</span> (!qdisc->q_subdata) <a name="l00052"></a>00052 qdisc->q_subdata = calloc(1, <span class="keyword">sizeof</span>(<span class="keyword">struct</span> rtnl_fifo)); <a name="l00053"></a>00053 <a name="l00054"></a>00054 <span class="keywordflow">return</span> fifo_qdisc(qdisc); <a name="l00055"></a>00055 } <a name="l00056"></a>00056 <a name="l00057"></a>00057 <span class="keyword">static</span> <span class="keywordtype">int</span> fifo_msg_parser(<span class="keyword">struct</span> rtnl_qdisc *qdisc) <a name="l00058"></a>00058 { <a name="l00059"></a>00059 <span class="keyword">struct </span>rtnl_fifo *fifo; <a name="l00060"></a>00060 <span class="keyword">struct </span>tc_fifo_qopt *opt; <a name="l00061"></a>00061 <a name="l00062"></a>00062 <span class="keywordflow">if</span> (qdisc->q_opts->d_size < <span class="keyword">sizeof</span>(<span class="keyword">struct</span> tc_fifo_qopt)) <a name="l00063"></a>00063 <span class="keywordflow">return</span> nl_error(EINVAL, <span class="stringliteral">"FIFO options size mismatch"</span>); <a name="l00064"></a>00064 <a name="l00065"></a>00065 fifo = fifo_alloc(qdisc); <a name="l00066"></a>00066 <span class="keywordflow">if</span> (!fifo) <a name="l00067"></a>00067 <span class="keywordflow">return</span> nl_errno(ENOMEM); <a name="l00068"></a>00068 <a name="l00069"></a>00069 opt = (<span class="keyword">struct </span>tc_fifo_qopt *) qdisc->q_opts->d_data; <a name="l00070"></a>00070 fifo->qf_limit = opt->limit; <a name="l00071"></a>00071 fifo->qf_mask = SCH_FIFO_ATTR_LIMIT; <a name="l00072"></a>00072 <a name="l00073"></a>00073 <span class="keywordflow">return</span> 0; <a name="l00074"></a>00074 } <a name="l00075"></a>00075 <a name="l00076"></a>00076 <span class="keyword">static</span> <span class="keywordtype">void</span> fifo_free_data(<span class="keyword">struct</span> rtnl_qdisc *qdisc) <a name="l00077"></a>00077 { <a name="l00078"></a>00078 free(qdisc->q_subdata); <a name="l00079"></a>00079 } <a name="l00080"></a>00080 <a name="l00081"></a>00081 <span class="keyword">static</span> <span class="keywordtype">int</span> pfifo_dump_brief(<span class="keyword">struct</span> rtnl_qdisc *qdisc, <a name="l00082"></a>00082 <span class="keyword">struct</span> <a class="code" href="structnl__dump__params.html" title="Dumping parameters.">nl_dump_params</a> *p, <span class="keywordtype">int</span> line) <a name="l00083"></a>00083 { <a name="l00084"></a>00084 <span class="keyword">struct </span>rtnl_fifo *fifo = fifo_qdisc(qdisc); <a name="l00085"></a>00085 <a name="l00086"></a>00086 <span class="keywordflow">if</span> (fifo) <a name="l00087"></a>00087 dp_dump(p, <span class="stringliteral">" limit %u packets"</span>, fifo->qf_limit); <a name="l00088"></a>00088 <a name="l00089"></a>00089 <span class="keywordflow">return</span> line; <a name="l00090"></a>00090 } <a name="l00091"></a>00091 <a name="l00092"></a>00092 <span class="keyword">static</span> <span class="keywordtype">int</span> bfifo_dump_brief(<span class="keyword">struct</span> rtnl_qdisc *qdisc, <a name="l00093"></a>00093 <span class="keyword">struct</span> <a class="code" href="structnl__dump__params.html" title="Dumping parameters.">nl_dump_params</a> *p, <span class="keywordtype">int</span> line) <a name="l00094"></a>00094 { <a name="l00095"></a>00095 <span class="keyword">struct </span>rtnl_fifo *fifo = fifo_qdisc(qdisc); <a name="l00096"></a>00096 <a name="l00097"></a>00097 <span class="keywordflow">if</span> (fifo) { <a name="l00098"></a>00098 <span class="keywordtype">char</span> *unit; <a name="l00099"></a>00099 <span class="keywordtype">double</span> r; <a name="l00100"></a>00100 <a name="l00101"></a>00101 r = <a class="code" href="group__utils.html#ga5a280448ae9e17ff5dc7e822b9f47b11" title="Cancel down a byte counter.">nl_cancel_down_bytes</a>(fifo->qf_limit, &unit); <a name="l00102"></a>00102 dp_dump(p, <span class="stringliteral">" limit %.1f%s"</span>, r, unit); <a name="l00103"></a>00103 } <a name="l00104"></a>00104 <a name="l00105"></a>00105 <span class="keywordflow">return</span> line; <a name="l00106"></a>00106 } <a name="l00107"></a>00107 <a name="l00108"></a>00108 <span class="keyword">static</span> <span class="keyword">struct </span>nl_msg *fifo_get_opts(<span class="keyword">struct</span> rtnl_qdisc *qdisc) <a name="l00109"></a>00109 { <a name="l00110"></a>00110 <span class="keyword">struct </span>rtnl_fifo *fifo; <a name="l00111"></a>00111 <span class="keyword">struct </span>tc_fifo_qopt opts; <a name="l00112"></a>00112 <span class="keyword">struct </span>nl_msg *msg; <a name="l00113"></a>00113 <a name="l00114"></a>00114 fifo = fifo_qdisc(qdisc); <a name="l00115"></a>00115 <span class="keywordflow">if</span> (!fifo || !(fifo->qf_mask & SCH_FIFO_ATTR_LIMIT)) <a name="l00116"></a>00116 <span class="keywordflow">return</span> NULL; <a name="l00117"></a>00117 <a name="l00118"></a>00118 msg = <a class="code" href="group__msg.html#ga89c936bdf5e73455bb1640a0eb8a020d" title="Allocate a new netlink message with the default maximum payload size.">nlmsg_alloc</a>(); <a name="l00119"></a>00119 <span class="keywordflow">if</span> (!msg) <a name="l00120"></a>00120 <span class="keywordflow">goto</span> errout; <a name="l00121"></a>00121 <a name="l00122"></a>00122 memset(&opts, 0, <span class="keyword">sizeof</span>(opts)); <a name="l00123"></a>00123 opts.limit = fifo->qf_limit; <a name="l00124"></a>00124 <a name="l00125"></a>00125 <span class="keywordflow">if</span> (<a class="code" href="group__msg.html#gacc5e5ade5675d041f86c7c8693f7088d" title="Append data to tail of a netlink message.">nlmsg_append</a>(msg, &opts, <span class="keyword">sizeof</span>(opts), NL_DONTPAD) < 0) <a name="l00126"></a>00126 <span class="keywordflow">goto</span> errout; <a name="l00127"></a>00127 <a name="l00128"></a>00128 <span class="keywordflow">return</span> msg; <a name="l00129"></a>00129 errout: <a name="l00130"></a>00130 <a class="code" href="group__msg.html#ga138ba9bee70553f9fbe7143deacad48c" title="Free a netlink message.">nlmsg_free</a>(msg); <a name="l00131"></a>00131 <span class="keywordflow">return</span> NULL; <a name="l00132"></a>00132 } <a name="l00133"></a>00133 <span class="comment"></span> <a name="l00134"></a>00134 <span class="comment">/**</span> <a name="l00135"></a>00135 <span class="comment"> * @name Attribute Modification</span> <a name="l00136"></a>00136 <span class="comment"> * @{</span> <a name="l00137"></a>00137 <span class="comment"> */</span> <a name="l00138"></a>00138 <span class="comment"></span> <a name="l00139"></a>00139 <span class="comment">/**</span> <a name="l00140"></a>00140 <span class="comment"> * Set limit of FIFO qdisc.</span> <a name="l00141"></a>00141 <span class="comment"> * @arg qdisc FIFO qdisc to be modified.</span> <a name="l00142"></a>00142 <span class="comment"> * @arg limit New limit.</span> <a name="l00143"></a>00143 <span class="comment"> * @return 0 on success or a negative error code.</span> <a name="l00144"></a>00144 <span class="comment"> */</span> <a name="l00145"></a><a class="code" href="group__fifo.html#gac3de03e9d829b5d884b52c668e972c1e">00145</a> <span class="keywordtype">int</span> <a class="code" href="group__fifo.html#gac3de03e9d829b5d884b52c668e972c1e" title="Set limit of FIFO qdisc.">rtnl_qdisc_fifo_set_limit</a>(<span class="keyword">struct</span> rtnl_qdisc *qdisc, <span class="keywordtype">int</span> limit) <a name="l00146"></a>00146 { <a name="l00147"></a>00147 <span class="keyword">struct </span>rtnl_fifo *fifo; <a name="l00148"></a>00148 <a name="l00149"></a>00149 fifo = fifo_alloc(qdisc); <a name="l00150"></a>00150 <span class="keywordflow">if</span> (!fifo) <a name="l00151"></a>00151 <span class="keywordflow">return</span> nl_errno(ENOMEM); <a name="l00152"></a>00152 <a name="l00153"></a>00153 fifo->qf_limit = limit; <a name="l00154"></a>00154 fifo->qf_mask |= SCH_FIFO_ATTR_LIMIT; <a name="l00155"></a>00155 <a name="l00156"></a>00156 <span class="keywordflow">return</span> 0; <a name="l00157"></a>00157 } <a name="l00158"></a>00158 <span class="comment"></span> <a name="l00159"></a>00159 <span class="comment">/**</span> <a name="l00160"></a>00160 <span class="comment"> * Get limit of a FIFO qdisc.</span> <a name="l00161"></a>00161 <span class="comment"> * @arg qdisc FIFO qdisc.</span> <a name="l00162"></a>00162 <span class="comment"> * @return Numeric limit or a negative error code.</span> <a name="l00163"></a>00163 <span class="comment"> */</span> <a name="l00164"></a><a class="code" href="group__fifo.html#ga4cf9cc1e906d5459af88869e5cbbe06d">00164</a> <span class="keywordtype">int</span> <a class="code" href="group__fifo.html#ga4cf9cc1e906d5459af88869e5cbbe06d" title="Get limit of a FIFO qdisc.">rtnl_qdisc_fifo_get_limit</a>(<span class="keyword">struct</span> rtnl_qdisc *qdisc) <a name="l00165"></a>00165 { <a name="l00166"></a>00166 <span class="keyword">struct </span>rtnl_fifo *fifo; <a name="l00167"></a>00167 <a name="l00168"></a>00168 fifo = fifo_qdisc(qdisc); <a name="l00169"></a>00169 <span class="keywordflow">if</span> (fifo && fifo->qf_mask & SCH_FIFO_ATTR_LIMIT) <a name="l00170"></a>00170 <span class="keywordflow">return</span> fifo->qf_limit; <a name="l00171"></a>00171 <span class="keywordflow">else</span> <a name="l00172"></a>00172 <span class="keywordflow">return</span> nl_errno(ENOMEM); <a name="l00173"></a>00173 } <a name="l00174"></a>00174 <span class="comment"></span> <a name="l00175"></a>00175 <span class="comment">/** @} */</span> <a name="l00176"></a>00176 <a name="l00177"></a>00177 <span class="keyword">static</span> <span class="keyword">struct </span><a class="code" href="structrtnl__qdisc__ops.html" title="Qdisc Operations.">rtnl_qdisc_ops</a> pfifo_ops = { <a name="l00178"></a>00178 .<a class="code" href="structrtnl__qdisc__ops.html#a5df5424d29acfa9ae66e7f35a9ca2081" title="Kind/Name of Qdisc.">qo_kind</a> = <span class="stringliteral">"pfifo"</span>, <a name="l00179"></a>00179 .qo_msg_parser = fifo_msg_parser, <a name="l00180"></a>00180 .qo_free_data = fifo_free_data, <a name="l00181"></a>00181 .qo_dump[<a class="code" href="group__utils.html#ggacfb5566c73f0965c5241d7d49bc717e9a5597887c080d5ecae358b6065a4048fd" title="Dump object in a brief one-liner.">NL_DUMP_BRIEF</a>] = pfifo_dump_brief, <a name="l00182"></a>00182 .qo_get_opts = fifo_get_opts, <a name="l00183"></a>00183 }; <a name="l00184"></a>00184 <a name="l00185"></a>00185 <span class="keyword">static</span> <span class="keyword">struct </span><a class="code" href="structrtnl__qdisc__ops.html" title="Qdisc Operations.">rtnl_qdisc_ops</a> bfifo_ops = { <a name="l00186"></a>00186 .<a class="code" href="structrtnl__qdisc__ops.html#a5df5424d29acfa9ae66e7f35a9ca2081" title="Kind/Name of Qdisc.">qo_kind</a> = <span class="stringliteral">"bfifo"</span>, <a name="l00187"></a>00187 .qo_msg_parser = fifo_msg_parser, <a name="l00188"></a>00188 .qo_free_data = fifo_free_data, <a name="l00189"></a>00189 .qo_dump[<a class="code" href="group__utils.html#ggacfb5566c73f0965c5241d7d49bc717e9a5597887c080d5ecae358b6065a4048fd" title="Dump object in a brief one-liner.">NL_DUMP_BRIEF</a>] = bfifo_dump_brief, <a name="l00190"></a>00190 .qo_get_opts = fifo_get_opts, <a name="l00191"></a>00191 }; <a name="l00192"></a>00192 <a name="l00193"></a>00193 <span class="keyword">static</span> <span class="keywordtype">void</span> __init fifo_init(<span class="keywordtype">void</span>) <a name="l00194"></a>00194 { <a name="l00195"></a>00195 <a class="code" href="group__qdisc__api.html#ga52a96211c54bed89f60bc4b106747133" title="Register a qdisc module.">rtnl_qdisc_register</a>(&pfifo_ops); <a name="l00196"></a>00196 <a class="code" href="group__qdisc__api.html#ga52a96211c54bed89f60bc4b106747133" title="Register a qdisc module.">rtnl_qdisc_register</a>(&bfifo_ops); <a name="l00197"></a>00197 } <a name="l00198"></a>00198 <a name="l00199"></a>00199 <span class="keyword">static</span> <span class="keywordtype">void</span> __exit fifo_exit(<span class="keywordtype">void</span>) <a name="l00200"></a>00200 { <a name="l00201"></a>00201 <a class="code" href="group__qdisc__api.html#ga0e1c8c70c536964578dd544fd23f80ff" title="Unregister a qdisc module.">rtnl_qdisc_unregister</a>(&pfifo_ops); <a name="l00202"></a>00202 <a class="code" href="group__qdisc__api.html#ga0e1c8c70c536964578dd544fd23f80ff" title="Unregister a qdisc module.">rtnl_qdisc_unregister</a>(&bfifo_ops); <a name="l00203"></a>00203 } <a name="l00204"></a>00204 <span class="comment"></span> <a name="l00205"></a>00205 <span class="comment">/** @} */</span> </pre></div></div> </div> <hr class="footer"/><address class="footer"><small>Generated on Mon Mar 21 2011 for libnl by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address> </body> </html>