| 1 | <html> |
|---|
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|---|
| 3 | <html> |
|---|
| 4 | <head> |
|---|
| 5 | <title> |
|---|
| 6 | PlanetSim: An Overlay Network Simulation Framework - Documentation |
|---|
| 7 | </title> |
|---|
| 8 | <style type="text/css"> |
|---|
| 9 | @import url("style/tigris.css"); |
|---|
| 10 | @import url("style/maven.css"); |
|---|
| 11 | </style> |
|---|
| 12 | <link rel="stylesheet" href="style/print.css" type="text/css" media="print"></link> |
|---|
| 13 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta> |
|---|
| 14 | </head> |
|---|
| 15 | <body class="composite"> |
|---|
| 16 | <div id="banner0"> |
|---|
| 17 | <table border="0" width="100%" cellpadding="8" cellspacing="0" id="table1"> |
|---|
| 18 | <tr> |
|---|
| 19 | <td> |
|---|
| 20 | <img border="0" src="images/planetsimlogo.jpg" width="251" height="157"><a href="index.htm"><span style="text-decoration: none"></img></span></a> |
|---|
| 21 | <span style="text-decoration: none"> |
|---|
| 22 | <span style="font-weight: 700"><a href="index.html">An Overlay Network Simulation Framework</a></span></span></td> |
|---|
| 23 | <td width="222"> |
|---|
| 24 | <div id="login" align="right"> |
|---|
| 25 | <a href="http://ants.etse.urv.es/planet"> |
|---|
| 26 | <img border="0" src="images/logoplanet.jpg" width="150" height="142"></a></div> |
|---|
| 27 | </td> |
|---|
| 28 | </tr> |
|---|
| 29 | </table> |
|---|
| 30 | </div> |
|---|
| 31 | <div id="breadcrumbs"> |
|---|
| 32 | <table border="0" width="98%" cellpadding="4" cellspacing="0" id="table2"> |
|---|
| 33 | <tr> |
|---|
| 34 | <td width="286"><font size="2">Last Updated: 6 April 2005</font></td> |
|---|
| 35 | <td> |
|---|
| 36 | <div align="right"> |
|---|
| 37 | <font size="2"> |
|---|
| 38 | <a href="http://ants.etse.urv.es/planet"><img class="handle" src="images/none.png" alt=""></img>PLANET Project Page</a> |
|---|
| 39 | | |
|---|
| 40 | <a href="http://www.etse.urv.es/recerca/ast/"><img class="handle" src="images/none.png" alt=""></img>AST |
|---|
| 41 | Research Group</a> |
|---|
| 42 | </font> |
|---|
| 43 | </div> |
|---|
| 44 | </td> |
|---|
| 45 | </tr> |
|---|
| 46 | </table> |
|---|
| 47 | </div> |
|---|
| 48 | <table border="0" width="100%" cellpadding="8" cellspacing="0"> |
|---|
| 49 | <tr valign="top"> |
|---|
| 50 | <td> |
|---|
| 51 | <div id="bodycol"> |
|---|
| 52 | <div class="app"> |
|---|
| 53 | <h3><b> |
|---|
| 54 | <span lang="EN-US" style="font-family: Verdana; color: #FFFBF0"> |
|---|
| 55 | <font size="2">Compile Sources</font></span></b></h3> |
|---|
| 56 | <p> |
|---|
| 57 | <span lang="EN-US" style="font-family: Verdana"> |
|---|
| 58 | <font size="2">PlanetSim is using now ant build utility. You should first download |
|---|
| 59 | and install the jakarta ant library.<br> |
|---|
| 60 | <br> |
|---|
| 61 | Get ant from |
|---|
| 62 | <a style="color: #0164A8; text-decoration: underline; text-underline: single" href="http://jakarta.apache.org/ant/index.html"> |
|---|
| 63 | http://jakarta.apache.org/ant/index.html</a>.<br> |
|---|
| 64 | <br> |
|---|
| 65 | <br> |
|---|
| 66 | In order to install ant you have to set the following environment |
|---|
| 67 | variables:<br> |
|---|
| 68 | <br> |
|---|
| 69 | set ANT_HOME=d:\apps\ant<br> |
|---|
| 70 | set JAVA_HOME=d:\jdk1.4<br> |
|---|
| 71 | set PATH=%PATH%;%ANT_HOME%\bin<br> |
|---|
| 72 | set CLASSPATH=.;%ANT_HOME%\lib\ant.jar;%ANT_HOME%\lib\jaxp.jar;%ANT_HOME%\lib\parser.jar<br> |
|---|
| 73 | <br> |
|---|
| 74 | Once you have installed ant you can now compile and test the planet |
|---|
| 75 | library.<br> |
|---|
| 76 | <br> |
|---|
| 77 | In order to compile you only need to execute ant in the bin |
|---|
| 78 | directory:<br> |
|---|
| 79 | <br> |
|---|
| 80 | >> cd bin<br> |
|---|
| 81 | <br> |
|---|
| 82 | >> ant <br> |
|---|
| 83 | It will generate the file p2p.jar in the jars directory.</font></span></p> |
|---|
| 84 | <h3><span style="background-repeat: repeat"><font size="2">Install</font></span></h3> |
|---|
| 85 | <p class="MsoNormal"> |
|---|
| 86 | <span lang="EN-US" style="font-family: Verdana"> |
|---|
| 87 | <font size="2">The only requirement is a Java JDK1.2.X or superior. Our scripts |
|---|
| 88 | will assume that you already have java and javac in your PATH.</font></span> </br></p> |
|---|
| 89 | <h3><span style="color: #FFFBF0" lang="en-us"> |
|---|
| 90 | <b><span style="font-family: Verdana"><font size="2">Configure Files</font></span></b></span></h3> |
|---|
| 91 | <p class="MsoNormal"><span lang="EN-GB"><font size="2">In each |
|---|
| 92 | simulation, you must have defined and initialized three config. files :</font></span></p> |
|---|
| 93 | <p class="MsoNormal"> </p> |
|---|
| 94 | <p class="MsoNormal"><span lang="EN-GB"><font size="2">a) Simulator |
|---|
| 95 | Propierties</font></span></p> |
|---|
| 96 | <blockquote> |
|---|
| 97 | <p class="MsoNormal"><font size="2"># Events<br> |
|---|
| 98 | DEFAULT_EVENT_FILE = test_random.txt<br> |
|---|
| 99 | <br> |
|---|
| 100 | # Default simulation steps for any node join or leave<br> |
|---|
| 101 | DEFAULT_SIMULATION_STEPS = 2<br> |
|---|
| 102 | <br> |
|---|
| 103 | # Log Level<br> |
|---|
| 104 | # 0 --> error<br> |
|---|
| 105 | # 1 --> events<br> |
|---|
| 106 | # 2 --> node info<br> |
|---|
| 107 | # 3 --> message<br> |
|---|
| 108 | DEFAULT_LOG_LEVEL = 0<br> |
|---|
| 109 | <br> |
|---|
| 110 | # OUTPUT FILE OF THE SERIALIZABLE STATE<br> |
|---|
| 111 | DEFAULT_OUTPUT_FILE = simdata.dat<br> |
|---|
| 112 | <br> |
|---|
| 113 | # For replacing the output file (default=> true)<br> |
|---|
| 114 | DEFAULT_REPLACE_OUTPUT_FILE = true<br> |
|---|
| 115 | <br> |
|---|
| 116 | # Default Timer Class<br> |
|---|
| 117 | DEFAULT_TIMER = planet.util.timer.SimulationTimerImpl<br> |
|---|
| 118 | <br> |
|---|
| 119 | # Default OverlayProperties implementation class<br> |
|---|
| 120 | DEFAULT_OVERLAY_PROPERTIES = planet.chord.ChordProperties<br> |
|---|
| 121 | <br> |
|---|
| 122 | # Queue Size<br> |
|---|
| 123 | DEFAULT_QUEUE_SIZE = 160<br> |
|---|
| 124 | <br> |
|---|
| 125 | # Message Process <br> |
|---|
| 126 | DEFAULT_MSG_PROCESS = 1000</font><br> |
|---|
| 127 | </p> |
|---|
| 128 | </blockquote> |
|---|
| 129 | <p class="MsoNormal"><span lang="EN-GB"><font size="2">b) Factory |
|---|
| 130 | Properties</font></span></p> |
|---|
| 131 | <blockquote> |
|---|
| 132 | <p class="MsoNormal"><font size="2"># Properties for NetworkFactory<br> |
|---|
| 133 | DEFAULT_NETWORK = planet.generic.commonapi.NetworkImpl<br> |
|---|
| 134 | <br> |
|---|
| 135 | # Properties for ApplicationFactory<br> |
|---|
| 136 | DEFAULT_APPLICATION = planet.test.dht.ChordDHTApplication<br> |
|---|
| 137 | DEFAULT_IDCLASS = planet.chord.ChordId<br> |
|---|
| 138 | <br> |
|---|
| 139 | # Properties for NodeFactory<br> |
|---|
| 140 | DEFAULT_IDFACTORY = planet.generic.commonapi.factory.IdFactoryImpl<br> |
|---|
| 141 | DEFAULT_NODECLASS = planet.chord.ChordNode<br> |
|---|
| 142 | <br> |
|---|
| 143 | # Properties for NodeHandleFactory<br> |
|---|
| 144 | DEFAULT_NODEHANDLECLASS = planet.generic.commonapi.NodeHandleImpl<br> |
|---|
| 145 | <br> |
|---|
| 146 | # Properties for NetworkFactory<br> |
|---|
| 147 | # The IdFactory can read DEFAULT_TOPOLOGY and DEFAULT_SIZE<br> |
|---|
| 148 | # to build Ids.<br> |
|---|
| 149 | DEFAULT_NODEFACTORY = |
|---|
| 150 | planet.generic.commonapi.factory.NodeFactoryImpl<br> |
|---|
| 151 | #Topology values: Random | Circular | Serialized<br> |
|---|
| 152 | DEFAULT_TOPOLOGY = Circular<br> |
|---|
| 153 | DEFAULT_SIZE = 100<br> |
|---|
| 154 | DEFAULT_K = 32<br> |
|---|
| 155 | DEFAULT_SERIALIZEDFILE = simdata.dat<br> |
|---|
| 156 | <br> |
|---|
| 157 | #Properties for MessagePool<br> |
|---|
| 158 | DEFAULT_ROUTEMESSAGE = planet.generic.commonapi.RouteMessageImpl<br> |
|---|
| 159 | <br> |
|---|
| 160 | #Properties for EndPointFactory<br> |
|---|
| 161 | DEFAULT_ENDPOINT = planet.generic.commonapi.EndPointImpl</font></p> |
|---|
| 162 | </blockquote> |
|---|
| 163 | <p class="MsoNormal"><span lang="EN-GB"><font size="2">c) Overlay |
|---|
| 164 | Properties (ex. Chord) </font></span></p> |
|---|
| 165 | <blockquote> |
|---|
| 166 | <p class="MsoNormal"><font size="2"># Events<br> |
|---|
| 167 | DEFAULT_STABILIZE_STEPS = 10<br> |
|---|
| 168 | <br> |
|---|
| 169 | # Events<br> |
|---|
| 170 | DEFAULT_FIX_FINGER_STEPS = 5<br> |
|---|
| 171 | <br> |
|---|
| 172 | # Successor List Lenght<br> |
|---|
| 173 | DEFAULT_SUCC_LIST_MAX = 16</font></p> |
|---|
| 174 | </blockquote> |
|---|
| 175 | </div> |
|---|
| 176 | <div class="app"> |
|---|
| 177 | <h3><span style="background-repeat: repeat"><font size="2">Test</font></span></h3> |
|---|
| 178 | <p class="MsoNormal"><span lang="EN-US"><font size="2">To test PlanetSim |
|---|
| 179 | just go to the scripts directory and executes test<br> |
|---|
| 180 | <br> |
|---|
| 181 | </font></span></p> |
|---|
| 182 | <p class="MsoNormal"><span lang="EN-US"><font size="2">>> cd bin<br> |
|---|
| 183 | <br> |
|---|
| 184 | >> ant test</font></span></p> |
|---|
| 185 | <p class="MsoNormal" style="margin-left:18.0pt"><span lang="EN-US"> |
|---|
| 186 | <font size="2"> </font></span></p> |
|---|
| 187 | <p class="MsoNormal"><span lang="EN-US"><font size="2">To see the |
|---|
| 188 | results, enter to bin directory to find the report web directory</font></span></p> |
|---|
| 189 | <b><a href="http://path_planetsim/bin/report/index.html"> |
|---|
| 190 | <span lang="en-us" style="text-decoration: none"><font size="2">file</font></span></a><span lang="EN-US"><font size="2">://PATH_PlanetSim/bin/report/index.html</font></span></b><p></br></p> |
|---|
| 191 | </p> |
|---|
| 192 | </div> |
|---|
| 193 | </div> |
|---|
| 194 | </td> |
|---|
| 195 | </tr> |
|---|
| 196 | </table> |
|---|
| 197 | <div id="footer"> |
|---|
| 198 | <table border="0" style="width:100%" cellpadding="4" cellspacing="0"> |
|---|
| 199 | <tr> |
|---|
| 200 | <td> |
|---|
| 201 | <font size="2">© 2003-2004 Rubén Mondéjar |
|---|
| 202 | <a href="mailto:%3Ccpairot@etse.urv.es"><Ruben.Mondejar@estudiants.urv.es</a>></font></td> |
|---|
| 203 | </tr> |
|---|
| 204 | </table> |
|---|
| 205 | </div> |
|---|
| 206 | </body> |
|---|
| 207 | </html> |
|---|
| 208 | |
|---|
