File: INSTALL

package info (click to toggle)
lksctp-tools 1.0.9.dfsg-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 2,600 kB
  • ctags: 935
  • sloc: ansic: 12,203; sh: 9,057; makefile: 234
file content (178 lines) | stat: -rw-r--r-- 5,805 bytes parent folder | download | duplicates (2)
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
                      HOW TO COMPILE, RUN AND INSTALL
                      -------------------------------

CONTENTS
--------

The lksctp-tools package is intended for two audiences.  
	1) SCTP application developers
	2) LKSCTP project developers

For SCTP application developers, this package provides the user-level
C language header files and a library for accessing SCTP specific
application programming interfaces not provided by the standard sockets. 

For LKSCTP project developers, this package provides the test framework or
testframe, a test suite running the LKSCTP code in userspace.  

For either role, this project provides sample code, utilities, and
tests that one may find useful.  

The below INSTALL directions are provided with in each of these roles.

NOTE:  To build, run and install the lksctp-tools package, your system is 
required to be running with linux-2.5.36, or a later version of the 
kernel, configured with the Network options "SCTP Configuration" 
support enabled.  

WARNING:  The testframe is _very_ specific to a level of LKSCTP kernel code.
Once we reach maturation, it is likely that the version independent code
may be split into its own package, but for now LKSCTP developers should
be highly aware that they need to keep both their kernel source and
lksctp-tools source current.

______________________________________________________________________


INSTALLATION   
-------------
Prerequisite:  A Linux kernel with SCTP support.  This may come stock with 
your distrbution (some day), or you will need to build your own 2.5.36 or
later kernel.

To install/build the lksctp-tools utilities/tests do the following:

1) Download and install the following binary RPMs from the lksctp sourceforge
   website at 
	http://sourceforge.net/project/showfiles.php?group_id=26529
   * lksctp-tools-x.y.z-1.i386.rpm
   * lksctp-tools-x.y.z-devel-1.i386.rpm
   * lksctp-tools-x.y.z-doc-1.i386.rpm

   lksctp-tools-x.y.z-1.i386.rpm includes 
   * SCTP run-time library.
   * Sample SCTP applications: sctp_darn and sctp_test.
   * withsctp: a tool when used with existing TCP binaries replaces TCP
               with SCTP.

   lksctp-tools-x.y.z-devel-1.i386.rpm includes
   * SCTP header file /usr/include/netinet/sctp.h
   * SCTP man pages.
   * Source code for sample SCTP applications.

   lksctp-tools-x.y.z-doc-1.i386.rpm includes
   * SCTP RFC's and internet drafts. 

   If you want to run and play with the included sample SCTP applications or 
   develop your own SCTP applications, you can skip the rest of the
   instructions.

   If you are interested in running the functional regression tests included
   in the lksctp-tools package, continue with the following instructions.

2) Download and install the following source RPM form the lksctp sourceforge
   website at 
        http://sourceforge.net/project/showfiles.php?group_id=26529
   * lksctp-tools-x.y.z-1.src.rpm
   This will install the lksctp-tools gzipped tarball and RPM spec file. 

3) Untar the lksctp-tools directory from the gzipped tarball. This creates a 
   subdirectory called lksctp-tools-x.y.z. 

   Ensure you have autoconf, automake and libtool packages installed on your
   system.

4) Run ./bootstrap

5) Run ./configure

6) Run make

7) To run the SCTP kernel regression tests,
  
   $ cd src/func_tests
   $ make v4test (regression tests for the IPv4 socket support)
   $ make v6test (regression tests for the IPv6 socket support)

8) Run other SCTP test tools/applications in src/apps directory to verify the
   running SCTP.

9) If you are not a lksctp project developer, you can skip the rest of
   the instructions. 


INSTALLATION for lksctp developers
----------------------------------

7) Have a 2.6 kernel source tree ready on the system for build and development.
   The latest stable version can be obtained from
	http://www.kernel.org
   If you use git, the latest linux 2.6 development tree can be obtained from
	http://www.kernel.org/git

8) Set environment variable "LKSCTP_LINUX" to point to the kernel source tree 
   where you are going to develop SCTP with.  For example, 
	
	export LKSCTP_LINUX=~/lksctp-2.6

9) Go to the kernel source tree, e.g. 
	cd ~/lksctp-2.6

10) make xconfig
   [Select Code Maturity->Development->Yes,
	Networking->SCTP Configuration->SCTP Protocol-> y,  (or m)
	Let us know if you discover something else...]

You now have a complete source tree.  You will do most of your
compiling while in either src/ (for functional tests or apps), tests/ (for
user-space frame tests) or your kernel tree (for real kernels).

Read on for more advanced directions relevant to both application and
lksctp developers. 

______________________________________________________________________


Appendix A:  Advanced
---------------------

To build all the frametests or a single frametest
-------------------------------------------------
$ cd test

Make sure that the environment variable "LKSCTP_LINUX" is set to a kernel 
source tree where you are running tests with.  For example, 
	
	export LKSCTP_LINUX=~/lksctp-2.6

Default is "../../lksctp-2.6".

$ make

or 

$ make <TESTNAME>	# to build individual test TESTNAME

To run functional tests in test/
---------------------------------
$ make frametest

and

$ make frame6		# functional test for IPv6 support

To run unit tests in test/
---------------------------
$ make unittest

To build a kernel 
-----------------
Go to your kernel source tree and do a usual kernel compile.

Any patches can be submitted to the lksctp SourceForge website at
	http://www.sf.net/projects/lksctp
or to the lksctp mailing list
	lksctp-developers@lists.sourceforge.net

HOWEVER, lksctp and lksctp-tools patches should be submitted as two
files since their respective sources reside in two separate repositories.