Commit Graph

4867 Commits

Author SHA1 Message Date
Harald Welte 50e38cf36a Add funding link to github mirror
see https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository

Change-Id: I52d8c7cece35337eb33325146eccc8db005c55e3
2024-03-23 10:28:14 +01:00
Eric Wild 43018ec161 Revert "Revert "logging: add log level cache""
This reverts commit 7f1fb3ea81 - slightly
amended with the new log_cache_enalbe() function.  The cache is hence
disabled by default, and applications can enable it, if they wish to
benefit from it.

Reason for the original revert was: some fallout expected due to log
manipulation in test code

Change-Id: I539872fc9e3c50b407e6bc388f1e091fa2c826c3
2024-03-20 14:57:13 +01:00
Andreas Eversberg 35f20b1ff7 osmo_io_uring: Run check of tests/osmo_io with io_uring also
Related: OS#5751
Change-Id: I82db9a15bc483a5447d86352512afaafa2bcfbb6
2024-03-20 12:11:08 +01:00
Harald Welte 4ec4a38f92 osmo_io: Make {write,sendto,sendmsg} completion callback optional
There are situations (like multicast datagram transmit) where we don't
really care about the result of a write operation, and hence don't need
a write completion callback.

As the completed message buffer is free'd by core osmo_io, there is no leak
in doing so.

Change-Id: I0c071a29e508884bac331ada5e510bbfcf440bbf
2024-03-19 14:08:27 +01:00
Harald Welte e988ec3b53 osmo_io: Massive improvement of API documentation
* introduce a new "Osmocom I/O interface" group to show up in API docs
* expand the documentation to turn it into something useful for somebody
  wanting to write an application using it.

Change-Id: I6315cfc7ff34a0f8971517edf035e1efcef3ed5c
2024-03-19 14:08:26 +01:00
Harald Welte fab993bd31 osmo_io: Dont use __linux__ but !EMBEDDED
osmo_io (unlike its io_uring backend) is not linux specific, so putting
it in an "#ifdef __linux__" block is plain wrong.

A side-effect is that all our doxygen comments are not processed as
__linux__ is not set while doxygen parses the source file.

Change-Id: I260443ba3cd0bb81dade434208dea4ea70fe8ad8
2024-03-15 21:29:35 +01:00
Andreas Eversberg 9c0004ad0d Fix file descriptor that is passed to io_uring_register_eventfd()
Fix Change-Id I03752c0114cc6fad0c31fff6fff43072f36a50a7

Change-Id: Ie085c7cb3eb57e0da10485be8f90208cb41b0073
2024-03-14 13:10:35 +01:00
Vadim Yanitskiy 61906936f9 core: fix missing '\n' in iofd_uring_connected_cb()
Change-Id: I43df86cdbd3e52d4f8f7bc0e48478b6f9b288e9f
2024-03-14 09:11:11 +00:00
Harald Welte 9c604f4738 io_uring: check all operations in osmo_iofd_uring_init()
check all operations in osmo_iofd_uring_init() and panic if any of them
fails.

Change-Id: I03752c0114cc6fad0c31fff6fff43072f36a50a7
2024-03-14 08:22:28 +01:00
Harald Welte 5fcfbe0c69 io_uring: more verbose error messages if io_uring setup fails
"Assert failed 0 osmo_io_uring.c:94" is rather useless in terms of an
error message.  Let's improve upon that.

Change-Id: I0ac9ae59e99c3704b3ce33919c9e7d11024476e3
2024-03-14 08:22:28 +01:00
Pau Espin c9ad345afd socket: Add remote PID and local FD to AF_UNIX sockname
This allows identifying precisely an AF_UNIX socket.

Change-Id: Ic465e557ea49de8e044d1ef6d91fc3c852c88ff2
2024-03-12 18:50:54 +01:00
Pau Espin 9a7b2c950c socket: Support AF_UNIX in osmo_sock_get_name_buf()
Right now stream_cli/srv print "<error-in-getsockname>" when using an
AF_UNIX socket. This commit fixes the problem.

