Project

General

Profile

Build from Source » History » Version 57

osmith, 04/05/2019 11:53 AM
installing debian builddepends works with "sudo apt-get build-dep"

1 1 neels
{{>toc}}
2 1 neels
3 1 neels
h1. Build from Source
4 1 neels
5 32 laforge
bq. *Before you consider building from source, be aware that there are [[Binary Packages]]
6 1 neels
available for Debian + Ubuntu platforms. These are recommended for normal users.*
7 1 neels
8 5 neels
Osmocom projects use autoconf/automake.
9 2 neels
The general pattern for building is:
10 1 neels
11 1 neels
<pre>
12 1 neels
cd source-tree
13 1 neels
autoreconf -fi
14 50 osmith
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig"
15 1 neels
./configure
16 1 neels
make
17 1 neels
make check
18 46 osmith
sudo make install
19 15 wirelesss
sudo ldconfig
20 1 neels
</pre>
21 1 neels
22 3 neels
The @./configure@ step may need further configuration options, and
23 3 neels
@./configure@ will tell you which dependencies are still missing, if any.
24 3 neels
See below for project specific details and troubleshooting.
25 1 neels
26 6 neels
The @make@ step may be sped up by using multiple CPU cores:
27 1 neels
28 1 neels
<pre>
29 1 neels
make -j 8
30 1 neels
</pre>
31 1 neels
32 1 neels
We take care to make our builds parallelizable with @-j@, but in case
33 41 neels
@make -j@ fails, issuing a simple @make@ could fix the problem.
34 1 neels
35 1 neels
h1. Dependencies
36 1 neels
37 1 neels
Which libraries are needed by various Osmocom programs is best resolved during
38 1 neels
the @./configure@ step described below. This script checks for any missing
39 6 neels
dependencies and issues corresponding error messages.
40 1 neels
41 1 neels
Here is a (probably incomplete) overview of dependencies between Osmocom
42 1 neels
projects:
43 1 neels
44 1 neels
| _To build ..._ | _... you also need ..._ |
45 1 neels
| osmo-bts | libosmocore, libosmo-abis, openbsc (source tree only), L1 headers depending on BTS model |
46 1 neels
| osmo-pcu | libosmocore, L1 headers depending on BTS model |
47 40 neels
| osmo-hlr | libosmocore, libosmo-abis |
48 40 neels
| osmo-mgw | libosmocore, libosmo-abis, libosmo-netif |
49 40 neels
| osmo-msc | libosmocore, libosmo-abis, libosmo-netif, libosmo-sccp, osmo-mgw (for libosmo-mgcp-client), libsmpp34 (for --enable-smpp); for 3G, use --enable-iu and add: osmo-iuh, libasn1c |
50 40 neels
| osmo-bsc | libosmocore, libosmo-abis, libosmo-netif, libosmo-sccp, osmo-mgw (for libosmo-mgcp-client) |
51 40 neels
| osmo-sgsn | libosmocore, osmo-ggsn; for 3G, use --enable-iu and add: osmo-iuh, libasn1c |
52 40 neels
| osmo-ggsn | libosmocore |
53 53 osmith
| osmo-sip-connector | libosmocore |
54 55 osmith
| osmo-trx | libosmocore |
55 1 neels
56 20 Darkstar
h1. External dependencies
57 20 Darkstar
58 21 neels
If you want to build on specific Linux distros, you might need to install additional dependencies before the build will succeed
59 21 neels
-- this is a collection of various dependencies used by various osmocom projects:
60 20 Darkstar
61 20 Darkstar
| _To build on ..._ | _...you might need to install these packages:_ |
62 33 pespin
|Ubuntu 16.10 | libpcsclite-dev libtalloc-dev libortp-dev libsctp-dev libmnl-dev libdbi-dev libdbd-sqlite3 libsqlite3-dev sqlite3 libc-ares-dev libgnutls-dev |
63 56 osmith
|Debian 8 and 9| build-essential gcc g++ make automake autoconf libtool pkg-config libtalloc-dev libpcsclite-dev libortp-dev libsctp-dev libssl-dev libdbi-dev libdbd-sqlite3 libsqlite3-dev libpcap-dev libc-ares-dev libgnutls28-dev libsctp-dev sqlite3 libsofia-sip-ua-glib-dev libuhd-dev libusb-1.0-0-dev |
64 22 laforge
|FreeBSD 11|automake autoconf libtool git pkgconf talloc pcsc-lite python gmake ortp|
65 52 osmith
|Fedora 28|@development-tools autoconf automake gnutls-devel libtool libtalloc-devel pcsc-lite-devel ortp-devel openssl-devel lksctp-tools-devel libmnl-devel libdbi-devel libdbi-dbd-sqlite libpcap-devel sqlite-devel gcc-g++ uhd-devel libusb-devel fftw-devel boost-devel|
66 20 Darkstar
67 1 neels
h1. Download Sources
68 1 neels
69 3 neels
The latest Osmocom sources are available from git at https://git.osmocom.org,
70 3 neels
where each project's overview page displays the actual git URL.
71 3 neels
72 1 neels
The projects' repository URLs generally are of the pattern:
73 3 neels
<pre>git://git.osmocom.org/project-name</pre>
74 6 neels
(To contribute, see [[Coding Standards#Submitting-Patches|Submitting Patches]])
75 3 neels
76 3 neels
For example, to verify libosmocore's git repository URL, browse to
77 1 neels
https://git.osmocom.org/libosmocore/ and observe the URL shown at the
78 3 neels
bottom of the page under _Clone_: @git://git.osmocom.org/libosmocore@
79 3 neels
80 6 neels
Then download this URL using the @git@ client:
81 3 neels
82 1 neels
<pre>
83 1 neels
git clone git://git.osmocom.org/libosmocore
84 1 neels
</pre>
85 1 neels
86 6 neels
It is also possible to download specific releases' tarballs for each git ref
87 6 neels
that is defined. For example, browse to https://git.osmocom.org/libosmocore/,
88 6 neels
click on _refs_ on the top and select any branch or tag, e.g. "0.9.0":https://git.osmocom.org/libosmocore/tag/?h=0.9.0
89 6 neels
90 16 neels
All of these download instructions hold true for any of the git repositories,
91 16 neels
not limited to libosmocore.
92 6 neels
93 17 neels
h1. Build debian packages
94 1 neels
95 17 neels
Most Osmocom projects are setup and ready for building debian packages.
96 17 neels
See the @debian/@ subdir in each source tree.
97 13 wirelesss
98 17 neels
For example, to build a libosmocore debian package:
99 1 neels
100 1 neels
<pre>
101 17 neels
cd libosmocore/
102 57 osmith
sudo apt-get build-dep .
103 13 wirelesss
dpkg-buildpackage -tc -uc -us
104 17 neels
# then, you can install the package on your system with
105 17 neels
sudo dpkg -i ../libosmocore*.deb
106 13 wirelesss
</pre>
107 13 wirelesss
108 17 neels
These steps are identical for all other Osmocom projects that are ready for debian packaging.
109 13 wirelesss
110 17 neels
Advantages of debian packages:
111 17 neels
* they allow you to easily install the same binaries on several machines,
112 17 neels
* you don't need to keep the source tree around,
113 17 neels
* they guarantee a clean de-installation later.
114 17 neels
115 17 neels
Note: when not using debian packages, i.e. after a '@make install@' directly from the source tree,
116 17 neels
you can also achieve a clean de-installation with '@make uninstall@'.
117 11 wirelesss
118 12 wirelesss
h1. Details and Troubleshooting
119 11 wirelesss
120 12 wirelesss
Here is a list of the most common configuration items or pitfalls to be
121 12 wirelesss
aware of when building specific Osmocom projects.
122 12 wirelesss
123 6 neels
124 6 neels
h2. Non-GNU Systems
125 6 neels
126 6 neels
On systems like FreeBSD, you need to run @gmake@ instead of @make@.
127 6 neels
128 7 neels
h2. Cross-Compiling for a BTS Platform
129 7 neels
130 7 neels
To build new software for the sysmoBTS and Litecell 1.5, you will typically
131 7 neels
cross-compile using an SDK matching the BTS. You should find specific instructions
132 7 neels
in, for example, the sysmoBTS manual.
133 7 neels
134 6 neels
h2. General ./configure options
135 6 neels
136 6 neels
To provide the installation location, which is /usr/local by default:
137 6 neels
<pre>
138 6 neels
./configure --prefix=$HOME/my_osmocom_inst
139 6 neels
</pre>
140 6 neels
141 6 neels
If you choose a non-standard location, later builds may fail to find it.
142 6 neels
For example, if you built libosmocore with a custom prefix, a subsequent
143 6 neels
build of libosmo-abis, which needs libosmocore installed, may fail.
144 6 neels
You can tell a build process where to look for libraries to compile against
145 6 neels
using the @PKG_CONFIG_PATH@ environment variable.
146 6 neels
147 6 neels
Furthermore, when you want to run binaries compiled against libraries
148 6 neels
installed in a non-standard location, you will have to use the
149 6 neels
@LD_LIBRARY_PATH@ environment variable to successfully load the binary.
150 6 neels
Particularly, the @make check@ step typically runs such binaries,
151 6 neels
as well as when you would like to run the installed binaries yourself.
152 6 neels
153 6 neels
For example:
154 6 neels
155 6 neels
<pre>
156 6 neels
mkdir -p $HOME/osmo/src
157 6 neels
cd $HOME/osmo/src
158 6 neels
git clone git://git.osmocom.org/libosmocore
159 6 neels
cd libosmocore
160 6 neels
autoreconf -fi
161 6 neels
./configure --prefix=$HOME/osmo/inst --disable-pcsc
162 6 neels
make -j5
163 7 neels
make check
164 7 neels
make install
165 36 neels
sudo ldconfig
166 7 neels
167 7 neels
cd ..
168 7 neels
git clone git://git.osmocom.org/libosmo-abis
169 7 neels
cd libosmo-abis
170 7 neels
autoreconf -fi
171 7 neels
export PKG_CONFIG_PATH=$HOME/osmo/inst/lib/pkgconfig
172 7 neels
./configure --prefix=$HOME/osmo/inst
173 7 neels
make -j5
174 7 neels
export LD_LIBRARY_PATH=$HOME/osmo/inst/lib
175 7 neels
make check
176 7 neels
make install
177 36 neels
sudo ldconfig
178 6 neels
</pre>
179 6 neels
180 7 neels
Note that PKG_CONFIG_PATH points at the prefix's lib/pkgconfig and is needed
181 7 neels
during the configure step of a library;
182 7 neels
183 7 neels
And that LD_LIBRARY_PATH is needed when running binaries that need libraries
184 7 neels
installed in the non-standard location, here via @make check@.
185 7 neels
186 7 neels
Furthermore, when installing to an SDK's sysroot location, you would usually
187 7 neels
set @DESTDIR@ to the sysroot with @--prefix=/usr@, resulting in an install
188 7 neels
location of @$DESTDIR/usr@.
189 7 neels
190 6 neels
h2. libosmocore
191 6 neels
192 6 neels
When @libpcsclite@ is not easily available, e.g. when building for a BTS target platform:
193 6 neels
<pre>
194 6 neels
./configure --disable-pcsc
195 6 neels
</pre>
196 1 neels
197 7 neels
h2. openbsc
198 7 neels
199 7 neels
@openbsc@ is so far the only source tree where the build commands must be run
200 7 neels
a level deeper than the source tree's root. Enter the second @openbsc@ dir:
201 7 neels
202 7 neels
<pre>
203 7 neels
git clone git://git.osmocom.org/openbsc
204 7 neels
cd openbsc/openbsc
205 7 neels
autoreconf -fi
206 7 neels
[...]
207 7 neels
</pre>
208 7 neels
209 37 neels
h2. osmo-msc and osmo-sgsn for 3G
210 19 neels
211 37 neels
Be sure to pass the @--enable-iu@ configure option to enable Iu interface support.
212 19 neels
213 19 neels
<pre>
214 37 neels
cd osmo-msc
215 19 neels
./configure --enable-iu
216 19 neels
</pre>
217 19 neels
218 38 neels
h1. Example: completely build osmo-bsc, osmo-msc, osmo-sgsn and osmo-ggsn
219 7 neels
220 39 pespin
This is an example of a complete build process for 2G+3G core network,
221 7 neels
including SMPP and the "nat" binaries, to the @/usr/local@ prefix; it is assumed
222 7 neels
that your system by default scans @/usr/local@ for installed libraries:
223 1 neels
224 39 pespin
If you don't require 3G, you can omit build of osmo-iuh and remove configure flag "--enable-iu" in osmo-msc and osmo-sgsn.
225 39 pespin
226 7 neels
<pre>
227 7 neels
osmo_src=$HOME/osmo/src
228 7 neels
mkdir -p $osmo_src
229 7 neels
230 7 neels
cd $osmo_src
231 7 neels
git clone git://git.osmocom.org/libosmocore
232 7 neels
cd libosmocore
233 7 neels
autoreconf -fi
234 7 neels
./configure
235 7 neels
make -j5
236 7 neels
make check
237 1 neels
make install
238 38 neels
sudo ldconfig
239 7 neels
240 7 neels
cd $osmo_src
241 7 neels
git clone git://git.osmocom.org/libosmo-abis
242 7 neels
cd libosmo-abis
243 7 neels
autoreconf -fi
244 7 neels
./configure
245 7 neels
make -j5
246 7 neels
make check
247 1 neels
make install
248 38 neels
sudo ldconfig
249 7 neels
250 7 neels
cd $osmo_src
251 7 neels
git clone git://git.osmocom.org/libosmo-netif
252 7 neels
cd libosmo-netif
253 7 neels
autoreconf -fi
254 7 neels
./configure
255 7 neels
make -j5
256 7 neels
make check
257 1 neels
make install
258 38 neels
sudo ldconfig
259 7 neels
260 7 neels
cd $osmo_src
261 7 neels
git clone git://git.osmocom.org/libosmo-sccp
262 7 neels
cd libosmo-sccp
263 7 neels
autoreconf -fi
264 7 neels
./configure
265 7 neels
make -j5
266 7 neels
make check
267 1 neels
make install
268 38 neels
sudo ldconfig
269 7 neels
270 7 neels
cd $osmo_src
271 7 neels
git clone git://git.osmocom.org/libsmpp34
272 7 neels
cd libsmpp34
273 7 neels
autoreconf -fi
274 7 neels
./configure
275 7 neels
make
276 7 neels
make check
277 1 neels
make install
278 38 neels
sudo ldconfig
279 1 neels
280 7 neels
cd $osmo_src
281 38 neels
git clone git://git.osmocom.org/osmo-mgw
282 38 neels
cd osmo-mgw
283 7 neels
autoreconf -fi
284 7 neels
./configure
285 1 neels
make -j5
286 1 neels
make check
287 1 neels
make install
288 38 neels
sudo ldconfig
289 1 neels
290 1 neels
cd $osmo_src
291 38 neels
git clone git://git.osmocom.org/libasn1c
292 38 neels
cd libasn1c
293 1 neels
autoreconf -fi
294 38 neels
./configure
295 1 neels
make
296 39 pespin
make check
297 39 pespin
make install
298 39 pespin
sudo ldconfig
299 39 pespin
300 39 pespin
cd $osmo_src
301 39 pespin
git clone git://git.osmocom.org/osmo-iuh
302 39 pespin
cd osmo-iuh
303 39 pespin
autoreconf -fi
304 39 pespin
./configure
305 39 pespin
make -j5
306 38 neels
make check
307 38 neels
make install
308 38 neels
sudo ldconfig
309 38 neels
310 38 neels
cd $osmo_src
311 38 neels
git clone git://git.osmocom.org/osmo-msc
312 38 neels
cd osmo-msc
313 38 neels
autoreconf -fi
314 38 neels
./configure --enable-iu
315 1 neels
make -j5
316 1 neels
make check
317 1 neels
make install
318 38 neels
sudo ldconfig
319 1 neels
320 38 neels
cd $osmo_src
321 42 neels
git clone git://git.osmocom.org/osmo-ggsn
322 42 neels
cd osmo-ggsn
323 38 neels
autoreconf -fi
324 42 neels
./configure
325 38 neels
make -j5
326 38 neels
make check
327 38 neels
make install
328 38 neels
sudo ldconfig
329 38 neels
330 38 neels
cd $osmo_src
331 42 neels
git clone git://git.osmocom.org/osmo-sgsn
332 42 neels
cd osmo-sgsn
333 38 neels
autoreconf -fi
334 42 neels
./configure --enable-iu
335 1 neels
make -j5
336 38 neels
make check
337 38 neels
make install
338 38 neels
sudo ldconfig
339 38 neels
340 42 neels
export LD_LIBRARY_PATH="/usr/local/lib"
341 42 neels
export PATH="$PATH:/usr/local/bin"
342 38 neels
which osmo-msc
343 38 neels
osmo-msc --version
344 6 neels
</pre>
345 6 neels
346 9 neels
h1. Example: build script
347 31 laforge
348 9 neels
This is a shell script that builds openbsc and osmo-ggsn,
349 9 neels
expecting the git clones to be ready in the current directory:
350 9 neels
351 1 neels
attachment:build_2G.sh
352 43 neels
353 43 neels
h1. Example: top-level Makefile
354 43 neels
355 43 neels
I (neels) use a top-level makefile to manage various configurations and build all source trees in sequence.
356 43 neels
See https://git.osmocom.org/osmo-dev and look at the readme file.
357 47 osmith
358 47 osmith
h1. Example: script for cloning and building a single project
359 47 osmith
360 47 osmith
<pre>
361 47 osmith
#!/bin/sh -e
362 47 osmith
363 47 osmith
# Location where the git repositories will be stored (must exist)
364 47 osmith
DIR=~/code
365 47 osmith
366 47 osmith
# Check usage
367 47 osmith
if [ -z "$1" ]; then
368 47 osmith
	echo "usage: $(basename $0) PROJECT"
369 47 osmith
	exit 1
370 47 osmith
fi
371 47 osmith
372 47 osmith
# Clone
373 49 osmith
cd $DIR
374 47 osmith
if ! [ -d "$1" ]; then
375 47 osmith
	git clone "git://git.osmocom.org/$1"
376 47 osmith
fi
377 47 osmith
378 47 osmith
# Build
379 50 osmith
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig/"
380 49 osmith
cd $1
381 47 osmith
autoreconf -fi
382 47 osmith
./configure
383 47 osmith
make -j3
384 47 osmith
make check
385 47 osmith
sudo make install
386 47 osmith
sudo ldconfig
387 47 osmith
</pre>
Add picture from clipboard (Maximum size: 48.8 MB)