1. Installation Instructions
  2. *************************
  3. Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
  4. 2006, 2014 Free Software Foundation, Inc.
  5. This file is free documentation; the Free Software Foundation gives
  6. unlimited permission to copy, distribute and modify it.
  7. Advanced Installation
  8. =====================
  9. Visit
  10. Basic Installation
  11. ==================
  12. ./configure
  13. make
  14. sudo make install
  15. Briefly, the shell commands `./configure; make; make install' should
  16. configure, build, and install this package. The following
  17. more-detailed instructions are generic; see the `README' file for
  18. instructions specific to this package.
  19. The `configure' shell script attempts to guess correct values for
  20. various system-dependent variables used during compilation. It uses
  21. those values to create a `Makefile' in each directory of the package.
  22. It may also create one or more `.h' files containing system-dependent
  23. definitions. Finally, it creates a shell script `config.status' that
  24. you can run in the future to recreate the current configuration, and a
  25. file `config.log' containing compiler output (useful mainly for
  26. debugging `configure').
  27. It can also use an optional file (typically called `config.cache'
  28. and enabled with `--cache-file=config.cache' or simply `-C') that saves
  29. the results of its tests to speed up reconfiguring. Caching is
  30. disabled by default to prevent problems with accidental use of stale
  31. cache files.
  32. If you need to do unusual things to compile the package, please try
  33. to figure out how `configure' could check whether to do them, and mail
  34. diffs or instructions to the address given in the `README' so they can
  35. be considered for the next release. If you are using the cache, and at
  36. some point `config.cache' contains results you don't want to keep, you
  37. may remove or edit it.
  38. The file `' (or `') is used to create
  39. `configure' by a program called `autoconf'. You need `' if
  40. you want to change it or regenerate `configure' using a newer version
  41. of `autoconf'.
  42. The simplest way to compile this package is:
  43. 1. `cd' to the directory containing the package's source code and type
  44. `./configure' to configure the package for your system.
  45. Running `configure' might take a while. While running, it prints
  46. some messages telling which features it is checking for.
  47. 2. Type `make' to compile the package.
  48. 3. Optionally, type `make check' to run any self-tests that come with
  49. the package.
  50. 4. Type `make install' to install the programs and any data files and
  51. documentation.
  52. 5. You can remove the program binaries and object files from the
  53. source code directory by typing `make clean'. To also remove the
  54. files that `configure' created (so you can compile the package for
  55. a different kind of computer), type `make distclean'. There is
  56. also a `make maintainer-clean' target, but that is intended mainly
  57. for the package's developers. If you use it, you may have to get
  58. all sorts of other programs in order to regenerate files that came
  59. with the distribution.
  60. How to make Tcpreplay go fast
  61. =============================
  62. 1) netmap
  63. ------
  64. This feature will detect netmap capable network drivers on Linux and
  65. BSD systems. If detected, the network driver is bypassed for the
  66. execution duration of tcpreplay and tcpreplay-edit, and network buffers
  67. will be written to directly. This will allow you to achieve full 10GigE
  68. line rates on commodity 10GigE network adapters, similar to rates
  69. achieved by commercial network traffic generators.
  70. Note that bypassing the network driver will disrupt other applications
  71. connected through the test interface. Use caution when testing on the
  72. same interface you ssh'ed into.
  73. Ensure that you have supported NICs installed. Most Intel and nForce
  74. (nVidia) adapters will work. Some virtual adapters are supported.
  75. FreeBSD 10 and higher already contains netmap capabilities and should
  76. be detected automatically by "configure". But first you must enable
  77. netmap on the system by adding 'device netmap' to your kernel config
  78. and rebuilding the kernel. When complete, /dev/netmap will be
  79. available.
  80. For Linux, download latest netmap sources from
  81. or run 'git clone'. You will also need to have
  82. kernel sources installed so the build system can patch the sources and build
  83. netmap-enabled drivers. If kernel sources are in /a/b/c/linux-A.B.C/ , then you
  84. should do:
  85. cd netmap/LINUX
  86. make KSRC=/a/b/c/linux-A.B.C/ # builds the kernel modules
  87. make KSRC=/a/b/c/linux-A.B.C/ apps # builds sample applications
  88. You can omit KSRC if your kernel sources are in a standard place.
  89. Once you load the netmap.lin.ko module on your Linux machine, /dev/netmap
  90. will be available. You will also need to replace your existing network drivers
  91. (beyond the scope of this document).
  92. Building netmap-aware Tcpreplay suite is relatively straight forward. For
  93. FreeBSD, build normally. For Linux, if you extracted netmap into /usr/src/ you
  94. can also build normally. Otherwise you will have to specify the netmap source
  95. directory, for example:
  96. ./configure --with-netmap=/home/fklassen/git/netmap
  97. make
  98. sudo make install
  99. Compilers and Options
  100. =====================
  101. Some systems require unusual options for compilation or linking that the
  102. `configure' script does not know about. Run `./configure --help' for
  103. details on some of the pertinent environment variables.
  104. You can give `configure' initial values for configuration parameters
  105. by setting variables in the command line or in the environment. Here
  106. is an example:
  107. ./configure CC=c99 CFLAGS=-g LIBS=-lposix
  108. *Note Defining Variables::, for more details.
  109. Compiling For Multiple Architectures
  110. ====================================
  111. You can compile the package for more than one kind of computer at the
  112. same time, by placing the object files for each architecture in their
  113. own directory. To do this, you can use GNU `make'. `cd' to the
  114. directory where you want the object files and executables to go and run
  115. the `configure' script. `configure' automatically checks for the
  116. source code in the directory that `configure' is in and in `..'.
  117. With a non-GNU `make', it is safer to compile the package for one
  118. architecture at a time in the source code directory. After you have
  119. installed the package for one architecture, use `make distclean' before
  120. reconfiguring for another architecture.
  121. Installation Names
  122. ==================
  123. By default, `make install' installs the package's commands under
  124. `/usr/local/bin', include files under `/usr/local/include', etc. You
  125. can specify an installation prefix other than `/usr/local' by giving
  126. `configure' the option `--prefix=PREFIX'.
  127. You can specify separate installation prefixes for
  128. architecture-specific files and architecture-independent files. If you
  129. pass the option `--exec-prefix=PREFIX' to `configure', the package uses
  130. PREFIX as the prefix for installing programs and libraries.
  131. Documentation and other data files still use the regular prefix.
  132. In addition, if you use an unusual directory layout you can give
  133. options like `--bindir=DIR' to specify different values for particular
  134. kinds of files. Run `configure --help' for a list of the directories
  135. you can set and what kinds of files go in them.
  136. If the package supports it, you can cause programs to be installed
  137. with an extra prefix or suffix on their names by giving `configure' the
  138. option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  139. Optional Features
  140. =================
  141. Some packages pay attention to `--enable-FEATURE' options to
  142. `configure', where FEATURE indicates an optional part of the package.
  143. They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  144. is something like `gnu-as' or `x' (for the X Window System). The
  145. `README' should mention any `--enable-' and `--with-' options that the
  146. package recognizes.
  147. For packages that use the X Window System, `configure' can usually
  148. find the X include and library files automatically, but if it doesn't,
  149. you can use the `configure' options `--x-includes=DIR' and
  150. `--x-libraries=DIR' to specify their locations.
  151. Specifying the System Type
  152. ==========================
  153. There may be some features `configure' cannot figure out automatically,
  154. but needs to determine by the type of machine the package will run on.
  155. Usually, assuming the package is built to be run on the _same_
  156. architectures, `configure' can figure that out, but if it prints a
  157. message saying it cannot guess the machine type, give it the
  158. `--build=TYPE' option. TYPE can either be a short name for the system
  159. type, such as `sun4', or a canonical name which has the form:
  161. where SYSTEM can have one of these forms:
  163. See the file `config.sub' for the possible values of each field. If
  164. `config.sub' isn't included in this package, then this package doesn't
  165. need to know the machine type.
  166. If you are _building_ compiler tools for cross-compiling, you should
  167. use the option `--target=TYPE' to select the type of system they will
  168. produce code for.
  169. If you want to _use_ a cross compiler, that generates code for a
  170. platform different from the build platform, you should specify the
  171. "host" platform (i.e., that on which the generated programs will
  172. eventually be run) with `--host=TYPE'.
  173. Sharing Defaults
  174. ================
  175. If you want to set default values for `configure' scripts to share, you
  176. can create a site shell script called `' that gives default
  177. values for variables like `CC', `cache_file', and `prefix'.
  178. `configure' looks for `PREFIX/share/' if it exists, then
  179. `PREFIX/etc/' if it exists. Or, you can set the
  180. `CONFIG_SITE' environment variable to the location of the site script.
  181. A warning: not all `configure' scripts look for a site script.
  182. Defining Variables
  183. ==================
  184. Variables not defined in a site shell script can be set in the
  185. environment passed to `configure'. However, some packages may run
  186. configure again during the build, and the customized values of these
  187. variables may be lost. In order to avoid this problem, you should set
  188. them in the `configure' command line, using `VAR=value'. For example:
  189. ./configure CC=/usr/local2/bin/gcc
  190. causes the specified `gcc' to be used as the C compiler (unless it is
  191. overridden in the site shell script).
  192. Unfortunately, this technique does not work for `CONFIG_SHELL' due to
  193. an Autoconf bug. Until the bug is fixed you can use this workaround:
  194. CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
  195. `configure' Invocation
  196. ======================
  197. `configure' recognizes the following options to control how it operates.
  198. `--help'
  199. `-h'
  200. Print a summary of the options to `configure', and exit.
  201. `--version'
  202. `-V'
  203. Print the version of Autoconf used to generate the `configure'
  204. script, and exit.
  205. `--cache-file=FILE'
  206. Enable the cache: use and save the results of the tests in FILE,
  207. traditionally `config.cache'. FILE defaults to `/dev/null' to
  208. disable caching.
  209. `--config-cache'
  210. `-C'
  211. Alias for `--cache-file=config.cache'.
  212. `--quiet'
  213. `--silent'
  214. `-q'
  215. Do not print messages saying which checks are being made. To
  216. suppress all normal output, redirect it to `/dev/null' (any error
  217. messages will still be shown).
  218. `--srcdir=DIR'
  219. Look for the package's source code in directory DIR. Usually
  220. `configure' can determine that directory automatically.
  221. `configure' also accepts some other, not widely useful, options. Run
  222. `configure --help' for more details.