Change-Id: I224c3712a029ee338ee1209a67d820b887170910
2024-03-12 17:00:02 +00:00
Harald Welte b0db6495c5 ctrl: re-introduce duplicate declaration of ctrl_cmd_send()
In Change-Id Ic81af56e7ea6921ba39168727ef64c308e9c6754 we removed
the duplicate declaration of ctrl_cmd_send(), which was declared
both in control_if.h and in control_cmd.h.  Unfortunately  this broke
legacy openbsc.git, so let's re-introduce it.

Change-Id: I1d415c5e80cfb7ef9e11d33c0c3eaece40ebb1da
2024-03-12 14:36:22 +01:00
Andreas Eversberg 28c97a7238 osmo_io_poll: Use -errno as result on write error
This was done for read error in a previous patch. This is required
because osmo_io_uring does not support errno, instead it uses the
result code. To have a unified API, set the result code equally.

Related: OS#5751
Change-Id: I405094449a6644db37534757f2fbccbcff982f23
2024-03-08 08:08:54 +00:00
Harald Welte 8b7af448d6 osmo_io: Avoid implementing non-existant situations
Both of our back-ends have a register_fd and unregister_fd back-end.

Let's simplify the code by not treating them as optional, which
introduces code paths that we never take, adds small runtime overhead
and makes the code harder to follow.

Should we ever introduce more backends which might not need those
call-backs, we can either have empty functions or think about how to
make them optional.

Change-Id: I0077151eb676f61320b3fa2124448852aa8fd4a9
2024-03-07 15:51:50 +01:00
Harald Welte 257e7898c5 osmo_io: avoid OSMO_ASSERT one each API call
There's only one way to set the osmo_iofd_ops, which is by environment
variable during the constructor time at shared library load time.

There's hence no point in doing OSMO_ASSERT() on each and every call to
osmo_iofd_notify_connected() at runtime.  We can move those kind of
asserts to the one-time load-time constructor instead.

At the same time, we can extend those asserts to all the mandatory
call-backs to be provided by the backend.

Change-Id: Id9005ac6bb260236c88670373816bf7ee6a627f1
2024-03-07 15:51:50 +01:00
Harald Welte e1d4858277 osmo_io: Don't pretend to support backends without close_cb
Let's not pretend we support backends without a close_cb.  In such
situations nobody would actually close(2) the file descriptor,
but we would set iofd->fd to -1, effectively creating a file descriptor
leak.

Both of our two back-ends provide a close_cb, and we don't need to
consider hypothetical future back-ends that would not like to register
such a call-back.

Related: OS#6393
Change-Id: Id285f1d7b73ae5805aa618897016ae8b73bf892d
2024-03-07 15:51:50 +01:00
Harald Welte 09ab041b42 osmo_io: Log error message in case call-backs incompatible with mode
Change-Id: I50ba6a76c0144f249d67488874a6c4edf01ec6f2
2024-03-07 15:51:48 +01:00
Harald Welte 04e6f6e3da osmo_io: Guard osmo_iofd_register() with invalid file descriptor
Let's return an error if both osmo_iofd_setup() and osmo_iofd_register()
are called with an invalid file descriptor like -1.  Either one of them
must have been called with a valid file descriptor.

Change-Id: Ie4561cefad82e1bf5d37dd1a4815f4bc805343e6
2024-03-07 15:46:51 +01:00
Andreas Eversberg 25d5bf6570 osmo_io: do check_mode_callback_compat() only if ioops is set at osmo_iofd_setup()
Setting ioops is optional when calling osmo_iofd_setup(). If it is not
set, do not call check_mode_callback_compat() to check for
compatibility.

Closes: Coverity CID#349578
Change-Id: I1e25f3e420f25a44cbf73a4da9a498b7561e9ddd
2024-03-04 19:05:17 +00:00
Harald Welte 4f155022d8 cbsp: Add osmo_cbsp_segmentation_cb for message segmentation
This call-back can for example be used as segmentation call-back
for libosmo-netif stream_cli/stream_srv or directly for osmo_io.

Related: OS#5755
Change-Id: I5e922c54b3431d759b38e81e55076125c5a34008
2024-03-02 20:48:23 +01:00
Harald Welte 319a77e519 ctrl: Don't expose write_queue in ctrl_cmd_send() api
ctrl_cmd_send() should always have taken a 'struct ctrl_connection'
as argument, not directly its write_queue member.

