aboutsummaryrefslogtreecommitdiffstats
path: root/emu-radio/README.md
blob: 1ca631bd3a409bbbe0e049f99e418de0212479e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# Wifi/LTE Emulator

## General description

**Wifi and LTE Emulator** are two applications able to emulate a wifi and a LTE connection between
two machines.

The script emulates a virtual scenario with many Stations/UE connected to one Access Point/enodeB.

In particular:

* The stations/UE are able to move around the access point/enodeB
* The access point/enodeB and the stations/UE are connected through Wi-Fi 802.11n/LTE...
* The wi-fi rate adaptation algorithm is Minstrel
* The 802.11 frames are sent enabling frame aggregation

## Installation from repositories

On Ubuntu 16.04:

```bash
# echo "deb [trusted=yes] https://nexus.fd.io/content/repositories/fd.io.master.ubuntu.$(lsb_release -sc).main/ ./" \
     | sudo tee -a /etc/apt/sources.list.d/99fd.io.list
# sudo apt-get install wifi-emulator lte-emulator
```

## Building from source

### Dependencies

To be able to build/run the script the following libraries have to be installed. On Ubuntu:

*
    **libns3**

    ```bash
    # echo "deb [trusted=yes] https://nexus.fd.io/content/repositories/fd.io.master.ubuntu.$(lsb_release -sc).main/ ./" \
         | sudo tee -a /etc/apt/sources.list.d/99fd.io.list
    # sudo apt-get update
    # sudo apt install ns3sx libns3sx-dev
    ```

    Otherwise you need to download and install the latest version of libns3 by downloading it from
    https://www.nsnam.org/releases/.

    A complete guide to do it can be find at the address
    https://www.nsnam.org/docs/tutorial/html/getting-started.html

    Then you need to apply the patches inside the ns3-patch folder:

    ```bash
    $ cp ns3-patch/tap-bridge.cc $PATH_TO_NS3_FOLDER/src/tap-bridge/model/tap-bridge.cc
    $ cp ns3-patch/epc-tft-classifier.cc $PATH_TO_NS3_FOLDER/src/lte/epc-tft-classifier.cc
    ```

    And then compile ns3 following its building guide.

* **libboost**

    ```bash
    $ sudo apt install libboost-all-dev
    ```

* **libwesocketpp**
    ```bash
    $ sudo apt install libwebsocketpp-dev
    ```

* **libsqlite3**

    ```bash
    $ sudo apt install libsqlite3-dev
    ```

* **libxml2**

    ```bash
    $ sudo apt install libxml2-dev
    ```

### Installation

Under the wifi-emulator/lte-emulator folder:

```bash
$ cmake . && make && sudo make install
```

## Getting started

A trivial scenario consists in 2 machines (AP/enodeB and Station/UE) connected together through this
script.
It requires:

* One virtual machine acting as AP/enodeB
* One virtual machine acting as Station/UE
* Two linux bridges
* Two tap devices

In this example the virtual machines are going to be linux containers, but it works with any virtual
machine.

Linux container reference: [LXD](https://linuxcontainers.org/lxd/getting-started-cli/)

The two linux containers are named *left* and *right*, and all the corresponding bridges/taps are
going to have a similar name.

1. Create the two bridges:

    ```bash
    # ip link add name br-left type bridge && ip link add name br-right type bridge
    ```

2. Create the two taps devices

    ```bash
    # ip tuntap add name tap-left mode tap && ip tuntap add name tap-right mode tap
    ```

3. Configure the taps

    ```bash
    # ip link set dev tap-left promisc on && ip link set dev tap-right promisc on
    # ip addr add dev tap-left 0.0.0.0 && ip addr add dev tap-right 0.0.0.0
    # ip link set tap-left up && ip link set tap-right up
    ```

4. Connect the taps to the corresponding bridges:

    ```bash
    # ip link set tap-left master br-left && ip link set tap-right master br-right
    ```

5. Bring up the bridges

    ```bash
    # ip link set br-left up && ip link set br-right up
    ```

6. Create the two linux containers, bridging them to the right bridge

    ```bash
    $ lxc launch ubuntu:xenial left -p && lxc config device add left eth0 nic nictype=bridged parent=br-left hwaddr=00:16:3e:00:00:01
    $ lxc launch ubuntu:xenial right -p && lxc config device add right eth0 nic nictype=bridged parent=br-right hwaddr=00:16:3e:00:00:02
    ```

7. Restart the containers

    ```bash
    $ lxc restart left && lxc restart right
    ```

8. Assign an IP address to each container

    ```bash
    $ lxc exec left -- ip addr add 192.168.1.1/24 brd + dev eth0 && lxc exec right -- ip addr add 192.168.1.2/24 brd + dev eth0
    ```

9. Run the emulator script. In this case the left container will be the access point/enodeB while
the right container will be the station/UE.

    802.11n:

    ```bash
    # wifi_emulator --bs-x=0.0 --bs-mac=00:16:3e:00:00:01 --bs-y=0.0 --n-sta=1 --sta-list=right --bs-name=left \
                    --experiment-id=exp1 --sta-taps=tap-right --bs-tap=tap-left --sta-macs=00:16:3e:00:00:02   \
                    --control-port=41010
    ```

    LTE

    ```bash
    # lte_emulator --isFading=true --distance=3500 --bs-x=0.0 --bs-mac=00:16:3e:00:00:01 --bs-y=0.0 --n-sta=1          \
                   --sta-list=right --bs-name=left  --experiment-id=exp1 --sta-taps=tap-right --bs-tap=tap-left        \
                   --sta-macs=00:16:3e:00:00:02   --control-port=41010 --sta-ips=192.168.1.2/24 --bs-ip=192.168.1.1/24 \
                   --printIP=true --logging=true --txBuffer=8000000
    ```

10. Test connectivity by a simple ping test

    ```bash
    $ lxc exec left -- ping 192.168.1.2
    ``

## Talking with the simulation

This script also allows to be controlled and to export internal statistics through a websocket
connection. So far the only available parameters are the mobility model/position of the stations/UE
inside the simulation and the physical tranmission rate.

For setting/retrieving one of these parameters a json object with the following format has to be
sent through the websocket connection:

{object_name: <interface>, fields: <x,y,rate>, params: <x=1,y=2..>, action: <select, update, subscribe..>, filter: [['x', '==', '21']], last: <true, false>}

This json object represents a SQL query/update. In particular:


* **object_name** is the name of the object to query/update. So far the only supported object is
**interface**.

* **fields** is a list representing the name of the field to select. The supported fields are the
**x and y** coordinates of the station/ue and the physical transmission rate.

* **params** is a dictionary containing the keys/values to update. The keys are the fields, while
the values are the new values to update.

* **action** is the action to perform. So far **update, select and subscribe** are supported.

* **filter** is a list containing the filters to select a particular object inside the simulation.
The only filter available is the **node_id**.