<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>libnl: /home/tgraf/dev/libnl/lib/cli/qdisc/plug.c Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="libnl.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <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">3.2.21</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('cli_2qdisc_2plug_8c.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">plug.c</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * src/lib/cli/qdisc/plug.c plug module for CLI lib</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * License as published by the Free Software Foundation version 2.1</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * of the License.</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Copyright (c) 2012 Shriram Rajagopalan <rshriram@cs.ubc.ca></span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> */</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <netlink/cli/utils.h></span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <netlink/cli/tc.h></span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <netlink/route/qdisc/plug.h></span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">static</span> <span class="keywordtype">void</span> print_usage(<span class="keywordtype">void</span>)</div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  printf(</div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="stringliteral">"Usage: nl-qdisc-add [...] plug [OPTIONS]...\n"</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="stringliteral">"\n"</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="stringliteral">"OPTIONS\n"</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="stringliteral">" --help Show this help text.\n"</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="stringliteral">" --limit Maximum queue length in bytes.\n"</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="stringliteral">" --buffer create a new buffer(plug) and queue incoming traffic into it.\n"</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="stringliteral">" --release-one release traffic from previous buffer.\n"</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="stringliteral">" --release-indefinite stop buffering and release all (buffered and new) packets.\n"</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="stringliteral">"\n"</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="stringliteral">"EXAMPLE"</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="stringliteral">" # Attach plug qdisc with 32KB queue size to ifb0\n"</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="stringliteral">" nl-qdisc-add --dev=ifb0 --parent=root plug --limit=32768\n"</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="stringliteral">" # Plug network traffic arriving at ifb0\n"</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="stringliteral">" nl-qdisc-add --dev=ifb0 --parent=root --update plug --buffer\n"</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="stringliteral">" # Unplug traffic arriving at ifb0 indefinitely\n"</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="stringliteral">" nl-qdisc-add --dev=ifb0 --parent=root --update plug --release-indefinite\n\n"</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="stringliteral">" # If operating in output buffering mode:\n"</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="stringliteral">" # at time t=t0, create a new output buffer b0 to hold network output\n"</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="stringliteral">" nl-qdisc-add --dev=ifb0 --parent=root --update plug --buffer\n\n"</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="stringliteral">" # at time t=t1, take a checkpoint c0, create a new output buffer b1\n"</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="stringliteral">" nl-qdisc-add --dev=ifb0 --parent=root --update plug --buffer\n"</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="stringliteral">" # at time t=t1+r, after c0 is committed, release b0\n"</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="stringliteral">" nl-qdisc-add --dev=ifb0 --parent=root --update plug --release-one\n\n"</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="stringliteral">" # at time t=t2, take a checkpoint c1, create a new output buffer b2\n"</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="stringliteral">" nl-qdisc-add --dev=ifb0 --parent=root --update plug --buffer\n"</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="stringliteral">" # at time t=t2+r, after c1 is committed, release b1\n"</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="stringliteral">" nl-qdisc-add --dev=ifb0 --parent=root --update plug --release-one\n"</span>);</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> }</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">static</span> <span class="keywordtype">void</span> plug_parse_argv(<span class="keyword">struct</span> rtnl_tc *tc, <span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv)</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> {</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">struct </span>rtnl_qdisc *qdisc = (<span class="keyword">struct </span>rtnl_qdisc *) tc;</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">for</span> (;;) {</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">int</span> c, optidx = 0;</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">enum</span> {</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  ARG_LIMIT = 257,</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  ARG_BUFFER = 258,</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  ARG_RELEASE_ONE = 259,</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  ARG_RELEASE_INDEFINITE = 260,</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  };</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">static</span> <span class="keyword">struct </span>option long_opts[] = {</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  { <span class="stringliteral">"help"</span>, 0, 0, <span class="charliteral">'h'</span> },</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  { <span class="stringliteral">"limit"</span>, 1, 0, ARG_LIMIT },</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  { <span class="stringliteral">"buffer"</span>, 0, 0, ARG_BUFFER },</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  { <span class="stringliteral">"release-one"</span>, 0, 0, ARG_RELEASE_ONE },</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  { <span class="stringliteral">"release-indefinite"</span>, 0, 0, ARG_RELEASE_INDEFINITE },</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  { 0, 0, 0, 0 }</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  };</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  c = getopt_long(argc, argv, <span class="stringliteral">"h"</span>, long_opts, &optidx);</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">if</span> (c == -1)</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">break</span>;</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">switch</span> (c) {</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">case</span> <span class="charliteral">'h'</span>:</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  print_usage();</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">return</span>;</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">case</span> ARG_LIMIT:</div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="group__qdisc__plug.html#gad84abc21d3c57d1b6544c63cfdc29354" title="Set limit of PLUG qdisc.">rtnl_qdisc_plug_set_limit</a>(qdisc, <a class="code" href="group__cli.html#gaab66b72df11e32668df817475683b139" title="Parse a text based 32 bit unsigned integer argument.">nl_cli_parse_u32</a>(optarg));</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">break</span>;</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">case</span> ARG_BUFFER:</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="group__qdisc__plug.html#gac99edea24c26b1d67f764f55d6f23a3a" title="Insert a plug into the qdisc and buffer any incoming network traffic.">rtnl_qdisc_plug_buffer</a>(qdisc);</div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">break</span>;</div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">case</span> ARG_RELEASE_ONE:</div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="group__qdisc__plug.html#ga227abe49142b47690a7dadb641da3929" title="Unplug the qdisc, releasing packets from queue head to the last complete buffer, while new traffic co...">rtnl_qdisc_plug_release_one</a>(qdisc);</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">break</span>;</div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">case</span> ARG_RELEASE_INDEFINITE:</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="group__qdisc__plug.html#ga0fc52f2490749def8d1fa49310b839f9" title="Indefinitely unplug the qdisc, releasing all packets.">rtnl_qdisc_plug_release_indefinite</a>(qdisc);</div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">break</span>;</div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> }</div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">static</span> <span class="keyword">struct </span><a class="code" href="structnl__cli__tc__module.html">nl_cli_tc_module</a> plug_module =</div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> {</div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  .tm_name = <span class="stringliteral">"plug"</span>,</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  .tm_type = RTNL_TC_TYPE_QDISC,</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  .tm_parse_argv = plug_parse_argv,</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> };</div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keyword">static</span> <span class="keywordtype">void</span> __init plug_init(<span class="keywordtype">void</span>)</div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> {</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  nl_cli_tc_register(&plug_module);</div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> }</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">static</span> <span class="keywordtype">void</span> __exit plug_exit(<span class="keywordtype">void</span>)</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> {</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  nl_cli_tc_unregister(&plug_module);</div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> }</div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_ed02bef592024768f9b5b1a6c6dc41c4.html">cli</a></li><li class="navelem"><a class="el" href="dir_ae7c752c6a4bbe47a2dab86c8cce0484.html">qdisc</a></li><li class="navelem"><b>plug.c</b></li> <li class="footer">Generated on Thu Jan 24 2013 14:39:29 for libnl by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li> </ul> </div> </body> </html>