Let's offer a ctrl_cmd_send2() which fixes the problem, and deprecate
the old ctrl_cmd_send().

Related: OS#5751
Change-Id: Ic81af56e7ea6921ba39168727ef64c308e9c6754
2024-03-02 18:59:16 +01:00
Andreas Eversberg ada88ce655 osmo_io_uring: Check if osmo_fd_register fails at iofd_uring_notify_connected()
If it fails, do not set the IOFD_FLAG_NOTIFY_CONNECTED flag and log an
error message.

Closes: Coverity CID#349579
Change-Id: I34e8cc9a2b9df0c624841e5f9268a15c32418da1
2024-03-02 09:29:10 +00:00
Andreas Eversberg a4ac5b8c26 osmo_io: Assign const name when stealing TX msg from iofd ctx
All TX messages are moved from iofd instance to the user's context.
iofd may be destroyed, but the message is still available to the user.
To prevent a use-after-free bug, the context name must be changed from
iofd->name to a constant that does not belong to iofd.

Change-Id: Ib8dae924fa2d94a7f636136ba7279b965a18cf5b
2024-02-29 16:32:39 +01:00
Harald Welte f574aea38f osmo_io: Add osmo_io_get_ioops() function
This function can be used by user code to obtain the currently-set io
operations, it's the inverse of osmo_io_set_ioops().

Change-Id: I03398c811b9534f50c6644b21eea89a04be29fb0
2024-02-29 09:15:43 +01:00
Andreas Eversberg 3c0d5001a5 osmo_io_poll: Declare local functions "static"
Change-Id: I6ba88cd7bbd5b5ef42eb460679696f105c9158cb
2024-02-29 09:15:41 +01:00
Andreas Eversberg 0f123aa6fc osmo_io_uring: Detach msghdr from iofd before calling iofd_handle_send_completion()
msghdr must be detached, because subsequent callback at
iofd_handle_send_completion() may destroy the iofd (which in turn
frees this msghdr, if still attached) and frees the msghdr, causing a
double free.

Related: OS#5751
Change-Id: Ia349f73de2145fa360b20dd40deb73a8ffc71f07
2024-02-29 09:15:38 +01:00
Andreas Eversberg 8db6009a3a osmo_io_uring: Cancel pending request, free msghdr on completion
There is always a completion after cancelling a uring request.

Because uring requests use msghdr pointer as user data, we cannot just
free the msghdr after cancelling. Upon completion (received after
cancelling), the user data still points to the msghdr. To prevent a
use-after-free bug, msghdr is not freed, but detached from iofd
instance. Then upon completion, the msghdr (if it was detached from
iofd) is freed.

Additionally it is not required to keep IOFD_FLAG_IN_CALLBACK set
anymore, if there is a msghdr attached to iofd. As described above,
all msghdr get detached, if iofd is freed (uring request get cancelled)
during callback.

Related: OS#5751
Change-Id: Ic253f085dd6362db85f029f46350951472210a02
2024-02-28 16:43:07 +01:00
Andreas Eversberg 76f7678cb1 osmo_io_poll: Use -errno as result on read error
Related: OS#5751
Change-Id: Ida63b74feecddf96bab7b2ade4e9ad216fe56e06
2024-02-28 16:43:03 +01:00
Andreas Eversberg 2ce17dab2b osmo_io: Reject writing messages with length of 0
io_uring will reject to transmit messages with length of 0.

Change-Id: I94be5ec7344d92157f7853c6c0ddf7007513ba8e
Related: OS#5751
2024-02-28 16:43:01 +01:00
Andreas Eversberg d7256c6c19 osmo_io: Use poll/select to notify socket connection at osmo_io_uring.c
In order to receive a connect notification from SCTP socket,
poll/select event must be used instead of a write notification via
io_uring completion event.

Once the connect notification has been received, subsequent write
notifications via io_uring are used.

