Osmocom Top-level Makefile and dev tools
Go to file
Neels Hofmeyr b459b6c2ae replace src/* git scripts with a single src/gits
I keep re-using this functionality in completely unrelated realms, and decided
to unify the oddly named scripts in a single 'gits' meta-repos tool, so I can
just symlink this script into my ~/bin and use it everywhere.

Change-Id: I579e7af26d76d5c5d83b2349695456bc7b54f5a2
2018-11-08 11:37:19 +01:00
net support osmo-sip-connector with kamailio 2018-10-31 14:12:28 +01:00
src replace src/* git scripts with a single src/gits 2018-11-08 11:37:19 +01:00
.gitignore add src scripts 2017-08-22 15:58:51 +02:00
2G.deps 2G.deps: add osmo-sip-connector 2018-11-07 16:54:21 +01:00
3G+2G.deps deps: comment out osmo-trx 2018-11-07 16:53:34 +01:00
README add template-configs, script to launch network 2018-08-23 14:17:20 +02:00
all-tests.opts all-tests.opts: add libosmocore external-tests 2018-09-16 13:49:54 +02:00
default.opts add openbsc.deps to allow building legacy openbsc.git as well 2018-05-25 17:19:42 +02:00
gen_makefile.py gen_makefile.py: detect changes in cpp files 2018-10-31 14:13:34 +01:00
iu.opts add openbsc.deps to allow building legacy openbsc.git as well 2018-05-25 17:19:42 +02:00
no_systemd.opts add no_systemd.opts 2018-09-16 13:49:54 +02:00
openbsc.deps add openbsc.deps to allow building legacy openbsc.git as well 2018-05-25 17:19:42 +02:00
osmo-uninstall.sh add osmo-uninstall.sh 2017-08-23 00:13:33 +02:00
sanitize.opts sanitize.opts: add osmo-sip-connector --enable-sanitize 2018-11-07 16:54:23 +01:00
transcoding.opts fix transcoding.opts: osmo-bsc also needs it ATM 2017-08-22 19:34:02 +02:00
werror.opts add werror.opts using 'configure --enable-werror' 2018-03-16 03:45:02 +01:00



* quickly build the entire Osmocom core network stack from source, with a
  generated top-level makefile (see the rest of this README file below).

* quickly configure, launch and tear down an entire Osmocom core network on
  your box (see net/README).

=== Quick Start

sudo apt install \
  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

./gen_makefile.py 3G+2G.deps default.opts iu.opts -I -m make

cd make

- 'make' will ask for sudo password to run 'make install' and 'ldconfig'.
  To run non-interactively:

  - 'make install':
    chown $USER: /usr/local
    Then call gen_makefile.py once without the -I option

  - 'ldconfig':
    echo "$USER  ALL= NOPASSWD: /sbin/ldconfig" > /etc/sudoers.d/ldconfig

=== gen_makefile.py

This provides a set of top-level makefiles to build variants of the Osmocom
source trees. It is inteded for the core network components and related
projects, but works generically.

The idea is to have all your Osmocom git clones in ./src, while keeping one or
more separate build trees in ./make-*.

Run ./gen_makefile.py with a choice of projects (2G only or also 3G?)
and a choice of configure options.


Full 2G and 3G support:

  ./gen_makefile.py 3G+2G.deps default.opts iu.opts  -m make
  cd make

2G only, and a custom dir name of 'make-2G':

  ./gen_makefile.py 2G.deps default.opts -m make-2G
  cd make-2G

If you make modifications in one of the source trees, this Makefile will pick
it up, rebuild the project and also rebuild all dependencies (according to the
*.deps file the Makefile was generated from).

If you modify the *.deps or *.opts file, you can easily run 'make regen' in a
make-* subdir to regenerate the Makefile from the same files.

In your make-* subdir there are empty status files that are touched for every
completed make target. From these, 'make' can detect what needs to be rebuilt.
You can manually remove them to force a rebuild of a specific target.

For example, if you 'rm .make.libosmocore.autoconf', libosmocore and all
projects depending on libosmocore will be rebuilt from scratch.

For more details on the *.opts and *.deps syntax, read the docs at the top of

It is also easily possible to keep sources and build trees in various
configurations, see the command line options of ./gen_makefile.py.

=== Build Environment

For dependencies, see the "External dependencies" on:


If /usr/local/ is not writable by your user, pass the --sudo-make-install
option to gen_makefile.py above (a custom --prefix is not yet supported).

If your system doesn't have this by default, you will need:

  export LD_LIBRARY_PATH="/usr/local/lib"


  export PKG_CONFIG_PATH="/usr/local/lib/pkgconfig"

to your environment. To use the installed binaries after installation, also

  export PATH="$PATH:/usr/local/bin"

=== osmo-uninstall.sh

Remove osmocom built binaries and headers from given prefix,
default is /usr/local.

=== src/*

Find other useful scripts in src/, see src/README.