GSOC2010Click - Revision history

Lalith: /* Build Instructions */

2010-08-05T15:08:18Z

Build Instructions

← Older revision		Revision as of 15:08, 5 August 2010
Line 165:		Line 165:
	*Note: You don't need to do a 'make install'.		*Note: You don't need to do a 'make install'.

	Once Click has been built successfully, ~~we proceed to~~ configure ns-3 with Click Integration support:		Once Click has been built successfully, change into the ns-3 directory and configure ns-3 with Click Integration support:
	<pre>		<pre>
	$: ./waf configure --with-nsclick=/path/to/click/source		$: ./waf configure --with-nsclick=/path/to/click/source

Lalith: /* Build Instructions */

2010-08-05T12:55:50Z

Build Instructions

← Older revision		Revision as of 12:55, 5 August 2010
Line 157:		Line 157:
	The first step is to build Click. At the top of your Click source directory:		The first step is to build Click. At the top of your Click source directory:
	<pre>		<pre>
	$: ./configure --enable-userlevel --disable-linuxmodule --enable-nsclick		$: ./configure --enable-userlevel --disable-linuxmodule --enable-nsclick --enable-wifi
	$: make		$: make
	</pre>		</pre>

	~~In order to use Click with Wifi, you'll need to pass the~~ --enable-wifi flag ~~to configure as well~~.		The --enable-wifi flag may be skipped if you don't intend on using Click with Wifi.

	*Note: You don't need to do a 'make install'.		*Note: You don't need to do a 'make install'.

Lalith: /* Build Instructions */

2010-08-05T12:51:30Z

Build Instructions

← Older revision		Revision as of 12:51, 5 August 2010
Line 160:		Line 160:
	$: make		$: make
	</pre>		</pre>

			In order to use Click with Wifi, you'll need to pass the --enable-wifi flag to configure as well.

	*Note: You don't need to do a 'make install'.		*Note: You don't need to do a 'make install'.

Lalith: /* Click Graph Instructions */

2010-08-03T18:24:42Z

Click Graph Instructions

← Older revision		Revision as of 18:24, 3 August 2010
Line 187:		Line 187:
	* A routing table element is a mandatory. The OUTports of the routing table element should correspond to the interface number of the device through which the packet will ultimately be sent out. Violating this rule will lead to really weird packet traces. This routing table element's name should then be passed to the Ipv4ClickRouting protocol object as a simulation parameter. See the Click examples for details.		* A routing table element is a mandatory. The OUTports of the routing table element should correspond to the interface number of the device through which the packet will ultimately be sent out. Violating this rule will lead to really weird packet traces. This routing table element's name should then be passed to the Ipv4ClickRouting protocol object as a simulation parameter. See the Click examples for details.
	* When using Wifi with ns-3-click, do not use wifi specific elements like WifiEncap, ExtraEncap, MadWifiRate etc. for outgoing packets. Incoming packets should have their Wifi headers removed using WifiDecap + ExtraDecap or Strip elements. See the nsclick-raw-wlan.click file for an idea of the same.		* When using Wifi with ns-3-click, do not use wifi specific elements like WifiEncap, ExtraEncap, MadWifiRate etc. for outgoing packets. Incoming packets should have their Wifi headers removed using WifiDecap + ExtraDecap or Strip elements. See the nsclick-raw-wlan.click file for an idea of the same.
			* When using Point to Point devices with Click, you needn't strip off any bytes when a packet is received from a device. Normally, this will leave you with an IP encapsulated packet.
	* The current implementation leaves Click with mainly L3 functionality, with ns-3 handling L2. We will soon begin working to support the use of MAC protocols on Click as well.		* The current implementation leaves Click with mainly L3 functionality, with ns-3 handling L2. We will soon begin working to support the use of MAC protocols on Click as well.

Lalith: /* Progress */

2010-07-21T14:35:33Z

Progress

← Older revision		Revision as of 14:35, 21 July 2010
Line 149:		Line 149:
	* July 3rd, 2010: IP Router Click graph tested successfully. (examples/click/nsclick-routing.cc)		* July 3rd, 2010: IP Router Click graph tested successfully. (examples/click/nsclick-routing.cc)
	* July 6th, 2010: Helper classes implemented.		* July 6th, 2010: Helper classes implemented.
			* July 20th, 2010: Added an example test for Click in the test.py framework

	= Using ns-3-click =		= Using ns-3-click =

Lalith at 13:21, 16 July 2010

2010-07-16T13:21:17Z

