deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

native IP gateway mote plugin: enables IP communication with simulated networks, such as with ping or telnet

Browse source
This commit is contained in:
fros4943 2008-12-09 16:57:57 +00:00
parent 532ebc1e9a
commit d45aafc2bb
3 changed files with 685 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
tools/cooja/apps/native_gateway/build.xml Normal file
View file

@ -0,0 +1,35 @@
<?xml version="1.0"?>
<project name="Native IP Gateway" default="jar" basedir=".">
<property name="java" location="java"/>
<property name="build" location="build"/>
<property name="lib" location="lib"/>
<property name="cooja_jar" value="../../dist/cooja.jar"/>
<target name="init">
<tstamp/>
</target>
<target name="compile" depends="init">
<mkdir dir="${build}"/>
<javac srcdir="${java}" destdir="${build}" debug="on">
<classpath>
<pathelement path="."/>
<pathelement location="${cooja_jar}"/>
</classpath>
</javac>
</target>
<target name="clean" depends="init">
<delete dir="${build}"/>
</target>
<target name="jar" depends="clean, init, compile">
<jar destfile="${lib}/native_gateway.jar" basedir="${build}">
<manifest>
<attribute name="Class-Path" value="."/>
</manifest>
</jar>
</target>
</project>

2
tools/cooja/apps/native_gateway/cooja.config Normal file
View file

@ -0,0 +1,2 @@
se.sics.cooja.GUI.PLUGINS = + se.sics.cooja.plugins.NativeIPGateway
se.sics.cooja.GUI.JARFILES = + native_gateway.jar

648
tools/cooja/apps/native_gateway/java/se/sics/cooja/plugins/NativeIPGateway.java Normal file
View file

