-
Notifications
You must be signed in to change notification settings - Fork 42
How to install
This document assumes that the reader has already Ubuntu installed on her machine; Ubuntu is not required, but if it is not the case, the reader must make adjustments to the commands here described. Also, it is recommended that the machine used for testing to run the same Ubuntu version of the machine used for compiling the code to avoid libraries and header files mismatches.
The source code of the prototype is kept on GitHub, so in order to install it one has to clone the repository, compile sources, package the binaries, and install. Later on, packages will be available for download to simplify the process.
In order to clone repository, compile sources, and package the kernel, many developments packages must be installed on the reader's machine. A complete list of such packages will be built as this project evolves to help newcomers, but for now assume that the current list is incomplete. The following command install developments packages to proceed:
$ sudo apt-get install git-core kernel-package fakeroot \ build-essential libncurses5-dev libssl-dev
The building process requires a significant amount of memory; especially while linking the kernel. So make sure that the machine you are using to build the kernel has at least 2GB of RAM memory.
Cloning the repository is straightforward, on a shell enter the following commands:
$ git clone git://github.com/AltraMayor/XIA-for-Linux.git
The branch master of this repository is Linus' tree, so the reader will want to stay on the xia branch at all times. Use the following command to switch branches:
$ cd XIA-for-Linux $ git checkout xia
All commands in this section assumes the current path is the root of the local copy of the git repository, and that the branch xia is checked out. If it is not the case, change the current path, and check out branch xia now by doing:
$ cd XIA-for-Linux $ git checkout xia
Before compiling the kernel, one has to configure it. The following commands copy the configuration on the machine used, and fill the rest of the options with defaults. There will usually be new options because it is the development kernel.
$ cp /boot/config-`uname -r` .config $ yes '' | make oldconfig
XIA is an experimental feature, so it must be enabled to be included in the kernel. The command below allows one to do it through a text-based interface:
$ make nconfig
You may also want to use a graphical interface; you can open a graphical configuration program by using make xconfig or make gconfig, but you will need to install more packages for these programs than mentioned above.
XIA can be built into the kernel, or as a module. Building as a module is better for testing and debugging. Just enable XIA as a module at "Networking support / Networking options / eXpressive Internet Achitecture (EXPERIMENTAL)", add any principal module that is available, save, and exit the interface.
If it is the first time the kernel will be compiled, the following steps are also necessary:
$ make prepare $ sed -rie 's/echo "\+"/#echo "\+"/' scripts/setlocalversion
The previous commands will avoid a problem with the package system that does not like "+" in the name of packages.
Finally to compile and package, use the following commands:
$ make-kpkg clean
$ CONCURRENCY_LEVEL=`getconf _NPROCESSORS_ONLN` fakeroot \
make-kpkg --initrd --append-to-version=-xia --revision=05 \
kernel_image kernel_headers
Change "--revision" as needed; it is just a number to help between releases. The commands above will take awhile; if your machine is old, they take hours. It is a good moment for stretching.
IMPORTANT: If the command above finishes with an error like the one below, you have to update your package kernel-package to version 13.003 or higher. See solution below.
run-parts: executing /etc/kernel/postinst.d/apt-auto-removal 3.17.0-rc4-xia /home/michel/git/xia/linux/debian/linux-image-3.17.0-rc4-xia//boot/vmlinuz-3.17.0-rc4-xia /etc/kernel/postinst.d/apt-auto-removal: 84: /etc/kernel/postinst.d/apt-auto-removal: cannot create /etc/apt/apt.conf.d//01autoremove-kernels.dpkg-new: Permission denied run-parts: /etc/kernel/postinst.d/apt-auto-removal exited with return code 2 make[3]: *** [install] Error 1 make[2]: *** [install] Error 2 make[2]: Leaving directory `/home/michel/git/xia/linux' make[1]: *** [debian/stamp/install/linux-image-3.17.0-rc4-xia] Error 2 make[1]: Leaving directory `/home/michel/git/xia/linux' make: *** [kernel_image] Error 2
As of today, September 10th, 2014, the updated package isn't available on Ubuntu 14.04 yet.
The commands below will update your package kernel-package to version 13.003.
You may want to check the status of the bug report of this issue on Launchpad for updates.
$ wget https://launchpad.net/ubuntu/+source/kernel-package/13.003/+build/5980712/+files/kernel-package_13.003_all.deb $ sudo dpkg -i kernel-package_13.003_all.deb
Once the packages are generated, just move a path up from the root of the repository, and install them:
$ cd .. $ sudo dpkg -i linux-image-3.0.0-rc3-xia_05_amd64.deb $ sudo dpkg -i linux-headers-3.0.0-rc3-xia_05_amd64.deb
If your system's architecture is not 64-bit and/or your kernel version is not 3.0, you will need to alter the above commands for your particular compiled kernel (though this is not difficult; these two package files will be of the form linux-image-* and linux-headers-*.
The second package is necessary for development, but it is not necessary for deployment.
Reboot the machine and choose the new kernel in the boot loader. If the machine reboots to a blank screen, or if the new kernel is not selected by GRUB at the next boot, see the Troubleshooting section below.
Once the machine booted, log in as root, and load the XIA stack:
# modprobe xia # modprobe xia_ppal_ad # modprobe xia_ppal_hid # modprobe xia_ppal_xdp
No principal module is required, but not all sets of principals are practical.
It is worth mentioning that the command modprobe xia can often be omitted since any principal module depends on it, and Linux's dependency mechanism handles this automatically.
One can verify if XIA modules were loaded successfully using dmesg as shown below:
# dmesg | tail -n5
Which should generate output similar to the following:
[ 92.380226] NET: Registered protocol family 40 [ 92.380238] XIA loaded [ 103.975861] XIA Principal AD loaded [ 109.500213] XIA Principal HID loaded [ 110.621004] XIA Principal XDP loaded
In order to have XIA modules always loaded as part of the boot process, include the following lines in the file /etc/modules.
install xia install xia_ppal_ad install xia_ppal_hid install xia_ppal_xdp
If the machine shows a black screen, but it is working (you can test to connect with ssh or ping the machine), enter as root, edit the /etc/default/grub file to enable variable GRUB_TERMINAL as follows:
-#GRUB_TERMINAL=console +GRUB_TERMINAL=console
After editing the /etc/default/grub file, run the following command to update grub, and reboot:
# update-grub
In order to do the previous steps, you can use ssh, booting with an older kernel, or select the new kernel and press "e" to edit the boot parameters, and remove the line set gfxpayload=\$linux_gfx_mode.
We don't know why Ubuntu's kernels don't have this problem. If you know why and/or how to get the same behavior, please let us know, so that we may improve this page.
The dpkg -i linux-image* command should install the kernel image to the boot partition and update GRUB by calling update-grub. On Ubuntu 13, this may not be enough to update GRUB's view of the new kernel. Below we detail a possible solution; if this doesn't work, try reading through Ubuntu's extensive documentation of GRUB.
If this happens to you, try backing up your old grub.cfg file by copying it to the root partition (or anywhere you like):
# cp /boot/grub/grub.cfg /grub.cfg-old
Then try running grub-mkconfig to generate a new config file. By default this program sends the generated config file to the standard out; pipe this output to a new file to save it.
# grub-mkconfig > /boot/grub/grub.cfg
Now reboot the machine. If the kernel is still not being selected, try selecting it manually from GRUB's menu by holding Shift as the machine starts up.
xiaconf is a analogue of iproute2 for XIA, that is, xiaconf is a collection of utilities for controlling an XIA stack.
One clones xiaconf's repository with the following command:
$ git clone git://github.com/AltraMayor/xiaconf.git
In order to compile the xiaconf package, install the OpenSSL development package:
sudo apt-get install libssl-dev
With the dependencies in place, just compile and install xiaconf:
make sudo make install
Once you have a kernel with XIA stack and package xiaconf installed, you may want to read page How to set up.
All grants that have generously supported the development of Linux XIA are listed on our Funding page.