← Older revision		Revision as of 13:21, 16 July 2010
Line 1:		Line 1:
			= Code =

			The NS-3 Click Integration code is publicly available [http://code.nsnam.org/lalith/ns-3-click here].

	= Approach =		= Approach =

Lalith: /* Click Graph Instructions */

2010-07-07T04:01:04Z

Click Graph Instructions

← Older revision		Revision as of 04:01, 7 July 2010
Line 179:		Line 179:
	* You will need to replace FromDevice and ToDevice elements with FromSimDevice and ToSimDevice elements.		* You will need to replace FromDevice and ToDevice elements with FromSimDevice and ToSimDevice elements.
	* Packets to the kernel are sent up using ToSimDevice(tap0,IP).		* Packets to the kernel are sent up using ToSimDevice(tap0,IP).
	* For any node, the 0th device will be tap0. The devices should be eth0, eth1 and so forth (even if you're using wifi). Please note that the device numbering should begin from 0.		* For any node, the 0th device will be tap0. The remaining devices should be eth0, eth1 and so forth (even if you're using wifi). Please note that the device numbering should begin from 0.
	* A routing table element is a mandatory. The OUTports of the routing table element should correspond to the interface number of the device through which the packet will ultimately be sent out. Violating this rule will lead to really weird packet traces. This routing table element's name should then be passed to the Ipv4ClickRouting protocol object as a simulation parameter. See the Click examples for details.		* A routing table element is a mandatory. The OUTports of the routing table element should correspond to the interface number of the device through which the packet will ultimately be sent out. Violating this rule will lead to really weird packet traces. This routing table element's name should then be passed to the Ipv4ClickRouting protocol object as a simulation parameter. See the Click examples for details.
	* When using Wifi with ns-3-click, do not use wifi specific elements like WifiEncap, ExtraEncap, MadWifiRate etc. for outgoing packets. Incoming packets should have their Wifi headers removed using WifiDecap + ExtraDecap or Strip elements. See the nsclick-raw-wlan.click file for an idea of the same.		* When using Wifi with ns-3-click, do not use wifi specific elements like WifiEncap, ExtraEncap, MadWifiRate etc. for outgoing packets. Incoming packets should have their Wifi headers removed using WifiDecap + ExtraDecap or Strip elements. See the nsclick-raw-wlan.click file for an idea of the same.

Lalith: /* Using ns-3-click */

2010-07-06T16:43:24Z

Using ns-3-click

← Older revision		Revision as of 16:43, 6 July 2010
Line 183:		Line 183:
	* When using Wifi with ns-3-click, do not use wifi specific elements like WifiEncap, ExtraEncap, MadWifiRate etc. for outgoing packets. Incoming packets should have their Wifi headers removed using WifiDecap + ExtraDecap or Strip elements. See the nsclick-raw-wlan.click file for an idea of the same.		* When using Wifi with ns-3-click, do not use wifi specific elements like WifiEncap, ExtraEncap, MadWifiRate etc. for outgoing packets. Incoming packets should have their Wifi headers removed using WifiDecap + ExtraDecap or Strip elements. See the nsclick-raw-wlan.click file for an idea of the same.
	* The current implementation leaves Click with mainly L3 functionality, with ns-3 handling L2. We will soon begin working to support the use of MAC protocols on Click as well.		* The current implementation leaves Click with mainly L3 functionality, with ns-3 handling L2. We will soon begin working to support the use of MAC protocols on Click as well.

			== Setting up a Click based node ==

			To have a node run Click, the easiest way would be to use the ClickInternetStackHelper class in your simulation script. For instance:
			<pre>
			ClickInternetStackHelper click;
			click.SetClickFile (myNodeContainer, "nsclick-simple-lan.click");
			click.SetRoutingTableElement (myNodeContainer, "u/rt");
			click.Install (myNodeContainer);
			</pre>

			The example scripts inside examples/click/ demonstrate the use of Click based nodes in different scenarios.

Lalith: /* Click Graph Instructions */

2010-07-06T16:37:26Z

Click Graph Instructions

← Older revision		Revision as of 16:37, 6 July 2010
Line 176:		Line 176:
	The following should be kept in mind when making your Click graph:		The following should be kept in mind when making your Click graph:

	1) Only userlevel elements can be used.		* Only userlevel elements can be used.
	2) You will need to replace FromDevice and ToDevice elements with FromSimDevice and ToSimDevice elements.		* You will need to replace FromDevice and ToDevice elements with FromSimDevice and ToSimDevice elements.
	3) Packets to the kernel are sent up using ToSimDevice(tap0,IP).		* Packets to the kernel are sent up using ToSimDevice(tap0,IP).
	4) For any node, the 0th device will be tap0. The devices should be eth0, eth1 and so forth (even if you're using wifi). Please note that the device numbering should begin from 0.		* For any node, the 0th device will be tap0. The devices should be eth0, eth1 and so forth (even if you're using wifi). Please note that the device numbering should begin from 0.
	5) A routing table element is a mandatory. The OUTports of the routing table element should correspond to the interface number of the device through which the packet will ultimately be sent out. Violating this rule will lead to really weird packet traces. This routing table element's name should then be passed to the Ipv4ClickRouting protocol object as a simulation parameter. See the Click examples for details.		* A routing table element is a mandatory. The OUTports of the routing table element should correspond to the interface number of the device through which the packet will ultimately be sent out. Violating this rule will lead to really weird packet traces. This routing table element's name should then be passed to the Ipv4ClickRouting protocol object as a simulation parameter. See the Click examples for details.
	6) When using Wifi with ns-3-click, do not use wifi specific elements like WifiEncap, ExtraEncap, MadWifiRate etc. for outgoing packets. Incoming packets should have their Wifi headers removed using WifiDecap + ExtraDecap or Strip elements. See the nsclick-raw-wlan.click file for an idea of the same.		* When using Wifi with ns-3-click, do not use wifi specific elements like WifiEncap, ExtraEncap, MadWifiRate etc. for outgoing packets. Incoming packets should have their Wifi headers removed using WifiDecap + ExtraDecap or Strip elements. See the nsclick-raw-wlan.click file for an idea of the same.
	7) The current implementation leaves Click with mainly L3 functionality, with ns-3 handling L2. We will soon begin working to support the use of MAC protocols on Click as well.		* The current implementation leaves Click with mainly L3 functionality, with ns-3 handling L2. We will soon begin working to support the use of MAC protocols on Click as well.

