Project

General

Profile

Build from Source » History » Version 30

msuraev, 06/13/2017 02:30 PM

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