]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
nfsd: add netlink upcall for the nfsd.fh cache
authorJeff Layton <jlayton@kernel.org>
Wed, 25 Mar 2026 14:40:32 +0000 (10:40 -0400)
committerChuck Lever <chuck.lever@oracle.com>
Mon, 1 Jun 2026 15:08:18 +0000 (11:08 -0400)
Add netlink-based cache upcall support for the expkey (nfsd.fh) cache,
following the same pattern as the existing svc_export netlink support.

Add expkey to the cache-type enum, a new expkey attribute-set with
client, fsidtype, fsid, negative, expiry, and path fields, and the
expkey-get-reqs / expkey-set-reqs operations to the nfsd YAML spec
and generated headers.

Implement nfsd_nl_expkey_get_reqs_dumpit() which snapshots pending
expkey cache requests and sends each entry's seqno, client name,
fsidtype, and fsid over netlink.

Implement nfsd_nl_expkey_set_reqs_doit() which parses expkey cache
responses from userspace (client, fsidtype, fsid, expiry, and path
or negative flag) and updates the cache via svc_expkey_lookup() /
svc_expkey_update().

Wire up the expkey_notify() callback in svc_expkey_cache_template
so cache misses trigger NFSD_CMD_CACHE_NOTIFY multicast events with
NFSD_CACHE_TYPE_EXPKEY.

Signed-off-by: Jeff Layton <jlayton@kernel.org>
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
Documentation/netlink/specs/nfsd.yaml
fs/nfsd/export.c
fs/nfsd/netlink.c
fs/nfsd/netlink.h
include/uapi/linux/nfsd_netlink.h

index 9ba1cf348b405d88fc2f931184c59cb78c3601ee..7030b40273fd4fe4e67517fb549917ce8ec1c3e4 100644 (file)
@@ -10,7 +10,7 @@ definitions:
   -
     type: flags
     name: cache-type
-    entries: [svc_export]
+    entries: [svc_export, expkey]
   -
     type: flags
     name: export-flags
@@ -261,6 +261,38 @@ attribute-sets:
         type: nest
         nested-attributes: svc-export
         multi-attr: true
+  -
+    name: expkey
+    attributes:
+      -
+        name: seqno
+        type: u64
+      -
+        name: client
+        type: string
+      -
+        name: fsidtype
+        type: u8
+      -
+        name: fsid
+        type: binary
+      -
+        name: negative
+        type: flag
+      -
+        name: expiry
+        type: u64
+      -
+        name: path
+        type: string
+  -
+    name: expkey-reqs
+    attributes:
+      -
+        name: requests
+        type: nest
+        nested-attributes: expkey
+        multi-attr: true
 
 operations:
   list:
@@ -388,6 +420,24 @@ operations:
           request:
             attributes:
               - requests
+    -
+      name: expkey-get-reqs
+      doc: Dump all pending expkey requests
+      attribute-set: expkey-reqs
+      flags: [admin-perm]
+      dump:
+          request:
+            attributes:
+              - requests
+    -
+      name: expkey-set-reqs
+      doc: Respond to one or more expkey requests
+      attribute-set: expkey-reqs
+      flags: [admin-perm]
+      do:
+          request:
+            attributes:
+              - requests
 
 mcast-groups:
   list:
index 79bfa7a7087a74aa7ebc8a1033a9d992ad434153..eb020054f9a3f5f2dfb05023915fd2988abd73cd 100644 (file)
@@ -266,12 +266,18 @@ static void expkey_flush(void)
        mutex_unlock(&nfsd_mutex);
 }
 
