Osmocom Libraries » libosmocore

[[PageOutline]]

= libosmocore =

libosmocore is a library with various utility functions that were originally developed as part of 

the [wiki:OpenBSC] project, but which are of a more generic nature and thus useful to (at least)

other programs that we develop in the sphere of Open Source mobile communications.

There is no clear scope of it.  We simply move all shared code between [wiki:OsmocomBB] and [wiki:OpenBSC]

in this library to avoid code duplication.

== Obtaining it ==

When you download and build [wiki:OsmocomBB], then libosmocore is automatically part of the package,

no special action is required.

If you want to obtain a standalone version of libosmocore, you can use the following git URL:

{{{git clone git://git.osmocom.org/libosmocore.git}}}

== Licensing ==

This library is GPL licensed, as the code is taken from the similarly GPL-licensed OpenBSC codebase.

This means you '''cannot use this library from non-GPL licensed code without infringing copyright!

== Features ==

=== Select loop abstraction ===

This is implemented in select.[ch] and enables you to build complex asynchronous/non-blocking I/O

programs in a single thread.

=== Message buffer handling ===

Inspired by the Linux kernel {{{struct sk_buff}}}, this is our message buffer {{{struct msgb}}}

implementation.  It provides handling of packet buffers, putting them in queues, prepending

and appending data to it, etc.

=== Bitvector ===

A convenient set of routines to deal with bit-vectors in C.  This was originally written

for rest-octet parsing.

=== TLV handling ===

The GSM Layer3 and above are full of TV / TLV / TL16V and other data fields.  Our implementation

provides parser and generator functions, tightly coupled to {{{struct msgb}}}

=== Timers ===

Provides a timer core where you can register timers with a callback function. The function

is called when the timer expires.

=== Comp128v1 ===

A Comp128v1 implementation by Sylvain Munaut is included.

=== Talloc memory allocator ===

The talloc memory allocator from the Samba project.