1 // SPDX-License-Identifier: GPL-2.0-only
3 * Generic netlink handshake service
5 * Author: Chuck Lever <chuck.lever@oracle.com>
7 * Copyright (c) 2023, Oracle and/or its affiliates.
10 #include <linux/types.h>
11 #include <linux/socket.h>
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/skbuff.h>
18 #include <net/genetlink.h>
19 #include <net/netns/generic.h>
21 #include <kunit/visibility.h>
23 #include <uapi/linux/handshake.h>
24 #include "handshake.h"
27 #include <trace/events/handshake.h>
30 * handshake_genl_notify - Notify handlers that a request is waiting
31 * @net: target network namespace
32 * @proto: handshake protocol
33 * @flags: memory allocation control flags
35 * Returns zero on success or a negative errno if notification failed.
37 int handshake_genl_notify(struct net *net, const struct handshake_proto *proto,
43 /* Disable notifications during unit testing */
44 if (!test_bit(HANDSHAKE_F_PROTO_NOTIFY, &proto->hp_flags))
47 if (!genl_has_listeners(&handshake_nl_family, net,
48 proto->hp_handler_class))
51 msg = genlmsg_new(GENLMSG_DEFAULT_SIZE, flags);
55 hdr = genlmsg_put(msg, 0, 0, &handshake_nl_family, 0,
60 if (nla_put_u32(msg, HANDSHAKE_A_ACCEPT_HANDLER_CLASS,
61 proto->hp_handler_class) < 0) {
62 genlmsg_cancel(msg, hdr);
66 genlmsg_end(msg, hdr);
67 return genlmsg_multicast_netns(&handshake_nl_family, net, msg,
68 0, proto->hp_handler_class, flags);
76 * handshake_genl_put - Create a generic netlink message header
77 * @msg: buffer in which to create the header
78 * @info: generic netlink message context
80 * Returns a ready-to-use header, or NULL.
82 struct nlmsghdr *handshake_genl_put(struct sk_buff *msg,
83 struct genl_info *info)
85 return genlmsg_put(msg, info->snd_portid, info->snd_seq,
86 &handshake_nl_family, 0, info->genlhdr->cmd);
88 EXPORT_SYMBOL(handshake_genl_put);
91 * dup() a kernel socket for use as a user space file descriptor
92 * in the current process. The kernel socket must have an
93 * instatiated struct file.
95 * Implicit argument: "current()"
97 static int handshake_dup(struct socket *sock)
102 file = get_file(sock->file);
103 newfd = get_unused_fd_flags(O_CLOEXEC);
109 fd_install(newfd, file);
113 int handshake_nl_accept_doit(struct sk_buff *skb, struct genl_info *info)
115 struct net *net = sock_net(skb->sk);
116 struct handshake_net *hn = handshake_pernet(net);
117 struct handshake_req *req = NULL;
126 if (GENL_REQ_ATTR_CHECK(info, HANDSHAKE_A_ACCEPT_HANDLER_CLASS))
128 class = nla_get_u32(info->attrs[HANDSHAKE_A_ACCEPT_HANDLER_CLASS]);
131 req = handshake_req_next(hn, class);
135 sock = req->hr_sk->sk_socket;
136 fd = handshake_dup(sock);
141 err = req->hr_proto->hp_accept(req, info, fd);
147 trace_handshake_cmd_accept(net, req, req->hr_sk, fd);
151 handshake_complete(req, -EIO, NULL);
153 trace_handshake_cmd_accept_err(net, req, NULL, err);
157 int handshake_nl_done_doit(struct sk_buff *skb, struct genl_info *info)
159 struct net *net = sock_net(skb->sk);
160 struct handshake_req *req;
164 if (GENL_REQ_ATTR_CHECK(info, HANDSHAKE_A_DONE_SOCKFD))
166 fd = nla_get_u32(info->attrs[HANDSHAKE_A_DONE_SOCKFD]);
168 sock = sockfd_lookup(fd, &err);
172 req = handshake_req_hash_lookup(sock->sk);
175 trace_handshake_cmd_done_err(net, req, sock->sk, err);
180 trace_handshake_cmd_done(net, req, sock->sk, fd);
183 if (info->attrs[HANDSHAKE_A_DONE_STATUS])
184 status = nla_get_u32(info->attrs[HANDSHAKE_A_DONE_STATUS]);
186 handshake_complete(req, status, info);
191 static unsigned int handshake_net_id;
193 static int __net_init handshake_net_init(struct net *net)
195 struct handshake_net *hn = net_generic(net, handshake_net_id);
200 * Arbitrary limit to prevent handshakes that do not make
201 * progress from clogging up the system. The cap scales up
202 * with the amount of physical memory on the system.
205 tmp = si.totalram / (25 * si.mem_unit);
206 hn->hn_pending_max = clamp(tmp, 3UL, 50UL);
208 spin_lock_init(&hn->hn_lock);
211 INIT_LIST_HEAD(&hn->hn_requests);
215 static void __net_exit handshake_net_exit(struct net *net)
217 struct handshake_net *hn = net_generic(net, handshake_net_id);
218 struct handshake_req *req;
222 * Drain the net's pending list. Requests that have been
223 * accepted and are in progress will be destroyed when
224 * the socket is closed.
226 spin_lock(&hn->hn_lock);
227 set_bit(HANDSHAKE_F_NET_DRAINING, &hn->hn_flags);
228 list_splice_init(&requests, &hn->hn_requests);
229 spin_unlock(&hn->hn_lock);
231 while (!list_empty(&requests)) {
232 req = list_first_entry(&requests, struct handshake_req, hr_list);
233 list_del(&req->hr_list);
236 * Requests on this list have not yet been
237 * accepted, so they do not have an fd to put.
240 handshake_complete(req, -ETIMEDOUT, NULL);
244 static struct pernet_operations handshake_genl_net_ops = {
245 .init = handshake_net_init,
246 .exit = handshake_net_exit,
247 .id = &handshake_net_id,
248 .size = sizeof(struct handshake_net),
252 * handshake_pernet - Get the handshake private per-net structure
253 * @net: network namespace
255 * Returns a pointer to the net's private per-net structure for the
256 * handshake module, or NULL if handshake_init() failed.
258 struct handshake_net *handshake_pernet(struct net *net)
260 return handshake_net_id ?
261 net_generic(net, handshake_net_id) : NULL;
263 EXPORT_SYMBOL_IF_KUNIT(handshake_pernet);
265 static int __init handshake_init(void)
269 ret = handshake_req_hash_init();
271 pr_warn("handshake: hash initialization failed (%d)\n", ret);
275 ret = genl_register_family(&handshake_nl_family);
277 pr_warn("handshake: netlink registration failed (%d)\n", ret);
278 handshake_req_hash_destroy();
283 * ORDER: register_pernet_subsys must be done last.
285 * If initialization does not make it past pernet_subsys
286 * registration, then handshake_net_id will remain 0. That
287 * shunts the handshake consumer API to return ENOTSUPP
288 * to prevent it from dereferencing something that hasn't
291 ret = register_pernet_subsys(&handshake_genl_net_ops);
293 pr_warn("handshake: pernet registration failed (%d)\n", ret);
294 genl_unregister_family(&handshake_nl_family);
295 handshake_req_hash_destroy();
301 static void __exit handshake_exit(void)
303 unregister_pernet_subsys(&handshake_genl_net_ops);
304 handshake_net_id = 0;
306 handshake_req_hash_destroy();
307 genl_unregister_family(&handshake_nl_family);
310 module_init(handshake_init);
311 module_exit(handshake_exit);