+static int expkey_notify(struct cache_detail *cd, struct cache_head *h)
+{
+       return nfsd_cache_notify(cd, h, NFSD_CACHE_TYPE_EXPKEY);
+}
+
 static const struct cache_detail svc_expkey_cache_template = {
        .owner          = THIS_MODULE,
        .hash_size      = EXPKEY_HASHMAX,
        .name           = "nfsd.fh",
        .cache_put      = expkey_put,
        .cache_upcall   = expkey_upcall,
+       .cache_notify   = expkey_notify,
        .cache_request  = expkey_request,
        .cache_parse    = expkey_parse,
        .cache_show     = expkey_show,
@@ -322,6 +328,266 @@ svc_expkey_update(struct cache_detail *cd, struct svc_expkey *new,
                return NULL;
 }
 
+/**
+ * nfsd_nl_expkey_get_reqs_dumpit - dump pending expkey requests
+ * @skb: reply buffer
+ * @cb: netlink metadata and command arguments
+ *
+ * Walk the expkey cache's pending request list and create a netlink
+ * message with a nested entry for each cache_request, containing the
+ * seqno, client string, fsidtype and fsid.
+ *
+ * Uses cb->args[0] as a seqno cursor for dump continuation across
+ * multiple netlink messages.
+ *
+ * Returns the size of the reply or a negative errno.
+ */
+int nfsd_nl_expkey_get_reqs_dumpit(struct sk_buff *skb,
+                                  struct netlink_callback *cb)
+{
+       struct nfsd_net *nn;
+       struct cache_detail *cd;
+       struct cache_head **items;
+       u64 *seqnos;
+       int cnt, i, emitted;
+       void *hdr;
+       int ret;
+
+       nn = net_generic(sock_net(skb->sk), nfsd_net_id);
+
+       mutex_lock(&nfsd_mutex);
+
+       cd = nn->svc_expkey_cache;
+       if (!cd) {
+               ret = -ENODEV;
+               goto out_unlock;
+       }
+
+       cnt = sunrpc_cache_requests_count(cd);
+       if (!cnt) {
+               ret = 0;
+               goto out_unlock;
+       }
+
+       items = kcalloc(cnt, sizeof(*items), GFP_KERNEL);
+       seqnos = kcalloc(cnt, sizeof(*seqnos), GFP_KERNEL);
+       if (!items || !seqnos) {
+               ret = -ENOMEM;
+               goto out_alloc;
+       }
+
+       cnt = sunrpc_cache_requests_snapshot(cd, items, seqnos, cnt,
+                                            cb->args[0]);
+       if (!cnt) {
+               ret = 0;
+               goto out_alloc;
+       }
+
+       hdr = genlmsg_put(skb, NETLINK_CB(cb->skb).portid,
+                         cb->nlh->nlmsg_seq, &nfsd_nl_family,
+                         NLM_F_MULTI, NFSD_CMD_EXPKEY_GET_REQS);
+       if (!hdr) {
+               ret = -ENOBUFS;
+               goto out_put;
+       }
+
+       emitted = 0;
+       for (i = 0; i < cnt; i++) {
+               struct svc_expkey *ek;
+               struct nlattr *nest;
+
+               ek = container_of(items[i], struct svc_expkey, h);
+
+               nest = nla_nest_start(skb, NFSD_A_EXPKEY_REQS_REQUESTS);
+               if (!nest)
+                       break;
+
+               if (nla_put_u64_64bit(skb, NFSD_A_EXPKEY_SEQNO,
+                                     seqnos[i], 0) ||
+                   nla_put_string(skb, NFSD_A_EXPKEY_CLIENT,
+                                  ek->ek_client->name) ||
+                   nla_put_u8(skb, NFSD_A_EXPKEY_FSIDTYPE,
+                              ek->ek_fsidtype) ||
+                   nla_put(skb, NFSD_A_EXPKEY_FSID,
+                           key_len(ek->ek_fsidtype), ek->ek_fsid)) {
+                       nla_nest_cancel(skb, nest);
+                       break;
+               }
+
+               nla_nest_end(skb, nest);
+               cb->args[0] = seqnos[i];
+               emitted++;
+       }
+
+       if (!emitted) {
+               genlmsg_cancel(skb, hdr);
+               ret = -EMSGSIZE;
+               goto out_put;
+       }
+
+       genlmsg_end(skb, hdr);
+       ret = skb->len;
+out_put:
+       for (i = 0; i < cnt; i++)
+               cache_put(items[i], cd);
+out_alloc:
+       kfree(seqnos);
+       kfree(items);
+out_unlock:
+       mutex_unlock(&nfsd_mutex);
+       return ret;
+}
+
+/**
+ * nfsd_nl_parse_one_expkey - parse one expkey entry from netlink
+ * @cd: cache_detail for the expkey cache
+ * @attr: nested attribute containing expkey fields
+ *
+ * Parses one expkey entry from a netlink message and updates the
+ * cache. Mirrors the logic in expkey_parse().
+ *
+ * Returns 0 on success or a negative errno.
+ */
+static int nfsd_nl_parse_one_expkey(struct cache_detail *cd,
+                                   struct nlattr *attr)
+{
+       struct nlattr *tb[NFSD_A_EXPKEY_PATH + 1];
+       struct auth_domain *dom = NULL;
+       struct svc_expkey key;
+       struct svc_expkey *ek = NULL;
+       struct timespec64 boot;
+       int err;
+       u8 fsidtype;
+       int fsid_len;
+
+       err = nla_parse_nested(tb, NFSD_A_EXPKEY_PATH, attr,
+                              nfsd_expkey_nl_policy, NULL);
+       if (err)
+               return err;
+
+       /* client (required) */
+       if (!tb[NFSD_A_EXPKEY_CLIENT])
+               return -EINVAL;
+
+       dom = auth_domain_find(nla_data(tb[NFSD_A_EXPKEY_CLIENT]));
+       if (!dom)
+               return -ENOENT;
+
+       /* fsidtype (required) */
+       if (!tb[NFSD_A_EXPKEY_FSIDTYPE]) {
+               err = -EINVAL;
+               goto out_dom;
+       }
+       fsidtype = nla_get_u8(tb[NFSD_A_EXPKEY_FSIDTYPE]);
+       if (key_len(fsidtype) == 0) {
+               err = -EINVAL;
+               goto out_dom;
+       }
+
+       /* fsid (required) */
+       if (!tb[NFSD_A_EXPKEY_FSID]) {
+               err = -EINVAL;
+               goto out_dom;
+       }
+       fsid_len = nla_len(tb[NFSD_A_EXPKEY_FSID]);
+       if (fsid_len != key_len(fsidtype)) {
+               err = -EINVAL;
+               goto out_dom;
+       }
+
+       /* expiry (required, wallclock seconds) */
+       if (!tb[NFSD_A_EXPKEY_EXPIRY]) {
+               err = -EINVAL;
+               goto out_dom;
+       }
+
+       key.h.flags = 0;
+       getboottime64(&boot);
+       key.h.expiry_time = nla_get_u64(tb[NFSD_A_EXPKEY_EXPIRY]) -
+                           boot.tv_sec;
+       key.ek_client = dom;
+       key.ek_fsidtype = fsidtype;
+       memcpy(key.ek_fsid, nla_data(tb[NFSD_A_EXPKEY_FSID]), fsid_len);
+
+       ek = svc_expkey_lookup(cd, &key);
+       if (!ek) {
+               err = -ENOMEM;
+               goto out_dom;
+       }
+
+       if (tb[NFSD_A_EXPKEY_NEGATIVE]) {
+               set_bit(CACHE_NEGATIVE, &key.h.flags);
+               ek = svc_expkey_update(cd, &key, ek);
+               if (ek)
+                       trace_nfsd_expkey_update(ek, NULL);
+               else
+                       err = -ENOMEM;
+       } else if (tb[NFSD_A_EXPKEY_PATH]) {
+               err = kern_path(nla_data(tb[NFSD_A_EXPKEY_PATH]), 0,
+                               &key.ek_path);
+               if (err)
+                       goto out_ek;
+               ek = svc_expkey_update(cd, &key, ek);
+               if (ek)
+                       trace_nfsd_expkey_update(ek,
+                                       nla_data(tb[NFSD_A_EXPKEY_PATH]));
+               else
+                       err = -ENOMEM;
+               path_put(&key.ek_path);
+       } else {
+               err = -EINVAL;
+               goto out_ek;
+       }
+
+       cache_flush();
+
+out_ek:
+       if (ek)
+               cache_put(&ek->h, cd);
+out_dom:
+       auth_domain_put(dom);
+       return err;
+}
+
+/**
+ * nfsd_nl_expkey_set_reqs_doit - respond to expkey requests
+ * @skb: reply buffer
+ * @info: netlink metadata and command arguments
+ *
+ * Parse one or more expkey cache responses from userspace and
+ * update the expkey cache accordingly.
+ *
+ * Returns 0 on success or a negative errno.
+ */
+int nfsd_nl_expkey_set_reqs_doit(struct sk_buff *skb,
+                                struct genl_info *info)
+{
+       struct nfsd_net *nn;
+       struct cache_detail *cd;
+       const struct nlattr *attr;
+       int rem, ret = 0;
+
+       nn = net_generic(genl_info_net(info), nfsd_net_id);
+
+       mutex_lock(&nfsd_mutex);
+
+       cd = nn->svc_expkey_cache;
+       if (!cd) {
+               ret = -ENODEV;
+               goto out_unlock;
+       }
+
+       nlmsg_for_each_attr_type(attr, NFSD_A_EXPKEY_REQS_REQUESTS,
+                                info->nlhdr, GENL_HDRLEN, rem) {
+               ret = nfsd_nl_parse_one_expkey(cd, (struct nlattr *)attr);
+               if (ret)
+                       break;
+       }
+
+out_unlock:
+       mutex_unlock(&nfsd_mutex);
+       return ret;
+}
 
 #define        EXPORT_HASHBITS         8
 #define        EXPORT_HASHMAX          (1<< EXPORT_HASHBITS)
index fb401d7302afb9e41cb074581f7b94e8ece6cf0c..394230e250a5b07fa0bb6a5b76f7282758e94565 100644 (file)
@@ -17,6 +17,16 @@ const struct nla_policy nfsd_auth_flavor_nl_policy[NFSD_A_AUTH_FLAVOR_FLAGS + 1]
        [NFSD_A_AUTH_FLAVOR_FLAGS] = NLA_POLICY_MASK(NLA_U32, 0x3ffff),
 };
 
