Skip to content

Commit 12cc7bb

Browse files
cfriedtnashif
cfriedt
authored and
nashif
committed
net: sockets: use z_finalize_typed_fd() to identify as sockets
Fill-in the mode field of the fd_entry so that the implementation can be made aware that the specific file descriptors created are sockets. Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
1 parent e1b95eb commit 12cc7bb

File tree

14 files changed

+53
-49
lines changed

14 files changed

+53
-49
lines changed

‎doc/connectivity/networking/api/sockets.rst‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -186,12 +186,13 @@ APIs, specified in :c:struct:`socket_op_vtable` struct.
186186

187187
The function registered for socket creation should allocate a new file
188188
descriptor using :c:func:`z_reserve_fd` function. Any additional actions,
189-
specific to the creation of a particular offloaded socket implementation should
190-
take place after the file descriptor is allocated. As a final step, if the
191-
offloaded socket was created successfully, the file descriptor should be
192-
finalized with :c:func:`z_finalize_fd` function. The finalize function allows
193-
to register a :c:struct:`socket_op_vtable` structure implementing socket APIs
194-
for an offloaded socket along with an optional socket context data pointer.
189+
specific to the creation of a particular offloaded socket implementation,
190+
should take place after the file descriptor is allocated. As a final step,
191+
if the offloaded socket was created successfully, the file descriptor should
192+
be finalized with :c:func:`z_finalize_typed_fd`, or :c:func:`z_finalize_fd`
193+
functions. The finalize function allows to register a
194+
:c:struct:`socket_op_vtable` structure implementing socket APIs for an
195+
offloaded socket along with an optional socket context data pointer.
195196

196197
Finally, when an offloaded network interface is initialized, it should indicate
197198
that the interface is offloaded with :c:func:`net_if_socket_offload_set`

‎drivers/modem/modem_socket.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,8 @@ int modem_socket_get(struct modem_socket_config *cfg, int family, int type, int
175175
cfg->sockets[i].ip_proto = proto;
176176
cfg->sockets[i].id = (cfg->assign_id) ? (i + cfg->base_socket_id) :
177177
(cfg->base_socket_id + cfg->sockets_len);
178-
z_finalize_fd(cfg->sockets[i].sock_fd, &cfg->sockets[i],
179-
(const struct fd_op_vtable *)cfg->vtable);
178+
z_finalize_typed_fd(cfg->sockets[i].sock_fd, &cfg->sockets[i],
179+
(const struct fd_op_vtable *)cfg->vtable, ZVFS_MODE_IFSOCK);
180180

181181
k_sem_give(&cfg->sem_lock);
182182
return cfg->sockets[i].sock_fd;

‎drivers/net/nsos_sockets.c‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ static int nsos_socket_create(int family, int type, int proto)
202202
goto free_sock;
203203
}
204204

205-
z_finalize_fd(fd, sock, &nsos_socket_fd_op_vtable.fd_vtable);
205+
z_finalize_typed_fd(fd, sock, &nsos_socket_fd_op_vtable.fd_vtable, ZVFS_MODE_IFSOCK);
206206

207207
return fd;
208208

@@ -718,7 +718,8 @@ static int nsos_accept(void *obj, struct sockaddr *addr, socklen_t *addrlen)
718718
conn_sock->fd = zephyr_fd;
719719
conn_sock->poll.mid.fd = adapt_fd;
720720

721-
z_finalize_fd(zephyr_fd, conn_sock, &nsos_socket_fd_op_vtable.fd_vtable);
721+
z_finalize_typed_fd(zephyr_fd, conn_sock, &nsos_socket_fd_op_vtable.fd_vtable,
722+
ZVFS_MODE_IFSOCK);
722723

723724
return zephyr_fd;
724725

‎drivers/wifi/eswifi/eswifi_socket_offload.c‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,9 @@ static int eswifi_socket_accept(void *obj, struct sockaddr *addr,
158158
return -1;
159159
}
160160

161-
z_finalize_fd(fd, SD_TO_OBJ(sock),
162-
(const struct fd_op_vtable *)
163-
&eswifi_socket_fd_op_vtable);
161+
z_finalize_typed_fd(fd, SD_TO_OBJ(sock),
162+
(const struct fd_op_vtable *)&eswifi_socket_fd_op_vtable,
163+
ZVFS_MODE_IFSOCK);
164164

165165
return fd;
166166
}
@@ -594,9 +594,9 @@ int eswifi_socket_create(int family, int type, int proto)
594594
return -1;
595595
}
596596

597-
z_finalize_fd(fd, SD_TO_OBJ(sock),
598-
(const struct fd_op_vtable *)
599-
&eswifi_socket_fd_op_vtable);
597+
z_finalize_typed_fd(fd, SD_TO_OBJ(sock),
598+
(const struct fd_op_vtable *)&eswifi_socket_fd_op_vtable,
599+
ZVFS_MODE_IFSOCK);
600600

601601
return fd;
602602
}

‎drivers/wifi/simplelink/simplelink_sockets.c‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1273,9 +1273,9 @@ int simplelink_socket_create(int family, int type, int proto)
12731273
return -1;
12741274
}
12751275

