Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PoC] gnrc_netif: revamp gnrc_netif_ops_t interface #18965

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
+343 −282
Draft

[PoC] gnrc_netif: revamp gnrc_netif_ops_t interface #18965

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3289f4c
gnrc_netif: add set and get functions
jia200x Nov 23, 2022
8b9dae9
remove GNRC Netif thread
jia200x Nov 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions examples/spectrum-scanner/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,18 +89,18 @@ void spectrum_scanner(unsigned long interval_us)
for (unsigned int ch = IEEE802154_CHANNEL_MIN; ch <= IEEE802154_CHANNEL_MAX; ++ch) {
uint16_t tmp_ch = ch;
int res;
res = gnrc_netapi_set(netif->pid, NETOPT_CHANNEL, 0, &tmp_ch, sizeof(uint16_t));
res = gnrc_netif_set(netif->pid, NETOPT_CHANNEL, 0, &tmp_ch, sizeof(uint16_t));
if (res < 0) {
continue;
}
netopt_enable_t tmp;
/* Perform CCA to update ED level */
res = gnrc_netapi_get(netif->pid, NETOPT_IS_CHANNEL_CLR, 0, &tmp, sizeof(netopt_enable_t));
res = gnrc_netif_get(netif, NETOPT_IS_CHANNEL_CLR, 0, &tmp, sizeof(netopt_enable_t));
if (res < 0) {
continue;
}
int8_t level = 0;
res = gnrc_netapi_get(netif->pid, NETOPT_LAST_ED_LEVEL, 0, &level, sizeof(int8_t));
res = gnrc_netif_get(netif, NETOPT_LAST_ED_LEVEL, 0, &level, sizeof(int8_t));
if (res < 0) {
continue;
}
Expand Down
78 changes: 56 additions & 22 deletions sys/include/net/gnrc/netif.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ typedef struct {
* @brief ISR event for the network device
*/
event_t event_isr;
event_t event_dequeue;
#if IS_USED(MODULE_NETDEV_NEW_API) || defined(DOXYGEN)
/**
* @brief TX done event for the network device
Expand Down Expand Up @@ -220,7 +221,6 @@ typedef struct {
/**
* @brief Message queue for the netif thread
*/
msg_t msg_queue[GNRC_NETIF_MSG_QUEUE_SIZE];
uint8_t cur_hl; /**< Current hop-limit for out-going packets */
uint8_t device_type; /**< Device type */
kernel_pid_t pid; /**< PID of the network interface's thread */
Expand Down Expand Up @@ -300,7 +300,7 @@ struct gnrc_netif_ops {
* successful
* @return negative errno on error.
*/
int (*init)(gnrc_netif_t *netif);
int (*init)(gnrc_netif_t *netif, void *ctx);

/**
* @brief Send a @ref net_gnrc_pkt "packet" over the network interface
Expand All @@ -323,6 +323,7 @@ struct gnrc_netif_ops {
* @return Any negative error code reported by gnrc_netif_t::dev.
*/
int (*send)(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt);
int (*schedule)(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt);

/**
* @brief Receives a @ref net_gnrc_pkt "packet" from the network interface
Expand Down Expand Up @@ -356,7 +357,7 @@ struct gnrc_netif_ops {
* @return -ENOTSUP, if @p opt is not supported to be set.
* @return Any negative error code reported by gnrc_netif_t::dev.
*/
int (*get)(gnrc_netif_t *netif, gnrc_netapi_opt_t *opt);
int (*get)(gnrc_netif_t *netif, netopt_t opt, uint16_t context, void *value, size_t max_len);

/**
* @brief Sets an option from the network interface
Expand All @@ -373,7 +374,7 @@ struct gnrc_netif_ops {
* @return -ENOTSUP, if @p opt is not supported to be set.
* @return Any negative error code reported by gnrc_netif_t::dev.
*/
int (*set)(gnrc_netif_t *netif, const gnrc_netapi_opt_t *opt);
int (*set)(gnrc_netif_t *netif, netopt_t opt, uint16_t context, const void *value, size_t value_len);

/**
* @brief Message handler for network interface
Expand Down Expand Up @@ -462,6 +463,18 @@ gnrc_netif_t *gnrc_netif_iter(const gnrc_netif_t *prev);
*/
gnrc_netif_t *gnrc_netif_get_by_pid(kernel_pid_t pid);

static inline int gnrc_netif_get(gnrc_netif_t *netif, netopt_t opt, uint16_t context,
void *value, size_t max_len)
{
return netif->ops->get(netif, opt, context, value, max_len);
}

static inline int gnrc_netif_set(gnrc_netif_t *netif, netopt_t opt, uint16_t context,
const void *value, size_t value_len)
{
return netif->ops->set(netif, opt, context, value, value_len);
}

/**
* @brief Gets the (unicast on anycast) IPv6 address of an interface (if IPv6
* is supported)
Expand All @@ -483,14 +496,14 @@ gnrc_netif_t *gnrc_netif_get_by_pid(kernel_pid_t pid);
* May be 0 if no addresses are configured.
* @return -ENOTSUP, if @p netif doesn't support IPv6.
*/
static inline int gnrc_netif_ipv6_addrs_get(const gnrc_netif_t *netif,
static inline int gnrc_netif_ipv6_addrs_get(gnrc_netif_t *netif,
ipv6_addr_t *addrs,
size_t max_len)
{
assert(netif != NULL);
assert(addrs != NULL);
assert(max_len >= sizeof(ipv6_addr_t));
return gnrc_netapi_get(netif->pid, NETOPT_IPV6_ADDR, 0, addrs, max_len);
return gnrc_netif_get(netif, NETOPT_IPV6_ADDR, 0, addrs, max_len);
}

/**
Expand All @@ -514,14 +527,14 @@ static inline int gnrc_netif_ipv6_addrs_get(const gnrc_netif_t *netif,
* corresponding solicited-nodes multicast address.
* @return -ENOTSUP, if @p netif doesn't support IPv6.
*/
static inline int gnrc_netif_ipv6_addr_add(const gnrc_netif_t *netif,
static inline int gnrc_netif_ipv6_addr_add(gnrc_netif_t *netif,
const ipv6_addr_t *addr, unsigned pfx_len,
uint8_t flags)
{
assert(netif != NULL);
assert(addr != NULL);
assert((pfx_len > 0) && (pfx_len <= 128));
return gnrc_netapi_set(netif->pid, NETOPT_IPV6_ADDR,
return gnrc_netif_set(netif, NETOPT_IPV6_ADDR,
((pfx_len << 8U) | flags), addr,
sizeof(ipv6_addr_t));
}
Expand All @@ -539,12 +552,12 @@ static inline int gnrc_netif_ipv6_addr_add(const gnrc_netif_t *netif,
* @return sizeof(ipv6_addr_t) on success.
* @return -ENOTSUP, if @p netif doesn't support IPv6.
*/
static inline int gnrc_netif_ipv6_addr_remove(const gnrc_netif_t *netif,
static inline int gnrc_netif_ipv6_addr_remove(gnrc_netif_t *netif,
const ipv6_addr_t *addr)
{
assert(netif != NULL);
assert(addr != NULL);
return gnrc_netapi_set(netif->pid, NETOPT_IPV6_ADDR_REMOVE,
return gnrc_netif_set(netif, NETOPT_IPV6_ADDR_REMOVE,
0, addr, sizeof(ipv6_addr_t));
}

Expand All @@ -568,14 +581,14 @@ static inline int gnrc_netif_ipv6_addr_remove(const gnrc_netif_t *netif,
* success (including 0).
* @return -ENOTSUP, if @p netif doesn't support IPv6.
*/
static inline int gnrc_netif_ipv6_groups_get(const gnrc_netif_t *netif,
static inline int gnrc_netif_ipv6_groups_get(gnrc_netif_t *netif,
ipv6_addr_t *groups,
size_t max_len)
{
assert(netif != NULL);
assert(groups != NULL);
assert(max_len >= sizeof(ipv6_addr_t));
return gnrc_netapi_get(netif->pid, NETOPT_IPV6_GROUP, 0, groups, max_len);
return gnrc_netif_get(netif, NETOPT_IPV6_GROUP, 0, groups, max_len);
}

/**
Expand All @@ -592,12 +605,12 @@ static inline int gnrc_netif_ipv6_groups_get(const gnrc_netif_t *netif,
* @return -ENOMEM, if no space is left on @p netif to add @p group.
* @return -ENOTSUP, if @p netif doesn't support IPv6.
*/
static inline int gnrc_netif_ipv6_group_join(const gnrc_netif_t *netif,
static inline int gnrc_netif_ipv6_group_join(gnrc_netif_t *netif,
ipv6_addr_t *group)
{
assert(netif != NULL);
assert(group != NULL);
return gnrc_netapi_set(netif->pid, NETOPT_IPV6_GROUP, 0, group,
return gnrc_netif_set(netif, NETOPT_IPV6_GROUP, 0, group,
sizeof(ipv6_addr_t));
}

Expand All @@ -614,12 +627,12 @@ static inline int gnrc_netif_ipv6_group_join(const gnrc_netif_t *netif,
* @return sizeof(ipv6_addr_t) on success.
* @return -ENOTSUP, if @p netif doesn't support IPv6.
*/
static inline int gnrc_netif_ipv6_group_leave(const gnrc_netif_t *netif,
static inline int gnrc_netif_ipv6_group_leave(gnrc_netif_t *netif,
ipv6_addr_t *group)
{
assert(netif != NULL);
assert(group != NULL);
return gnrc_netapi_set(netif->pid, NETOPT_IPV6_GROUP_LEAVE, 0, group,
return gnrc_netif_set(netif, NETOPT_IPV6_GROUP_LEAVE, 0, group,
sizeof(ipv6_addr_t));
}

Expand All @@ -631,7 +644,7 @@ static inline int gnrc_netif_ipv6_group_leave(const gnrc_netif_t *netif,
*
* @param[in] netif The network interface.
*/
int gnrc_netif_default_init(gnrc_netif_t *netif);
int gnrc_netif_default_init(gnrc_netif_t *netif, void *ctx);

/**
* @brief Default operation for gnrc_netif_ops_t::get()
Expand All @@ -644,7 +657,9 @@ int gnrc_netif_default_init(gnrc_netif_t *netif);
* @return Return value of netdev_driver_t::get() of gnrc_netif_t::dev of
* @p netif.
*/
int gnrc_netif_get_from_netdev(gnrc_netif_t *netif, gnrc_netapi_opt_t *opt);
int gnrc_netif_get_from_netdev(gnrc_netif_t *netif, netopt_t opt, uint16_t context,
void *value, size_t max_len);
int _gnrc_netif_get_from_netdev(gnrc_netif_t *netif, gnrc_netapi_opt_t *opt);

/**
* @brief Default operation for gnrc_netif_ops_t::set()
Expand All @@ -657,8 +672,26 @@ int gnrc_netif_get_from_netdev(gnrc_netif_t *netif, gnrc_netapi_opt_t *opt);
* @return Return value of netdev_driver_t::set() of gnrc_netif_t::dev of
* @p netif.
*/
int gnrc_netif_set_from_netdev(gnrc_netif_t *netif,
const gnrc_netapi_opt_t *opt);
int gnrc_netif_set_from_netdev(gnrc_netif_t *netif, netopt_t opt, uint16_t context,
const void *value, size_t value_len);

typedef struct {
event_t event;
kernel_pid_t pid;
gnrc_netapi_opt_t opt;
gnrc_netif_t *netif;
int res;
} gnrc_netif_opt_ctx_t;

typedef struct {
event_t event;
kernel_pid_t pid;
gnrc_pktsnip_t *pkt;
gnrc_netif_t *netif;
int res;
} gnrc_netif_schedule_ctx_t;

int _gnrc_netif_set_from_netdev(gnrc_netif_t *netif, const gnrc_netapi_opt_t *opt);

/**
* @brief Gets an interface by the netdev type (and index)
Expand Down Expand Up @@ -720,6 +753,7 @@ static inline size_t gnrc_netif_addr_from_str(const char *str, uint8_t *out)
{
return l2util_addr_from_str(str, out);
}
int gnrc_netif_schedule_netapi_default(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt);

/**
* @brief Send a GNRC packet via a given @ref gnrc_netif_t interface.
Expand All @@ -732,9 +766,9 @@ static inline size_t gnrc_netif_addr_from_str(const char *str, uint8_t *out)
*/
static inline int gnrc_netif_send(gnrc_netif_t *netif, gnrc_pktsnip_t *pkt)
{
return gnrc_netapi_send(netif->pid, pkt);
assert(netif->ops->schedule);
return netif->ops->schedule(netif, pkt);
}

#if defined(MODULE_GNRC_NETIF_BUS) || DOXYGEN
/**
* @brief Get a message bus of a given @ref gnrc_netif_t interface.
Expand Down
4 changes: 2 additions & 2 deletions sys/net/gnrc/application_layer/dhcpv6/client.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ unsigned dhcpv6_client_get_duid_l2(unsigned iface, dhcpv6_duid_l2_t *duid)
netif = gnrc_netif_get_by_pid(iface);
}
assert(netif != NULL);
if ((res = gnrc_netapi_get(netif->pid, NETOPT_ADDRESS_LONG, 0,
if ((res = gnrc_netif_get(netif, NETOPT_ADDRESS_LONG, 0,
l2addr, GNRC_NETIF_L2ADDR_MAXLEN)) > 0) {
duid->l2type = byteorder_htons(ARP_HWTYPE_EUI64);
}
Expand All @@ -61,7 +61,7 @@ unsigned dhcpv6_client_get_duid_l2(unsigned iface, dhcpv6_duid_l2_t *duid)
case NETDEV_TYPE_ETHERNET:
case NETDEV_TYPE_BLE:
case NETDEV_TYPE_ESP_NOW:
if ((res = gnrc_netapi_get(netif->pid,
if ((res = gnrc_netif_get(netif,
NETOPT_ADDRESS,
0, l2addr,
GNRC_NETIF_L2ADDR_MAXLEN)) > 0) {
Expand Down
4 changes: 2 additions & 2 deletions sys/net/gnrc/application_layer/uhcpc/gnrc_uhcpc.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ static void set_interface_roles(void)

while ((netif = gnrc_netif_iter(netif))) {
kernel_pid_t dev = netif->pid;
int is_wired = gnrc_netapi_get(dev, NETOPT_IS_WIRED, 0, NULL, 0);
int is_wired = gnrc_netif_get(netif, NETOPT_IS_WIRED, 0, NULL, 0);
if ((!gnrc_border_interface) && (is_wired == 1)) {
ipv6_addr_t addr, defroute = IPV6_ADDR_UNSPECIFIED;
gnrc_border_interface = dev;

ipv6_addr_from_str(&addr, "fe80::2");
gnrc_netapi_set(dev, NETOPT_IPV6_ADDR, 64 << 8, &addr,
gnrc_netif_set(netif, NETOPT_IPV6_ADDR, 64 << 8, &addr,
sizeof(addr));
ipv6_addr_from_str(&addr, "fe80::1");
gnrc_ipv6_nib_ft_add(&defroute, IPV6_ADDR_BIT_LEN, &addr, dev, 0);
Expand Down
8 changes: 4 additions & 4 deletions sys/net/gnrc/netif/_netif.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,15 @@ netif_t *netif_get_by_id(int16_t id)
int netif_get_opt(netif_t *iface, netopt_t opt, uint16_t context,
void *value, size_t max_len)
{
const gnrc_netif_t *netif = container_of(iface, gnrc_netif_t, netif);
return gnrc_netapi_get(netif->pid, opt, context, value, max_len);
gnrc_netif_t *netif = container_of(iface, gnrc_netif_t, netif);
return gnrc_netif_get(netif, opt, context, value, max_len);
}

int netif_set_opt(netif_t *iface, netopt_t opt, uint16_t context,
void *value, size_t value_len)
{
const gnrc_netif_t *netif = container_of(iface, gnrc_netif_t, netif);
return gnrc_netapi_set(netif->pid, opt, context, value, value_len);
gnrc_netif_t *netif = container_of(iface, gnrc_netif_t, netif);
return gnrc_netif_set(netif, opt, context, value, value_len);
}

/** @} */
Loading