README.md

   1 What is dabba?
   2 ==============
   3
   4 [![Build Status](https://secure.travis-ci.org/eroullit/dabba.png?branch=master)](http://travis-ci.org/eroullit/dabba)
   5
   6 dabba is a set of network tools written for Linux.
   7
   8 This is inspired on the Dabba Walla system present in Mumbai where
   9 meals are regrouped and dispatched throughout the city with a high
  10 efficiency rate, every day of the year.
  11
  12 The project has 4 main components:
  13 * `libdabba` - low-level zero-copy network library
  14 * `libdabba-rpc` - protobuf-based rpc library for dabbad and dabba
  15 * `dabbad` - multi-threaded task manager and RPC query processor
  16 * `dabba` - CLI 'à la git' to communicate with dabbad and submit tasks
  17
  18 Currently supported feature are listed in the [CODING] file.
  19
  20 Get the source!
  21 ===============
  22
  23 ```
  24 git clone git://github.com/eroullit/dabba.git
  25 ```
  26
  27 Contributions are welcome, [CODING] regroups all information about it.
  28
  29 Prerequisites
  30 =============
  31
  32 dabba needs these to compile and run properly:
  33 * Linux kernel >= 2.6.31
  34 * `build-essential`
  35 * `cmake`
  36 * `pthread`
  37 * `libnl-3-dev`
  38 * `libnl-genl-3-dev`
  39 * `libnl-route-3-dev`
  40 * `protobuf-c-compiler`
  41 * `libprotobuf-c0-dev`
  42 * `setcap` (within `libcap2-bin` package)
  43
  44 Recommended optional packages:
  45 * `python-yaml`
  46 * `doxygen`
  47
  48 Installation
  49 ============
  50
  51 To build out-of-tree:
  52 ```sh
  53 $ mkdir build && cd build && cmake .. && make
  54 ```
  55
  56 To install it after being built:
  57 ```sh
  58 $ sudo make install/strip
  59 ```
  60
  61 Capabilities
  62 ============
  63
  64 To configure dabba to run with a regular user account:
  65 ```sh
  66 $ sudo make setcap
  67 ```
  68
  69 Testing
  70 =======
  71
  72 Automatic tests are available. There are two kinds:
  73 * Read-only (which do not interfere with network interface settings)
  74 * Read-write (which modify network interface settings)
  75
  76 WARNING: Read-write tests might degrade or disable the
  77 interface connectivity while tests are running. Avoid to run
  78 then on production interfaces.
  79
  80 To run read-only automatic tests, make sure proper capabilities are granted and
  81 run in the build directory:
  82 ```sh
  83 $ ctest --output-on-failure
  84 ```
  85
  86 To run read-only automatic tests, make sure proper capabilities are granted,
  87 set the `TEST_DEV` variable with the interface name to modify
  88 and run in the build directory:
  89 ```sh
  90 $ TEST_DEV=eth0 ctest --output-on-failure
  91 ```
  92
  93 Getting started!
  94 ================
  95
  96 Start dabbad:
  97 ```sh
  98 $ dabbad --daemonize
  99 ```
 100
 101 As long as dabbad is running, captures tasks can be submitted:
 102 ```sh
 103 $ dabba capture start --interface eth0 --pcap /tmp/example.pcap
 104 ```
 105
 106 Running captures can be listed in YAML format:
 107 ```sh
 108 $ dabba capture get
 109 ---
 110   captures:
 111     - id: 3076324160
 112       rc: 0 # Success
 113       packet mmap size: 32768
 114       frame number: 16
 115       pcap: /tmp/example.pcap
 116       interface: eth0
 117 ```
 118
 119 Stopping the capture:
 120 ```sh
 121 $ dabba capture stop --id 3076324160
 122 ```
 123
 124 Copyright
 125 =========
 126
 127 The MIT License (MIT)
 128
 129 Copyright (c) 2013 Emmanuel Roullit
 130
 131 Permission is hereby granted, free of charge, to any person obtaining a copy
 132 of this software and associated documentation files (the "Software"), to deal
 133 in the Software without restriction, including without limitation the rights
 134 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 135 copies of the Software, and to permit persons to whom the Software is
 136 furnished to do so, subject to the following conditions:
 137
 138 The above copyright notice and this permission notice shall be included in
 139 all copies or substantial portions of the Software.
 140
 141 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 142 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 143 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 144 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 145 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 146 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 147 THE SOFTWARE.
 148
 149 Contact
 150 =======
 151
 152 For questions:
 153     Send me a message to @eroullit on GitHub
 154
 155 For suggestions or bug reports:
 156     Feel free to open an issue on the [ticket system](https://github.com/eroullit/dabba/issues).
 157
 158 [CODING]: https://github.com/eroullit/dabba/blob/master/CODING