Lalith: /* Approach */

2010-07-06T16:32:21Z

Approach

← Older revision		Revision as of 16:32, 6 July 2010
Line 144:		Line 144:
	* June 29th, 2010: Wifi and CSMA now work with a common interface.		* June 29th, 2010: Wifi and CSMA now work with a common interface.
	* July 3rd, 2010: IP Router Click graph tested successfully. (examples/click/nsclick-routing.cc)		* July 3rd, 2010: IP Router Click graph tested successfully. (examples/click/nsclick-routing.cc)
			* July 6th, 2010: Helper classes implemented.

			= Using ns-3-click =

			== Build Instructions ==

			The first step is to build Click. At the top of your Click source directory:
			<pre>
			$: ./configure --enable-userlevel --disable-linuxmodule --enable-nsclick
			$: make
			</pre>

			*Note: You don't need to do a 'make install'.

			Once Click has been built successfully, we proceed to configure ns-3 with Click Integration support:
			<pre>
			$: ./waf configure --with-nsclick=/path/to/click/source
			</pre>

			If it says 'enabled' beside 'NS-3 Click Integration Support', then you're good to go.

			Next, try running one of the examples:
			<pre>
			$: ./waf --run nsclick-simple-lan
			</pre>

			You will find a lot of output being generated. This is because of the IPPrint and Print elements present in the nsclick-simple-lan.click configuration file that the example script uses.

			== Click Graph Instructions ==

			The following should be kept in mind when making your Click graph:

			1) Only userlevel elements can be used.
			2) You will need to replace FromDevice and ToDevice elements with FromSimDevice and ToSimDevice elements.
			3) Packets to the kernel are sent up using ToSimDevice(tap0,IP).
			4) For any node, the 0th device will be tap0. The devices should be eth0, eth1 and so forth (even if you're using wifi). Please note that the device numbering should begin from 0.
			5) A routing table element is a mandatory. The OUTports of the routing table element should correspond to the interface number of the device through which the packet will ultimately be sent out. Violating this rule will lead to really weird packet traces. This routing table element's name should then be passed to the Ipv4ClickRouting protocol object as a simulation parameter. See the Click examples for details.
			6) When using Wifi with ns-3-click, do not use wifi specific elements like WifiEncap, ExtraEncap, MadWifiRate etc. for outgoing packets. Incoming packets should have their Wifi headers removed using WifiDecap + ExtraDecap or Strip elements. See the nsclick-raw-wlan.click file for an idea of the same.
			7) The current implementation leaves Click with mainly L3 functionality, with ns-3 handling L2. We will soon begin working to support the use of MAC protocols on Click as well.