Building

How to build and install the libmbim library.

The project currently uses the GNU autotools as build system.

There are two main ways to build the library: from a git repository checkout and from a source release tarball.

Dependencies

Before you can compile the libmbim library, you will need at least the following tools:

  • A compliant C toolchain: e.g. glibc or musl libc, gcc or clang/llvm, and make.
  • pkg-config, a tool for tracking the compilation flags needed for libraries.
  • The glib2 library.
    • For libmbim git master builds, glib2 >= 2.56.
    • For libmbim >= 1.24, glib2 >= 2.48.
    • For libmbim >= 1.16 and < 1.24, glib2 >= 2.36
    • For libmbim >= 1.0 and < 1.16, glib2 >= 2.32

In addition to the previous mandatory requirements, the project also has several optional dependencies that would be needed when enabling additional project features:

When building from a git checkout instead of from a source tarball, the following additional dependencies are required:

Building

The basic build and installation of the project can be done from an official release source tarball, in the following way:

  $ wget https://www.freedesktop.org/software/libmbim/libmbim-1.24.6.tar.xz
  $ tar -Jxvf libmbim-1.24.6.tar.xz
  $ cd libmbim-1.24.6
  $ ./configure --prefix=/usr
  $ make

Optional switches

Additional optional switches that may be given to the configure command above would be:

  • In Debian/Ubuntu systems the default location for libraries depends on the architecture of the build, so instead of the default /usr/lib path that would be in effect due to --prefix=/usr, the user should also give an explicit --libdir path pointing to the correct location. E.g. on a 64bit Ubuntu/Debian build, the user would use --prefix=/usr --libdir=/usr/lib/x86_64-linux-gnu.
  • If the documentation should be rebuilt, the additional --enable-gtk-doc switch should be given. Omitting this switch will imply auto-detecting whether the documentation can be rebuilt with the already installed dependencies.
  • If the introspection support should be included in the build, the additional --enable-introspection switch should be given. Omitting this switch will imply auto-detecting whether the introspection can be built with the already installed dependencies.
  • When developing changes to the library or debugging issues, it is recommended to build with debug symbols so that running the program under gdb produces useful backtrace information. This can be achieved by providing user compiler flags like these: CFLAGS="-ggdb -O0"

An example project build using all the above optional switches could be:

  $ ./configure                          \
      --prefix=/usr                      \
      --libdir=/usr/lib/x86_64-linux-gnu \
      --enable-gtk-doc                   \
      --enable-introspection             \
      CFLAGS="-ggdb -O0"
  $ make

Running ./configure --help will show all the possible switches that are supported.

Building from a git checkout

When building from a git checkout, there is one single additional step required to build the project: running the included autogen.sh in order to setup the GNU autotools project and generate a configure script:

  $ git clone https://gitlab.freedesktop.org/mobile-broadband/libmbim.git
  $ cd libmbim
  $ NOCONFIGURE=1 ./autogen.sh
  $ ./configure --prefix=/usr
  $ make

The same optional switches may be given to the configure script when building from a git checkout.

Installing

The installation on the prefix selected during configure can be done with the following command:

  $ sudo make install

Please note that the command above will install the library in the system default path for libraries, possibly overwriting any previous libmbim library that may already exist from a package manager installed package.

Installing in /usr/local

If no explicit --prefix is given to the configure command when preparing the build, the default /usr/local path will be used as prefix, which will avoid needing to overwrite the package manager installed files. If this approach is taken, the developer can keep the package manager installed library in /usr/lib and the package manager installed command line tool in /usr/bin, while keeping the custom installed library in /usr/local/lib and the custom installed command line tool in /usr/local/bin.

Under this scenario, the user can run the package manager installed mbimcli in the following way, which will use the package manager installed library from /usr/lib:

  $ /usr/bin/mbimcli

In the same scenario, the user can run the custom installed mbimcli in the following way, which will use the custom installed library from /usr/local/lib:

  $ LD_LIBRARY_PATH=/usr/local/lib /usr/local/bin/mbimcli

But beware because there are distributions like Debian/Ubuntu which add the /usr/local/bin path to the PATH environment variable by default, so running the following command would attempt to run the custom installed mbimcli with the package manager installed library from /usr/lib (which is obviously a mess and won’t probably work):

  $ mbimcli

This complication with the need of the explicit LD_LIBRARY_PATH is the reason why this guide suggests to overwrite the package manager installed files.

Uninstalling

If you have manually installed the project with the steps above, it can be uninstalled in the same way:

  $ sudo make uninstall

If the manual install overwrote the package manager installed files, it is suggested to force a re-install of the corresponding packages at this point, so that the system is not left with missing files.

API/ABI

The libmbim library is always API/ABI compatible, so installing a newer version (e.g. self compiled) of the library on a system that has other packages depending on an older version will not break the setup.

Installing an older version of the library on a system that has other packages depending on a newer version may obviously break the setup, though.