Project

General

Profile

Build from Source » History » Version 49

osmith, 09/03/2018 12:30 PM
fix single project clone example script

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