Common library for all Osmocom projects (libosmocore, libosmogsm, libosmovty, libosmogb, libosmosim, libosmousb, ...) https://osmocom.org/projects/libosmocore
Go to file
Neels Hofmeyr cf70aa0c40 enable vty xml dumping to stdout
Allow dumping the VTY XML reference (for generating manuals) to a normal FILE*
stream instead of a vty output buffer.

We currently generate the VTY reference by starting the client program,
connecting to the VTY telnet and dumping the reference. That is weirdly
convoluted, especially since there has to be a valid config file that
successfully starts up a minimal set of external links before the reference can
be generated. IMO we should have dumped the XML reference to stdout from the
start, and never to a VTY session.

With this patch, it is trivial to generate the XML VTY reference by a
commandline switch. The client program will set up the entire VTY, and
immediately after parsing the cmdline options but before parsing a config file,
just dumps the reference and doesn't even start establishing local ports. That
would allow generating the XML reference on the fly during the build process of
the manuals, without the need of a docker container or somesuch.

A first implementation of such a commandline switch is `osmo-bsc -X`, added in
I316efedb2c1652791434ecf14a1e261367cd2fb7

This patch jumps through a bit of a hoop to still allow dumping to a VTY buffer
without code dup, to still allow dumping the XML reference through telnet VTY,
until all our programs have implemented an -X switch (TM).

Change-Id: Ic74bbdb6dc5ea05f03c791cc70184861e39cd492
2020-05-18 13:55:08 +02:00
contrib contrib: import RPM spec 2020-05-16 19:56:54 +00:00
debian debian: Change python3 dependency to native arch 2020-03-17 00:39:45 +00:00
doc merge_doc.xsl: move to osmo-gsm-manuals.git 2018-11-12 14:07:05 +01:00
include enable vty xml dumping to stdout 2020-05-18 13:55:08 +02:00
m4 Add code coverage support 2019-11-30 02:17:23 +00:00
src enable vty xml dumping to stdout 2020-05-18 13:55:08 +02:00
tests gsm0808: Implement helper functions for CONFUSION BSSMAP message decoding. 2020-05-17 07:32:32 +00:00
utils sim: When decoding SW, take application specific SW into account 2020-05-05 19:41:12 +00:00
.gitignore Add code coverage support 2019-11-30 02:17:23 +00:00
.gitreview add .gitreview 2016-05-19 06:39:13 +00:00
.mailmap Add .mailmap file for mapping mail addresses in shortlog 2016-08-08 13:12:17 +02:00
COPYING add GPL to project source 2010-02-21 09:21:30 +01:00
Doxyfile.codec.in Set HTML_TIMESTAMP to NO to make build reproducible 2019-07-17 11:03:44 +00:00
Doxyfile.coding.in doxygen: enable cross referencing everywhere 2019-02-04 16:43:57 +00:00
Doxyfile.core.in Set HTML_TIMESTAMP to NO to make build reproducible 2019-07-17 11:03:44 +00:00
Doxyfile.ctrl.in doxygen: enable cross referencing everywhere 2019-02-04 16:43:57 +00:00
Doxyfile.gb.in doxygen: enable cross referencing everywhere 2019-02-04 16:43:57 +00:00
Doxyfile.gsm.in Set HTML_TIMESTAMP to NO to make build reproducible 2019-07-17 11:03:44 +00:00
Doxyfile.vty.in Set HTML_TIMESTAMP to NO to make build reproducible 2019-07-17 11:03:44 +00:00
Makefile.am add crcXXgen.c.tpl to EXTRA_DIST 2020-01-07 17:25:51 +01:00
README.md README.md: We don't build libosmotrau. The latter is in libosmo-abis.git 2020-05-12 05:43:21 +00:00
TODO-RELEASE sim: When decoding SW, take application specific SW into account 2020-05-05 19:41:12 +00:00
configure.ac Drop old BSC references in fd check configure option 2020-05-11 17:24:16 +00:00
git-version-gen add git-version-gen magic to automatically generate package version 2010-03-23 00:30:19 +08:00
libosmocodec.pc.in codec: Add the missing bits for include to install and pkgconfig to work 2010-10-24 18:23:10 +02:00
libosmocoding.pc.in libosmocoding: migrate transcoding routines from OsmoBTS 2017-03-07 01:06:38 +07:00
libosmocore.pc.in libosmocore.pc.in: Append -lsctp to Libs.private 2019-10-22 16:09:05 +02:00
libosmoctrl.pc.in remove our internal copy of talloc, use system libtalloc 2015-12-05 23:38:18 +01:00
libosmogb.pc.in remove our internal copy of talloc, use system libtalloc 2015-12-05 23:38:18 +01:00
libosmogsm.pc.in remove our internal copy of talloc, use system libtalloc 2015-12-05 23:38:18 +01:00
libosmosim.pc.in remove our internal copy of talloc, use system libtalloc 2015-12-05 23:38:18 +01:00
libosmousb.pc.in libosmocore libusb integration 2019-12-16 00:17:27 +01:00
libosmovty.pc.in remove our internal copy of talloc, use system libtalloc 2015-12-05 23:38:18 +01:00
osmo-release.mk Fixup severe build performance issues 2017-10-04 16:26:37 +02:00
osmo-release.sh osmo-release.sh: Improve of PKG_CHECK_MODULES from configure.ac 2020-01-02 18:33:26 +01:00

README.md

libosmocore - set of Osmocom core libraries

This repository contains a set of C-language libraries that form the core infrastructure of many Osmocom Open Source Mobile Communications projects.

Historically, a lot of this code was developed as part of the 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 Free Software / Open Source mobile communications.

There is no clear scope of it. We simply move all shared code between the various Osmocom projects in this library to avoid code duplication.

The libosmocore.git repository build multiple libraries:

  • libosmocore contains some general-purpose functions like select-loop abstraction, message buffers, timers, linked lists
  • libosmovty contains routines related to the interactive command-line interface called VTY
  • libosmogsm contains definitions and helper code related to GSM protocols
  • libosmoctrl contains a shared implementation of the Osmocom control interface
  • libosmogb contains an implementation of the Gb interface with its NS/BSSGP protocols
  • libosmocodec contains an implementation of GSM voice codecs
  • libosmocoding contains an implementation of GSM channel coding
  • libosmosim contains infrastructure to interface SIM/UICC/USIM cards

Homepage

The official homepage of the project is https://osmocom.org/projects/libosmocore/wiki/Libosmocore

GIT Repository

You can clone from the official libosmocore.git repository using

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

There is a cgit interface at http://git.osmocom.org/libosmocore/

Documentation

Doxygen-generated API documentation is generated during the build process, but also available online for each of the sub-libraries at http://ftp.osmocom.org/api/latest/libosmocore/

Mailing List

Discussions related to libosmocore are happening on the openbsc@lists.osmocom.org mailing list, please see https://lists.osmocom.org/mailman/listinfo/openbsc for subscription options and the list archive.

Please observe the Osmocom Mailing List Rules when posting.

Contributing

Our coding standards are described at https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards

We us a gerrit based patch submission/review process for managing contributions. Please see https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit for more details

The current patch queue for libosmocore can be seen at https://gerrit.osmocom.org/#/q/project:libosmocore+status:open