1276-
z_finalize_fd(fd, SD_TO_OBJ(sock),
1277-
(const struct fd_op_vtable *)
1278-
&simplelink_socket_fd_op_vtable);
1276+
z_finalize_typed_fd(fd, SD_TO_OBJ(sock),
1277+
(const struct fd_op_vtable *)&simplelink_socket_fd_op_vtable,
1278+
ZVFS_MODE_IFSOCK);
12791279

12801280
return fd;
12811281
}
@@ -1296,9 +1296,9 @@ static int simplelink_socket_accept(void *obj, struct sockaddr *addr,
12961296
return -1;
12971297
}
12981298

1299-
z_finalize_fd(fd, SD_TO_OBJ(sock),
1300-
(const struct fd_op_vtable *)
1301-
&simplelink_socket_fd_op_vtable);
1299+
z_finalize_typed_fd(fd, SD_TO_OBJ(sock),
1300+
(const struct fd_op_vtable *)&simplelink_socket_fd_op_vtable,
1301+
ZVFS_MODE_IFSOCK);
13021302

13031303
return fd;
13041304
}

‎subsys/net/lib/sockets/socket_dispatcher.c‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ static int sock_dispatch_socket(struct dispatcher_context *ctx,
6969

7070
/* Reassing FD with new obj and entry. */
7171
fd = ctx->fd;
72-
z_finalize_fd(fd, obj, (const struct fd_op_vtable *)vtable);
72+
z_finalize_typed_fd(fd, obj, (const struct fd_op_vtable *)vtable, ZVFS_MODE_IFSOCK);
7373

7474
/* Release FD that is no longer in use. */
7575
z_free_fd(new_fd);
@@ -482,8 +482,8 @@ static int sock_dispatch_create(int family, int type, int proto)
482482
entry->proto = proto;
483483
entry->is_used = true;
484484

485-
z_finalize_fd(fd, entry,
486-
(const struct fd_op_vtable *)&sock_dispatch_fd_op_vtable);
485+
z_finalize_typed_fd(fd, entry, (const struct fd_op_vtable *)&sock_dispatch_fd_op_vtable,
486+
ZVFS_MODE_IFSOCK);
487487

488488
out:
489489
k_mutex_unlock(&dispatcher_lock);

‎subsys/net/lib/sockets/socketpair.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -264,8 +264,8 @@ static struct spair *spair_new(void)
264264
goto cleanup;
265265
}
266266

267-
z_finalize_fd(spair->remote, spair,
268-
(const struct fd_op_vtable *)&spair_fd_op_vtable);
267+
z_finalize_typed_fd(spair->remote, spair, (const struct fd_op_vtable *)&spair_fd_op_vtable,
268+
ZVFS_MODE_IFSOCK);
269269

270270
goto out;
271271

‎subsys/net/lib/sockets/sockets.c‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,8 @@ static int zsock_socket_internal(int family, int type, int proto)
207207
net_context_ref(ctx);
208208
}
209209

210-
z_finalize_fd(fd, ctx, (const struct fd_op_vtable *)&sock_fd_op_vtable);
210+
z_finalize_typed_fd(fd, ctx, (const struct fd_op_vtable *)&sock_fd_op_vtable,
211+
ZVFS_MODE_IFSOCK);
211212

212213
NET_DBG("socket: ctx=%p, fd=%d", ctx, fd);
213214

@@ -710,7 +711,8 @@ int zsock_accept_ctx(struct net_context *parent, struct sockaddr *addr,
710711

711712
NET_DBG("accept: ctx=%p, fd=%d", ctx, fd);
712713

713-
z_finalize_fd(fd, ctx, (const struct fd_op_vtable *)&sock_fd_op_vtable);
714+
z_finalize_typed_fd(fd, ctx, (const struct fd_op_vtable *)&sock_fd_op_vtable,
715+
ZVFS_MODE_IFSOCK);
714716

715717
return fd;
716718
}

‎subsys/net/lib/sockets/sockets_can.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ int zcan_socket(int family, int type, int proto)
8080
*/
8181
k_condvar_init(&ctx->cond.recv);
8282

83-
z_finalize_fd(fd, ctx,
84-
(const struct fd_op_vtable *)&can_sock_fd_op_vtable);
83+
z_finalize_typed_fd(fd, ctx, (const struct fd_op_vtable *)&can_sock_fd_op_vtable,
84+
ZVFS_MODE_IFSOCK);
8585

8686
return fd;
8787
}

‎subsys/net/lib/sockets/sockets_net_mgmt.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ int znet_mgmt_socket(int family, int type, int proto)
8080
mgmt->alloc_timeout = MSG_ALLOC_TIMEOUT;
8181
mgmt->wait_timeout = K_FOREVER;
8282

83-
z_finalize_fd(fd, mgmt,
84-
(const struct fd_op_vtable *)&net_mgmt_sock_fd_op_vtable);
83+
z_finalize_typed_fd(fd, mgmt, (const struct fd_op_vtable *)&net_mgmt_sock_fd_op_vtable,
84+
ZVFS_MODE_IFSOCK);
8585

8686
return fd;
8787
}

0 commit comments

Comments
 (0)