Change-Id: I4eca9ea72beb0d6ea4d44cce81ed620033f07270
Related: OS#5751
2024-02-28 16:42:58 +01:00
Harald Welte 1047ed7255 osmo_io: sendmsg/recvmsg support
Add support osmo_io operations resembling sendmsg() and recvmsg() socket
operations.  This is what will enable the implementation of higher-layer
functions like equivalents of sctp_recvmsg() and sctp_send() in
libosmo-netif and/or other users.

Change-Id: I89eb519b22d21011d61a7855b2364bc3c295df82
Related: OS#5751
2024-02-28 16:42:57 +01:00
Andreas Eversberg 848faf9256 osmo_io: Move notify_connected function to backend
This relocation is necessary as the backend (osmo_io_fd or
osmo_io_uring) requires a different approach in handling connect
notifications. As a result, a function call has been introduced to
struct iofd_backend_ops.

In a subsequent patch, the process for the osmo_io_uring backend will
be modified to handle SCTP connect notifications using poll/select.

If connect notification is requested using poll/select, the file
descriptior must be registered to osmo_fd, using osmo_fd_register. If
read / write notification is requested by application, the file
descriptior must be registered also. A flag is used prevent calling
osmo_fd_register / osmo_fd_unregister multiple times, which would cause
a crash.

Change-Id: I905ec85210570aff8addadfc9603335d04eb057a
Related: OS#5751
2024-02-28 16:42:53 +01:00
Alexander Couzens 3938dfba5c gsup.h: define newly added PCO IE
PCO - Protocol Configuration Options 3GPP TS 24.008 / 10.5.6.3.
The PCO will be used by the osmo-epdg to pass PCO internally.
The PCO will be passed towards to the PGW in the Session Request.

Related: OS#6369
Related: osmo-gsm-manuals.git Change-Id Id912ead4e1205f84a40af6505a5ddf050d1e086d
Change-Id: I0f9de90c7c67fe194b441a9d118eba70f09afb5e
2024-02-27 17:08:18 +00:00
Harald Welte b365b1d094 osmo_io: Change struct osmo_io_ops to contain struct, not union
As we introduce more modes, and each mode aliases call-back function
pointers to those of another mode, we have more and more error cases
where we (for exampele) access read_cb, but in reality the user has
populated recvfrom_cb.

Let's use a struct, meaning that call-backs of one mode no longer alias
to the same memory locations of call-backs fro another mode.  This
allows us to properly check if the user actually provided the right
callbacks for the given mode of the iofd.

This breaks ABI, but luckily not API.  So a simple recompile of
higher-layer library + application code will work.

Change-Id: I9d302df8d00369e7b30437a52deb205f75882be3
2024-02-23 18:01:36 +01:00
Andreas Eversberg e8ab1b77d8 Make socket.c compile without libsctp support (--disable-libsctp)
Change-Id: I214a16b60e0149a8b1cdcfd3c788cc56a1a40476
2024-02-23 18:01:36 +01:00
Pau Espin 9d73503bd0 cosmetic: tests/gsup/gsup_test: Move send_e_send_end_signal_res to correct place
All the different procedures are placed in order, except this one.

Change-Id: If0877deca2bcbf40229c9c61f471112f1e8cdb0e
2024-02-12 10:50:16 +01:00
Neels Hofmeyr 99d6acb52a comment: gsm_04_08.h: add a spec hint
Change-Id: I2a606047db88ea47317397a790611048dead6403
2024-02-06 02:14:32 +01:00
Vadim Yanitskiy 3f4c6a8fbe coding: fix wrong n_bits_total reported for PDTCH CS2 and CS3
In gsm0503_pdtch_decode(), we decode CS2 and CS3 as if no puncturing
was employed, reordering the coded bits and setting punctured ones
to 0 manually.  Because of that, osmo_conv_decode_ber_punctured()
reports n_bits_total higher than we actually receive over the air.

Change-Id: I6b20cc450f25c48175a61da02644d66c08e22ece
Related: OS#6342, OS#6200
2024-01-31 23:10:40 +07:00
Vadim Yanitskiy 6c4be02962 coding: fix artificial bit errors for PDTCH CS2 and CS3
GPRS coding schemes CS2 and CS3 (defined in 3GPP TS 45.003 sections
5.1.2 and 5.1.3, respectively) employ so-called puncturing, which
can be described as intentional removal of coded bits.  The goal
of puncturing is to reduce the number of coded bits, so that they
fit into 4 bursts.  The receiving side recovers punctured bits,
as if they were received corrupted.

