Loading...
Searching...
No Matches
tun.h
Go to the documentation of this file.
#pragma once
#if (!EMBEDDED)
#include <stddef.h>
#include <stdint.h>
#include <osmocom/core/msgb.h>
#include <osmocom/core/socket.h>
#include <osmocom/core/netdev.h>
struct osmo_tundev;
/* callback user gets ownership of the msgb and is expected to free it. */
typedef int (*osmo_tundev_data_ind_cb_t)(struct osmo_tundev *tun, struct msgb *msg);
struct osmo_tundev *osmo_tundev_alloc(void *ctx, const char *name);
void osmo_tundev_free(struct osmo_tundev *tundev);
int osmo_tundev_open(struct osmo_tundev *tundev);
int osmo_tundev_close(struct osmo_tundev *tundev);
bool osmo_tundev_is_open(struct osmo_tundev *tundev);
void osmo_tundev_set_priv_data(struct osmo_tundev *tundev, void *priv_data);
void *osmo_tundev_get_priv_data(struct osmo_tundev *tundev);
void osmo_tundev_set_data_ind_cb(struct osmo_tundev *tundev, osmo_tundev_data_ind_cb_t data_ind_cb);
const char *osmo_tundev_get_name(const struct osmo_tundev *tundev);
int osmo_tundev_get_fd(const struct osmo_tundev *tundev);
int osmo_tundev_set_dev_name(struct osmo_tundev *tundev, const char *dev_name);
const char *osmo_tundev_get_dev_name(const struct osmo_tundev *tundev);
int osmo_tundev_set_netns_name(struct osmo_tundev *tundev, const char *netns);
const char *osmo_tundev_get_netns_name(const struct osmo_tundev *tundev);
struct osmo_netdev *osmo_tundev_get_netdev(struct osmo_tundev *tundev);
int osmo_tundev_send(struct osmo_tundev *tundev, struct msgb *msg);
#endif /* (!EMBEDDED) */
osmo_tundev_get_dev_name
const char * osmo_tundev_get_dev_name(const struct osmo_tundev *tundev)
Get name used to name the tunnel interface created by the tundev object.
Definition tun.c:525
osmo_tundev_set_priv_data
void osmo_tundev_set_priv_data(struct osmo_tundev *tundev, void *priv_data)
Set private user data pointer on the tundev object.
Definition tun.c:460
osmo_tundev_alloc
struct osmo_tundev * osmo_tundev_alloc(void *ctx, const char *name)
Allocate a new tundev object.
Definition tun.c:229
osmo_tundev_is_open
bool osmo_tundev_is_open(struct osmo_tundev *tundev)
Retrieve whether the tundev object is in "opened" state.
Definition tun.c:452
osmo_tundev_set_dev_name
int osmo_tundev_set_dev_name(struct osmo_tundev *tundev, const char *dev_name)
Set name used to name the tunnel interface created by the tundev object.
Definition tun.c:512
osmo_tundev_get_priv_data
void * osmo_tundev_get_priv_data(struct osmo_tundev *tundev)
Get private user data pointer from the tundev object.
Definition tun.c:469
osmo_tundev_get_netdev
struct osmo_netdev * osmo_tundev_get_netdev(struct osmo_tundev *tundev)
Get netdev managing the tunnel interface of tundev.
Definition tun.c:560
osmo_tundev_get_fd
int osmo_tundev_get_fd(const struct osmo_tundev *tundev)
Get FD associated to the tundev object.
Definition tun.c:496
osmo_tundev_free
void osmo_tundev_free(struct osmo_tundev *tundev)
Free an allocated tundev object.
Definition tun.c:259
osmo_tundev_get_netns_name
const char * osmo_tundev_get_netns_name(const struct osmo_tundev *tundev)
Get name of network namespace used when opening the tunnel interface.
Definition tun.c:551
osmo_tundev_get_name
const char * osmo_tundev_get_name(const struct osmo_tundev *tundev)
Get name used to identify the tundev object.
Definition tun.c:487
osmo_tundev_set_data_ind_cb
void osmo_tundev_set_data_ind_cb(struct osmo_tundev *tundev, osmo_tundev_data_ind_cb_t data_ind_cb)
Set data_ind_cb callback, called when a new packet is received on the tun interface.
Definition tun.c:478
osmo_tundev_send
int osmo_tundev_send(struct osmo_tundev *tundev, struct msgb *msg)
Submit a packet to the tunnel device managed by the tundev object.
Definition tun.c:572
osmo_tundev_close
int osmo_tundev_close(struct osmo_tundev *tundev)
Close the tunnel device owned by the tundev object.
Definition tun.c:427
osmo_tundev_set_netns_name
int osmo_tundev_set_netns_name(struct osmo_tundev *tundev, const char *netns)
Set name of the network namespace to use when opening the tunnel interface.
Definition tun.c:539
osmo_tundev_open
int osmo_tundev_open(struct osmo_tundev *tundev)
Open the tunnel device owned by the tundev object.
Definition tun.c:345
msg
uint8_t msg[0]
name
char name[32]
source file name
Definition gsmtap.h:11
msgb.h
netdev.h
network device (interface) convenience functions.
socket.h
Osmocom socket convenience functions.
msgb
Osmocom message buffer.
Definition msgb.h:31
osmo_netdev
Definition netdev.c:255
osmo_tundev
Definition tun.c:111
osmo_tundev::priv_data
void * priv_data
Definition tun.c:134
osmo_tundev::dev_name
char * dev_name
Definition tun.c:123
osmo_tundev::data_ind_cb
osmo_tundev_data_ind_cb_t data_ind_cb
Definition tun.c:137
osmo_tundev_data_ind_cb_t
int(* osmo_tundev_data_ind_cb_t)(struct osmo_tundev *tun, struct msgb *msg)
Definition tun.h:17