+const struct nla_policy nfsd_expkey_nl_policy[NFSD_A_EXPKEY_PATH + 1] = {
+       [NFSD_A_EXPKEY_SEQNO] = { .type = NLA_U64, },
+       [NFSD_A_EXPKEY_CLIENT] = { .type = NLA_NUL_STRING, },
+       [NFSD_A_EXPKEY_FSIDTYPE] = { .type = NLA_U8, },
+       [NFSD_A_EXPKEY_FSID] = { .type = NLA_BINARY, },
+       [NFSD_A_EXPKEY_NEGATIVE] = { .type = NLA_FLAG, },
+       [NFSD_A_EXPKEY_EXPIRY] = { .type = NLA_U64, },
+       [NFSD_A_EXPKEY_PATH] = { .type = NLA_NUL_STRING, },
+};
+
 const struct nla_policy nfsd_fslocation_nl_policy[NFSD_A_FSLOCATION_PATH + 1] = {
        [NFSD_A_FSLOCATION_HOST] = { .type = NLA_NUL_STRING, },
        [NFSD_A_FSLOCATION_PATH] = { .type = NLA_NUL_STRING, },
@@ -88,6 +98,16 @@ static const struct nla_policy nfsd_svc_export_set_reqs_nl_policy[NFSD_A_SVC_EXP
        [NFSD_A_SVC_EXPORT_REQS_REQUESTS] = NLA_POLICY_NESTED(nfsd_svc_export_nl_policy),
 };
 
+/* NFSD_CMD_EXPKEY_GET_REQS - dump */
+static const struct nla_policy nfsd_expkey_get_reqs_nl_policy[NFSD_A_EXPKEY_REQS_REQUESTS + 1] = {
+       [NFSD_A_EXPKEY_REQS_REQUESTS] = NLA_POLICY_NESTED(nfsd_expkey_nl_policy),
+};
+
+/* NFSD_CMD_EXPKEY_SET_REQS - do */
+static const struct nla_policy nfsd_expkey_set_reqs_nl_policy[NFSD_A_EXPKEY_REQS_REQUESTS + 1] = {
+       [NFSD_A_EXPKEY_REQS_REQUESTS] = NLA_POLICY_NESTED(nfsd_expkey_nl_policy),
+};
+
 /* Ops table for nfsd */
 static const struct genl_split_ops nfsd_nl_ops[] = {
        {
@@ -157,6 +177,20 @@ static const struct genl_split_ops nfsd_nl_ops[] = {
                .maxattr        = NFSD_A_SVC_EXPORT_REQS_REQUESTS,
                .flags          = GENL_ADMIN_PERM | GENL_CMD_CAP_DO,
        },
+       {
+               .cmd            = NFSD_CMD_EXPKEY_GET_REQS,
+               .dumpit         = nfsd_nl_expkey_get_reqs_dumpit,
+               .policy         = nfsd_expkey_get_reqs_nl_policy,
+               .maxattr        = NFSD_A_EXPKEY_REQS_REQUESTS,
+               .flags          = GENL_ADMIN_PERM | GENL_CMD_CAP_DUMP,
+       },
+       {
+               .cmd            = NFSD_CMD_EXPKEY_SET_REQS,
+               .doit           = nfsd_nl_expkey_set_reqs_doit,
+               .policy         = nfsd_expkey_set_reqs_nl_policy,
+               .maxattr        = NFSD_A_EXPKEY_REQS_REQUESTS,
+               .flags          = GENL_ADMIN_PERM | GENL_CMD_CAP_DO,
+       },
 };
 
 static const struct genl_multicast_group nfsd_nl_mcgrps[] = {
index d6ed8d9b0bb149faa4d6493ba94972addf9c26ed..f5b3387772850692b220bbbf8a66bc416b67801e 100644 (file)
@@ -14,6 +14,7 @@
 
 /* Common nested types */
 extern const struct nla_policy nfsd_auth_flavor_nl_policy[NFSD_A_AUTH_FLAVOR_FLAGS + 1];
+extern const struct nla_policy nfsd_expkey_nl_policy[NFSD_A_EXPKEY_PATH + 1];
 extern const struct nla_policy nfsd_fslocation_nl_policy[NFSD_A_FSLOCATION_PATH + 1];
 extern const struct nla_policy nfsd_fslocations_nl_policy[NFSD_A_FSLOCATIONS_LOCATION + 1];
 extern const struct nla_policy nfsd_sock_nl_policy[NFSD_A_SOCK_TRANSPORT_NAME + 1];
@@ -34,6 +35,9 @@ int nfsd_nl_svc_export_get_reqs_dumpit(struct sk_buff *skb,
                                       struct netlink_callback *cb);
 int nfsd_nl_svc_export_set_reqs_doit(struct sk_buff *skb,
                                     struct genl_info *info);
+int nfsd_nl_expkey_get_reqs_dumpit(struct sk_buff *skb,
+                                  struct netlink_callback *cb);
+int nfsd_nl_expkey_set_reqs_doit(struct sk_buff *skb, struct genl_info *info);
 
 enum {
        NFSD_NLGRP_NONE,
index 32a551b320e04c43e921ed824b3b77fca65bd9b8..fed7533c153335ad126e544e162bb206c28be6f7 100644 (file)
@@ -12,6 +12,7 @@
 
 enum nfsd_cache_type {
        NFSD_CACHE_TYPE_SVC_EXPORT = 1,
+       NFSD_CACHE_TYPE_EXPKEY = 2,
 };
 
 /*
@@ -176,6 +177,26 @@ enum {
        NFSD_A_SVC_EXPORT_REQS_MAX = (__NFSD_A_SVC_EXPORT_REQS_MAX - 1)
 };
 
+enum {
+       NFSD_A_EXPKEY_SEQNO = 1,
+       NFSD_A_EXPKEY_CLIENT,
+       NFSD_A_EXPKEY_FSIDTYPE,
+       NFSD_A_EXPKEY_FSID,
+       NFSD_A_EXPKEY_NEGATIVE,
+       NFSD_A_EXPKEY_EXPIRY,
+       NFSD_A_EXPKEY_PATH,
+
+       __NFSD_A_EXPKEY_MAX,
+       NFSD_A_EXPKEY_MAX = (__NFSD_A_EXPKEY_MAX - 1)
+};
+
+enum {
+       NFSD_A_EXPKEY_REQS_REQUESTS = 1,
+
+       __NFSD_A_EXPKEY_REQS_MAX,
+       NFSD_A_EXPKEY_REQS_MAX = (__NFSD_A_EXPKEY_REQS_MAX - 1)
+};
+
 enum {
        NFSD_CMD_RPC_STATUS_GET = 1,
        NFSD_CMD_THREADS_SET,
@@ -189,6 +210,8 @@ enum {
        NFSD_CMD_CACHE_NOTIFY,
        NFSD_CMD_SVC_EXPORT_GET_REQS,
        NFSD_CMD_SVC_EXPORT_SET_REQS,
+       NFSD_CMD_EXPKEY_GET_REQS,
+       NFSD_CMD_EXPKEY_SET_REQS,
 
        __NFSD_CMD_MAX,
        NFSD_CMD_MAX = (__NFSD_CMD_MAX - 1)