The puncturing is also used for other channel types like TCH/F9.6,
TCH/F14.4, TCH/AFS and TCH/AHS, but only for CS2 and CS3 we're
doing puncturing/depuncturing *manually*.  This explains why
we're seeing artificial bit errors only for CS2 and CS3.

gsm0503_pdtch_decode() should not be reporting punctured bits as
bit errors, fix this by using osmo_conv_decode_ber_punctured().

Change-Id: I024276d167e769396187998d881f8e7626461249
Related: OS#6342, OS#6200
2024-01-31 23:10:40 +07:00
Vadim Yanitskiy 2a72d683d3 coding: improve readability in osmo_conv_decode_ber_punctured()
Change-Id: Iaece6d0fe42f173187baa5c87fcbe3cfc60c21fc
Related: OS#6342, OS#6200
2024-01-31 23:10:35 +07:00
Vadim Yanitskiy 97374514c5 coding: fix a typo in docs for gsm0503_pdtch_decode()
Change-Id: I72e7dab116229d908add3896ecb47b59e3001f1b
2024-01-31 21:44:50 +07:00
Vadim Yanitskiy 462a93d30b utils/conv_codes_gsm.py: fix inconsistent formatting
Change-Id: Ida99f0fe149b234c738875527dd64b610d33e050
2024-01-31 21:44:49 +07:00
Matan Perelman 0df28e0779 ctrl: Add lchan node
Change-Id: Ibf2786f668ee7e4f5b6a9ef43f2141cd2d79b4e2
2024-01-30 18:31:26 +02:00
Andreas Eversberg e8f05481ea Prevent poll() in select.c to timeout too early
Adjust osmo_timers_nearest_ms() to round up the remaining time.

Note that poll() has a granularity of 1 millisecond.

Previously, when rounding down the remaining time, osmo_select_main()
would return too early, before the nearest timer timed out.
Consequently, the main loop repeatedly called osmo_select_main() until
the timer actually timed out, resulting in excessive CPU usage.
By modifying osmo_timers_nearest_ms() to round up the remaining time,
we ensure accurate timeout calculations, preventing unnecessary CPU
consumption during the main loop.

The patch only applies to non-embedded version of libosmocore, because
the impact on embedded systems is not verified tested.

Related: OS#6339
Change-Id: I79de77c79af4d50d1eb9ca0c5417123ff760dca3
2024-01-30 12:06:58 +00:00
Vadim Yanitskiy 22790c5d97 tests/Makefile.am: do not add files to EXTRA_DIST conditionally
These files must be present in the release tarballs regardless
of the configure options (ENABLE_LIBSCTP, ENABLE_SCTP_TESTS).

Change-Id: I8f530d6157b00907dd1b438100bb0fb300dfcd22
Related: OS#6349
2024-01-29 00:19:30 +07:00
Vadim Yanitskiy e3d27e9553 osmo-release.sh: make it a bit more user friendly
Change-Id: I8574cb00de820ab477eb5c4abd05d8e546ca89cc
2024-01-28 18:02:17 +07:00
Vadim Yanitskiy 911d487eab tests/sockaddr_str: rc_name(): also handle -EAFNOSUPPORT
Change-Id: I489378705e19c6b09f2fa894ddea4b8a0dc0c7e4
2024-01-26 01:06:16 +07:00
Vadim Yanitskiy cd7de91e22 tests/sockaddr_str: fix dead code, print some errno values
This fixes a -Wunused-function warning thrown by clang.

Change-Id: I45e9044f80e1f634c811e729f4314ec9bcf6a9ad
2024-01-26 01:05:16 +07:00
Vadim Yanitskiy 9cce346c81 tests/a5: fix bit-wise vs logical and in test_a5[34]()
This fixes a -Wbitwise-instead-of-logical warning thrown by clang.

Change-Id: I6ae0d13882ab7a6b1ca35ccd7f9a5e1d9cac911d
2024-01-25 17:30:28 +00:00