libosmocore  1.7.0
Osmocom core library
gsmtap_util.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <stdint.h>
5 #include <osmocom/core/select.h>
6 
11 uint8_t chantype_rsl2gsmtap2(uint8_t rsl_chantype, uint8_t rsl_link_id, bool user_plane);
12 
13 uint8_t chantype_rsl2gsmtap(uint8_t rsl_chantype, uint8_t rsl_link_id)
14  OSMO_DEPRECATED("Use chantype_rsl2gsmtap2() instead");
15 
16 void chantype_gsmtap2rsl(uint8_t gsmtap_chantype, uint8_t *rsl_chantype, uint8_t *link_id);
17 
18 struct msgb *gsmtap_makemsg_ex(uint8_t type, uint16_t arfcn, uint8_t ts, uint8_t chan_type,
19  uint8_t ss, uint32_t fn, int8_t signal_dbm,
20  int8_t snr, const uint8_t *data, unsigned int len);
21 
22 struct msgb *gsmtap_makemsg(uint16_t arfcn, uint8_t ts, uint8_t chan_type,
23  uint8_t ss, uint32_t fn, int8_t signal_dbm,
24  int8_t snr, const uint8_t *data, unsigned int len);
25 
27 struct gsmtap_inst {
29  struct osmo_wqueue wq;
30  struct osmo_fd sink_ofd;
31 };
32 
36 static inline int gsmtap_inst_fd(struct gsmtap_inst *gti)
37 {
38  return gti->wq.bfd.fd;
39 }
40 
41 int gsmtap_source_init_fd(const char *host, uint16_t port);
42 
43 int gsmtap_source_add_sink_fd(int gsmtap_fd);
44 
45 struct gsmtap_inst *gsmtap_source_init(const char *host, uint16_t port,
46  int ofd_wq_mode);
47 void gsmtap_source_free(struct gsmtap_inst *gti);
48 
49 int gsmtap_source_add_sink(struct gsmtap_inst *gti);
50 
51 int gsmtap_sendmsg(struct gsmtap_inst *gti, struct msgb *msg);
52 int gsmtap_sendmsg_free(struct gsmtap_inst *gti, struct msgb *msg);
53 
54 int gsmtap_send_ex(struct gsmtap_inst *gti, uint8_t type, uint16_t arfcn, uint8_t ts,
55  uint8_t chan_type, uint8_t ss, uint32_t fn,
56  int8_t signal_dbm, int8_t snr, const uint8_t *data,
57  unsigned int len);
58 
59 int gsmtap_send(struct gsmtap_inst *gti, uint16_t arfcn, uint8_t ts,
60  uint8_t chan_type, uint8_t ss, uint32_t fn,
61  int8_t signal_dbm, int8_t snr, const uint8_t *data,
62  unsigned int len);
63 
64 extern const struct value_string gsmtap_gsm_channel_names[];
65 extern const struct value_string gsmtap_type_names[];
66 
gsmtap_inst::ofd_wq_mode
int ofd_wq_mode
wait queue mode?
Definition: gsmtap_util.h:28
OSMO_DEPRECATED
#define OSMO_DEPRECATED(text)
Set the deprecated attribute with a message.
Definition: defs.h:41
len
static size_t len(const char *str)
write_queue.h
gsmtap_source_init_fd
int gsmtap_source_init_fd(const char *host, uint16_t port)
Create a new (sending) GSMTAP source socket.
Definition: gsmtap_util.c:245
gsmtap_source_add_sink_fd
int gsmtap_source_add_sink_fd(int gsmtap_fd)
Add a local sink to an existing GSMTAP source and return fd.
Definition: gsmtap_util.c:268
gsmtap_source_init
struct gsmtap_inst * gsmtap_source_init(const char *host, uint16_t port, int ofd_wq_mode)
Open GSMTAP source socket, connect and register osmo_fd.
Definition: gsmtap_util.c:459
gsmtap_makemsg
struct msgb * gsmtap_makemsg(uint16_t arfcn, uint8_t ts, uint8_t chan_type, uint8_t ss, uint32_t fn, int8_t signal_dbm, int8_t snr, const uint8_t *data, unsigned int len)
create L1/L2 data and put it into GSMTAP
Definition: gsmtap_util.c:222
chantype_rsl2gsmtap
uint8_t chantype_rsl2gsmtap(uint8_t rsl_chantype, uint8_t rsl_link_id) OSMO_DEPRECATED("Use chantype_rsl2gsmtap2() instead")
convert RSL channel number to GSMTAP channel type
Definition: gsmtap_util.c:113
signal_dbm
int8_t signal_dbm
signal level in dBm
Definition: gsmtap.h:8
gsmtap_inst::sink_ofd
struct osmo_fd sink_ofd
file descriptor
Definition: gsmtap_util.h:30
data
uint8_t data[0]
gsmtap_type_names
const struct value_string gsmtap_type_names[]
Definition: gsmtap_util.c:535
gsmtap_send
int gsmtap_send(struct gsmtap_inst *gti, uint16_t arfcn, uint8_t ts, uint8_t chan_type, uint8_t ss, uint32_t fn, int8_t signal_dbm, int8_t snr, const uint8_t *data, unsigned int len)
send a message from L1/L2 through GSMTAP.
Definition: gsmtap_util.c:364
gsmtap_makemsg_ex
struct msgb * gsmtap_makemsg_ex(uint8_t type, uint16_t arfcn, uint8_t ts, uint8_t chan_type, uint8_t ss, uint32_t fn, int8_t signal_dbm, int8_t snr, const uint8_t *data, unsigned int len)
create an arbitrary type GSMTAP message
Definition: gsmtap_util.c:175
msgb
Osmocom message buffer.
Definition: msgb.h:31
gsmtap_inst
one gsmtap instance
Definition: gsmtap_util.h:27
gsmtap_sendmsg_free
int gsmtap_sendmsg_free(struct gsmtap_inst *gti, struct msgb *msg)
Send a Message buffers through a GSMTAP source; free the message even if tx queue full.
Definition: gsmtap_util.c:327
osmo_wqueue
write queue instance
Definition: write_queue.h:30
gsmtap_source_add_sink
int gsmtap_source_add_sink(struct gsmtap_inst *gti)
Add a local sink to an existing GSMTAP source and return fd.
Definition: gsmtap_util.c:422
ts
struct @6 ts
gsmtap_sendmsg
int gsmtap_sendmsg(struct gsmtap_inst *gti, struct msgb *msg)
Send a Message buffers through a GSMTAP source.
Definition: gsmtap_util.c:298
gsmtap_inst::wq
struct osmo_wqueue wq
the wait queue
Definition: gsmtap_util.h:29
chantype_gsmtap2rsl
void chantype_gsmtap2rsl(uint8_t gsmtap_chantype, uint8_t *rsl_chantype, uint8_t *link_id)
convert GSMTAP channel type to RSL channel number + Link ID
Definition: gsmtap_util.c:123
host
value_string
A mapping between human-readable string and numeric value.
Definition: utils.h:51
type
enum osmo_sub_auth_type type
gsmtap_send_ex
int gsmtap_send_ex(struct gsmtap_inst *gti, uint8_t type, uint16_t arfcn, uint8_t ts, uint8_t chan_type, uint8_t ss, uint32_t fn, int8_t signal_dbm, int8_t snr, const uint8_t *data, unsigned int len)
send an arbitrary type through GSMTAP.
Definition: gsmtap_util.c:339
osmo_wqueue::bfd
struct osmo_fd bfd
osmocom file descriptor
Definition: write_queue.h:32
gsmtap_gsm_channel_names
const struct value_string gsmtap_gsm_channel_names[]
Definition: gsmtap_util.c:507
select.h
gsmtap_source_free
void gsmtap_source_free(struct gsmtap_inst *gti)
Definition: gsmtap_util.c:489
osmo_fd
Structure representing a file dsecriptor.
Definition: select.h:31
chantype_rsl2gsmtap2
uint8_t chantype_rsl2gsmtap2(uint8_t rsl_chantype, uint8_t rsl_link_id, bool user_plane)
convert RSL channel number to GSMTAP channel type
Definition: gsmtap_util.c:56
gsmtap_inst_fd
static int gsmtap_inst_fd(struct gsmtap_inst *gti)
obtain the file descriptor associated with a gsmtap instance
Definition: gsmtap_util.h:36
arfcn
uint16_t arfcn
ARFCN (frequency)
Definition: gsmtap.h:7
osmo_fd::fd
int fd
actual operating-system level file decriptor
Definition: select.h:35