@ -0,0 +1,648 @@
/*
* Copyright (c) 2008, Swedish Institute of Computer Science.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the Institute nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $Id: NativeIPGateway.java,v 1.1 2008/12/09 16:57:57 fros4943 Exp $
*/
package se.sics.cooja.plugins;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.io.IOException;
import java.util.Collection;
import java.util.Observable;
import java.util.Observer;
import java.util.Vector;
import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.JCheckBox;
import javax.swing.JComboBox;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import jpcap.JpcapCaptor;
import jpcap.JpcapSender;
import jpcap.NetworkInterface;
import jpcap.packet.EthernetPacket;
import jpcap.packet.IPPacket;
import org.apache.log4j.Logger;
import org.jdom.Element;
import se.sics.cooja.ClassDescription;
import se.sics.cooja.GUI;
import se.sics.cooja.Mote;
import se.sics.cooja.PluginType;
import se.sics.cooja.Simulation;
import se.sics.cooja.VisPlugin;
import se.sics.cooja.interfaces.SerialPort;
@ClassDescription("Open Native IP Gateway")
@PluginType(PluginType.MOTE_PLUGIN)
public class NativeIPGateway extends VisPlugin {
private static Logger logger = Logger.getLogger(NativeIPGateway.class);
private static final long serialVersionUID = 1L;
private final static int IP_HEADER_LEN = 20;
private final static byte SLIP_END = (byte)0300;
private final static byte SLIP_ESC = (byte)0333;
private final static byte SLIP_ESC_END = (byte)0334;
private final static byte SLIP_ESC_ESC = (byte)0335;
private final static int LABEL_WIDTH = 170;
private final static int LABEL_HEIGHT = 20;
private Mote mote;
private SerialPort serialPort = null;
private boolean registeredGateway = false;
private NetworkInterface[] networkInterfacesAll;
private NetworkInterface networkInterface = null;
private Thread captureThread = null;
private JpcapCaptor captor = null;
private JpcapSender sender = null;
private String moteIP = null;
private byte[] networkInterfaceMAC = new byte[6];
private boolean shutdownCaptureThread = false;
private int inPkts = 0, outPkts = 0;
private JLabel gatewayLabel = null;
private JLabel interfaceLabel = null;
private JLabel macLabel = null;
private JLabel ipLabel = null;
private JLabel inLabel = null;
private JLabel outLabel = null;
private JComboBox selectNICComboBox;
private JCheckBox autoRegisterRoutes;
public NativeIPGateway(Mote mote, Simulation simulation, GUI gui) {
super("Native IP Gateway (" + mote + ")", gui);
this.mote = mote;
serialPort = (SerialPort) mote.getInterfaces().getLog();
/* Mote serial port */
if (serialPort == null) {
throw new RuntimeException("No mote serial port");
}
/* Mote IP address */
if (mote.getInterfaces().getIPAddress() == null) {
throw new RuntimeException("No IP address interface found (need IP address)");
}
moteIP = mote.getInterfaces().getIPAddress().getIPString();
mote.getInterfaces().getIPAddress().addObserver(new Observer() {
public void update(Observable obs, Object obj) {
moteIP = NativeIPGateway.this.mote.getInterfaces().getIPAddress().getIPString();
try {
if (captor != null) {
String[] ipSplit = moteIP.split("\\.");
String filter = "ip and dst net " + ipSplit[0] + "." + ipSplit[1];
if (autoRegisterRoutes.isSelected()) {
updateNativeRoute();
}
captor.setFilter(filter, true);
if (ipLabel != null) {
ipLabel.setText(moteIP);
}
}
} catch (IOException e) {
e.printStackTrace();
}
}
});
/* Observe serial port for outgoing IP packets */
serialPort.addSerialDataObserver(new Observer() {
public void update(Observable obs, Object obj) {
readSlipAccumulated(serialPort.getLastSerialData());
}
});
autoRegisterRoutes = new JCheckBox();
autoRegisterRoutes.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
if (autoRegisterRoutes.isSelected()) {
updateNativeRoute();
}
}
});
/* Network interfaces list */
networkInterfacesAll = JpcapCaptor.getDeviceList();
if (networkInterfacesAll == null || networkInterfacesAll.length == 0) {
throw new RuntimeException("No network interfaces found");
}
selectNICComboBox = new JComboBox();
for (NetworkInterface networkInterface2 : networkInterfacesAll) {
selectNICComboBox.addItem(networkInterface2.description + " (" + networkInterface2.name + ")");
}
selectNICComboBox.addItemListener(new ItemListener() {
public void itemStateChanged(ItemEvent e) {
if (e.getStateChange() != ItemEvent.SELECTED) {
return;
}
/* Detect selected network interface */
String descr = (String) ((JComboBox)e.getSource()).getSelectedItem();
NetworkInterface selected = null;
for (NetworkInterface networkInterface2 : networkInterfacesAll) {
String label = networkInterface2.description + " (" + networkInterface2.name + ")";
if (label.equals(descr)) {
selected = networkInterface2;
break;
}
}
if (selected == null) {
logger.fatal("Unknown network interface: " + descr);
return;
}
/* Activate network interface */
if (selected == networkInterface) {
return;
}
startCapturingPackets(selected);
}
});
/* GUI components */
JPanel mainPane = new JPanel();
mainPane.setBorder(BorderFactory.createEmptyBorder(10, 10, 10, 10));
mainPane.setLayout(new BoxLayout(mainPane, BoxLayout.Y_AXIS));
ipLabel = addInfo(mainPane, "Mote IP Address:", moteIP);
ipLabel.setToolTipText(null);
addComponent(mainPane, "Capture on: ", selectNICComboBox);
addComponent(mainPane, "Auto-register native route: ", autoRegisterRoutes);
addInfo(mainPane, "", "");
interfaceLabel = addInfo(mainPane, "Network Interface:", "?");
gatewayLabel = addInfo(mainPane, "Network Gateway:", "?");
macLabel = addInfo(mainPane, "Network MAC: ", "?");
inLabel = addInfo(mainPane, "Packets to simulation:", "0");
inLabel.setToolTipText(null);
outLabel = addInfo(mainPane, "Packets from simulation:", "0");
outLabel.setToolTipText(null);
this.getContentPane().add(BorderLayout.CENTER,
new JScrollPane(mainPane,
JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED,
JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED));
pack();
setSize(getWidth()+10, getHeight()+10);
startCapturingPackets(networkInterfacesAll[0]);
try {
setSelected(true);
} catch (java.beans.PropertyVetoException e) {
// Could not select
}
}
private void startCapturingPackets(NetworkInterface intf) {
/* Wait for old capture thread to exit */
if (captureThread != null &&
captureThread.isAlive()) {
shutdownCaptureThread = true;
try {
captureThread.join();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
captureThread = null;
/* Start listening on selected network interface */
networkInterface = intf;
/* Capture thread for incoming IP packets */
captureThread = new Thread() {
public void run() {
shutdownCaptureThread = false;
/*logger.info("Capture thread started");*/
try {
captor = JpcapCaptor.openDevice(networkInterface, 65535, true, 20);
captor.setNonBlockingMode(false);
String[] ipSplit = moteIP.split("\\.");
if (ipSplit.length != 4) {
logger.fatal("Bad mote IP address: " + moteIP);
}
String filter = "ip and dst net " + ipSplit[0] + "." + ipSplit[1];
captor.setFilter(filter, true);
} catch (IOException e) {
e.printStackTrace();
return;
}
while (!shutdownCaptureThread) {
IPPacket packet = (IPPacket) captor.getPacket();
if (packet == null) {
continue;
}
if (!moteIP.equals("0.0.0.0")) {
handleIncomingPacket(packet);
}
}
/*logger.info("Capture thread terminated");*/
}
};
captureThread.start();
/* Prepare packet sender */
try {
if (sender != null) {
sender.close();
}
sender = null;
sender = JpcapSender.openDevice(networkInterface);
} catch (IOException e) {
logger.fatal("Can not send packets on this network interface");
if (sender != null) {
sender.close();
}
sender = null;
}
System.arraycopy(networkInterface.mac_address, 0, networkInterfaceMAC, 0, 6);
if (autoRegisterRoutes.isSelected()) {
updateNativeRoute();
}
/* Update GUI */
interfaceLabel.setText(networkInterface.description);
interfaceLabel.setToolTipText(networkInterface.description);
if (networkInterface.addresses.length > 0) {
gatewayLabel.setText(networkInterface.addresses[0].address.getHostAddress());
gatewayLabel.setToolTipText(networkInterface.addresses[0].address.getHostAddress());
} else {
gatewayLabel.setText("[no gateway]");
gatewayLabel.setToolTipText("");
}
macLabel.setText(Integer.toHexString(networkInterfaceMAC[0]&0xFF) +
":" + Integer.toHexString(networkInterfaceMAC[1]&0xFF) +
":" + Integer.toHexString(networkInterfaceMAC[2]&0xFF) +
":" + Integer.toHexString(networkInterfaceMAC[3]&0xFF) +
":" + Integer.toHexString(networkInterfaceMAC[4]&0xFF) +
":" + Integer.toHexString(networkInterfaceMAC[5]&0xFF));
macLabel.setToolTipText(Integer.toHexString(networkInterfaceMAC[0]&0xFF) +
":" + Integer.toHexString(networkInterfaceMAC[1]&0xFF) +
":" + Integer.toHexString(networkInterfaceMAC[2]&0xFF) +
":" + Integer.toHexString(networkInterfaceMAC[3]&0xFF) +
":" + Integer.toHexString(networkInterfaceMAC[4]&0xFF) +
":" + Integer.toHexString(networkInterfaceMAC[5]&0xFF));
selectNICComboBox.setSelectedItem(networkInterface.description + " (" + networkInterface.name + ")");
}
private final String FAKE_GATEWAY_IP_D = "254";
private final String NETMASK = "255.255.0.0";
private String deleteRouteCmd = null;
private void updateNativeRoute() {
if (mote.getInterfaces().getIPAddress().getIPString().equals("0.0.0.0")) {
/*logger.info("Not adding route, mote has no IP: " +
mote.getInterfaces().getIPAddress().getIPString());*/
return;
}
if (networkInterface.addresses.length <= 0) {
return;
}
String osName = System.getProperty("os.name").toLowerCase();
if (osName.startsWith("win")) {
updateNativeRouteWindows();
} else {
updateNativeRouteLinux();
}
}
private void updateNativeRouteLinux() {
logger.fatal("updateNativeRouteLinux() not implemented");
/* ifconfig tap0 inet 192.168.250.1") */
/* route delete 172.16.0.0/16 */
/* route add 172.16.0.0/16 192.168.250.2 */
}
private void updateNativeRouteWindows() {
if (deleteRouteCmd != null) {
logger.info("Deleting old route: '" + deleteRouteCmd + "'");
try {
Process routeProcess = Runtime.getRuntime().exec(deleteRouteCmd);
routeProcess.waitFor();
} catch (IOException e) {
e.printStackTrace();
} catch (InterruptedException e) {
e.printStackTrace();
}
deleteRouteCmd = null;
}
String moteNetIP =
mote.getInterfaces().getIPAddress().getIPString().split("\\.")[0] + "." +
mote.getInterfaces().getIPAddress().getIPString().split("\\.")[1] + "." +
"0.0";
/*logger.info("Simulation IP net : " + moteNetIP);*/
String gatewayIP =
(0xFF&networkInterface.addresses[0].address.getAddress()[0]) + "." +
(0xFF&networkInterface.addresses[0].address.getAddress()[1]) + "." +
(0xFF&networkInterface.addresses[0].address.getAddress()[2]) + "." +
FAKE_GATEWAY_IP_D;
/*logger.info("Gateway IP: " + gatewayIP);*/
/*logger.info("Netmask: " + NETMASK);*/
String cmd = "route add " + moteNetIP + " mask " + NETMASK + " " + gatewayIP;
try {
logger.info("Adding new route: '" + cmd + "'");
Process routeProcess = Runtime.getRuntime().exec(cmd);
routeProcess.waitFor();
deleteRouteCmd = "route delete " + moteNetIP;
} catch (IOException e) {
e.printStackTrace();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
private void handleIncomingPacket(IPPacket packet) {
if (!registeredGateway) {
/* Make mote register as gateway (only needed once) */
writeAsSlip("?IPA".getBytes(), serialPort);
registeredGateway = true;
}
/*logger.debug("tot length : " + packet.len);
logger.debug("ip proto: " + packet.protocol);
logger.debug("ip length : " + packet.length);
logger.debug("ip header length : " + packet.header.length);
logger.debug("ip data length : " + packet.data.length);*/
/* Send IP packet data (without captured non-IP header) */
int offset = packet.len - packet.length;
byte[] packetData = new byte[packet.header.length + packet.data.length - offset];
System.arraycopy(packet.header, offset, packetData, 0, packet.header.length-offset);
System.arraycopy(packet.data, 0, packetData, packet.header.length-offset, packet.data.length);
writeAsSlip(packetData, serialPort);
/* Update GUI */
inPkts++;
inLabel.setText("" + inPkts);
}
private void handleOutgoingPacket(byte[] packetData) {
if (sender == null) {
logger.warn("No sender instance, dropping outgoing packet");
return;
}
/* Sanity check outgoing data */
if (packetData.length < IP_HEADER_LEN) {
/*logger.warn("Ignoring small packet: " + packetData.length);*/
return;
}
if (packetData[0] != 0x45) {
/*logger.warn("Ignoring bad header:" +
" 0x" + Integer.toHexString(packetData[0]&0xFF));*/
return;
}
/* Create packet */
jpcap.packet.Packet packet = new jpcap.packet.Packet();
packet.header = new byte[0];
packet.data = packetData;
packet.len = packetData.length;
/* Link ethernet frame */
EthernetPacket ether = new EthernetPacket();
ether.frametype = EthernetPacket.ETHERTYPE_IP;
ether.dst_mac = networkInterfaceMAC;
ether.src_mac = networkInterfaceMAC;
packet.datalink = ether;
/*logger.info("Sending packet to native network: " + packet.len);*/
sender.sendPacket(packet);
/* Update GUI */
outPkts++;
outLabel.setText("" + outPkts);
}
/**
* Wraps packet as SLIP.
*
* @param packet Packet data
*/
private static void writeAsSlip(byte[] packet, SerialPort serialPort) {
serialPort.writeByte(SLIP_END);
for (byte b: packet) {
if (b == SLIP_END) {
serialPort.writeByte(SLIP_ESC);
serialPort.writeByte(SLIP_ESC_END);
} else if (b == SLIP_ESC) {
serialPort.writeByte(SLIP_ESC);
serialPort.writeByte(SLIP_ESC_ESC);
} else {
serialPort.writeByte(b);
}
}
serialPort.writeByte(SLIP_END);
}
public enum SlipState {
STATE_OK,
STATE_ESC,
STATE_RUBBISH
}
private SlipState readSlipState = SlipState.STATE_OK;
private int readSlipLength = 0;
private final int READ_SLIP_BUFFER_SIZE = 256;
private byte[] readSlipBuffer = new byte[READ_SLIP_BUFFER_SIZE];
private boolean readSlipAccumulated(byte b) {
switch (readSlipState) {
case STATE_RUBBISH:
readSlipLength = 0;
if(b == SLIP_END) {
readSlipState = SlipState.STATE_OK;
}
return false;
case STATE_ESC:
if(b == SLIP_ESC_END) {
b = SLIP_END;
} else if (b == SLIP_ESC_ESC) {
b = SLIP_ESC;
} else {
readSlipState = SlipState.STATE_RUBBISH;
readSlipLength = 0;
return false;
}
readSlipState = SlipState.STATE_OK;
break;
case STATE_OK:
if(b == SLIP_ESC) {
readSlipState = SlipState.STATE_ESC;
return false;
} else if (b == SLIP_END) {
/* Handle outgoing packet */
byte[] packet = new byte[readSlipLength];
System.arraycopy(readSlipBuffer, 0, packet, 0, readSlipLength);
handleOutgoingPacket(packet);
readSlipLength = 0;
return true;
}
}
/* Receive byte */
readSlipBuffer[readSlipLength] = b;
readSlipLength++;
if (readSlipLength >= READ_SLIP_BUFFER_SIZE) {
readSlipState = SlipState.STATE_RUBBISH;
readSlipLength = 0;
}
return false;
}
private JLabel addInfo(JPanel pane, String desc, String value) {
JPanel smallPane = new JPanel(new BorderLayout());
JLabel label = new JLabel(desc);
label.setPreferredSize(new Dimension(LABEL_WIDTH,LABEL_HEIGHT));
smallPane.add(BorderLayout.WEST, label);
label = new JLabel(value);
label.setPreferredSize(new Dimension(LABEL_WIDTH,LABEL_HEIGHT));
label.setToolTipText(value);
smallPane.add(BorderLayout.CENTER, label);
pane.add(smallPane);
pane.add(Box.createRigidArea(new Dimension(0,10)));
return label;
}
private Component addComponent(JPanel pane, String desc, Component comp) {
JPanel smallPane = new JPanel(new BorderLayout());
JLabel label = new JLabel(desc);
label.setPreferredSize(new Dimension(LABEL_WIDTH,LABEL_HEIGHT));
smallPane.add(BorderLayout.WEST, label);
comp.setPreferredSize(new Dimension(LABEL_WIDTH,LABEL_HEIGHT));
smallPane.add(BorderLayout.CENTER, comp);
pane.add(smallPane);
pane.add(Box.createRigidArea(new Dimension(0,10)));
return comp;
}
public boolean setConfigXML(Collection<Element> configXML, boolean visAvailable) {
for (Element element : configXML) {
if (element.getName().equals("network_interface")) {
boolean ok = false;
for (NetworkInterface intf: networkInterfacesAll) {
if (intf.name.equals(element.getText())) {
startCapturingPackets(intf);
ok = true;
break;
}
}
if (!ok) {
logger.warn("Network interface not available: " + element.getText());
logger.warn("Instead capturing on default network interface: " + selectNICComboBox.getItemAt(0));
}
} else if (element.getName().equals("register_routes")) {
autoRegisterRoutes.setSelected(Boolean.parseBoolean(element.getText()));
} else {
return false;
}
}
return true;
}
public Collection<Element> getConfigXML() {
Vector<Element> config = new Vector<Element>();
Element element;
element = new Element("network_interface");
element.setText(networkInterface.name);
config.add(element);
element = new Element("register_routes");
element.setText("" + autoRegisterRoutes.isSelected());
config.add(element);
return config;
}
public void closePlugin() {
if (deleteRouteCmd != null) {
logger.info("Deleting old route: '" + deleteRouteCmd + "'");
try {
Process routeProcess = Runtime.getRuntime().exec(deleteRouteCmd);
routeProcess.waitFor();
} catch (IOException e) {
e.printStackTrace();
} catch (InterruptedException e) {
e.printStackTrace();
}
deleteRouteCmd = null;
}
shutdownCaptureThread = true;
if (sender != null) {
sender.close();
}
}
}