xref: /linux/Documentation/netlink/specs/sunrpc_cache.yaml (revision efe86f088f48f18c27b648e5724048947f3b7fb4)
1af81cb24SJeff Layton# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
2af81cb24SJeff Layton---
3af81cb24SJeff Laytonname: sunrpc
4af81cb24SJeff Laytonprotocol: genetlink
5af81cb24SJeff Laytonuapi-header: linux/sunrpc_netlink.h
6af81cb24SJeff Layton
7af81cb24SJeff Laytondoc: SUNRPC cache upcall support over generic netlink.
8af81cb24SJeff Layton
9af81cb24SJeff Laytondefinitions:
10af81cb24SJeff Layton  -
11af81cb24SJeff Layton    type: flags
12af81cb24SJeff Layton    name: cache-type
13af81cb24SJeff Layton    entries: [ip_map, unix_gid]
14af81cb24SJeff Layton
15af81cb24SJeff Laytonattribute-sets:
16af81cb24SJeff Layton  -
17af81cb24SJeff Layton    name: cache-notify
18af81cb24SJeff Layton    attributes:
19af81cb24SJeff Layton      -
20af81cb24SJeff Layton        name: cache-type
21af81cb24SJeff Layton        type: u32
22af81cb24SJeff Layton        enum: cache-type
23712bdbb2SJeff Layton  -
24712bdbb2SJeff Layton    name: ip-map
25712bdbb2SJeff Layton    attributes:
26712bdbb2SJeff Layton      -
27712bdbb2SJeff Layton        name: seqno
28712bdbb2SJeff Layton        type: u64
29712bdbb2SJeff Layton      -
30712bdbb2SJeff Layton        name: class
31712bdbb2SJeff Layton        type: string
32712bdbb2SJeff Layton      -
33712bdbb2SJeff Layton        name: addr
34712bdbb2SJeff Layton        type: string
35712bdbb2SJeff Layton      -
36712bdbb2SJeff Layton        name: domain
37712bdbb2SJeff Layton        type: string
38712bdbb2SJeff Layton      -
39712bdbb2SJeff Layton        name: negative
40712bdbb2SJeff Layton        type: flag
41712bdbb2SJeff Layton      -
42712bdbb2SJeff Layton        name: expiry
43712bdbb2SJeff Layton        type: u64
44712bdbb2SJeff Layton  -
45712bdbb2SJeff Layton    name: ip-map-reqs
46712bdbb2SJeff Layton    attributes:
47712bdbb2SJeff Layton      -
48712bdbb2SJeff Layton        name: requests
49712bdbb2SJeff Layton        type: nest
50712bdbb2SJeff Layton        nested-attributes: ip-map
51712bdbb2SJeff Layton        multi-attr: true
520850e860SJeff Layton  -
530850e860SJeff Layton    name: unix-gid
540850e860SJeff Layton    attributes:
550850e860SJeff Layton      -
560850e860SJeff Layton        name: seqno
570850e860SJeff Layton        type: u64
580850e860SJeff Layton      -
590850e860SJeff Layton        name: uid
600850e860SJeff Layton        type: u32
610850e860SJeff Layton      -
620850e860SJeff Layton        name: gids
630850e860SJeff Layton        type: u32
640850e860SJeff Layton        multi-attr: true
650850e860SJeff Layton      -
660850e860SJeff Layton        name: negative
670850e860SJeff Layton        type: flag
680850e860SJeff Layton      -
690850e860SJeff Layton        name: expiry
700850e860SJeff Layton        type: u64
710850e860SJeff Layton  -
720850e860SJeff Layton    name: unix-gid-reqs
730850e860SJeff Layton    attributes:
740850e860SJeff Layton      -
750850e860SJeff Layton        name: requests
760850e860SJeff Layton        type: nest
770850e860SJeff Layton        nested-attributes: unix-gid
780850e860SJeff Layton        multi-attr: true
79565ee23eSJeff Layton  -
80565ee23eSJeff Layton    name: cache-flush
81565ee23eSJeff Layton    attributes:
82565ee23eSJeff Layton      -
83565ee23eSJeff Layton        name: mask
84565ee23eSJeff Layton        type: u32
85565ee23eSJeff Layton        enum: cache-type
86565ee23eSJeff Layton        enum-as-flags: true
87af81cb24SJeff Layton
88af81cb24SJeff Laytonoperations:
89af81cb24SJeff Layton  list:
90af81cb24SJeff Layton    -
91af81cb24SJeff Layton      name: cache-notify
92af81cb24SJeff Layton      doc: Notification that there are cache requests that need servicing
93af81cb24SJeff Layton      attribute-set: cache-notify
94af81cb24SJeff Layton      mcgrp: exportd
95af81cb24SJeff Layton      event:
96af81cb24SJeff Layton        attributes:
97af81cb24SJeff Layton          - cache-type
98712bdbb2SJeff Layton    -
99712bdbb2SJeff Layton      name: ip-map-get-reqs
100712bdbb2SJeff Layton      doc: Dump all pending ip_map requests
101712bdbb2SJeff Layton      attribute-set: ip-map-reqs
102712bdbb2SJeff Layton      flags: [admin-perm]
103712bdbb2SJeff Layton      dump:
104*80ec8054SChuck Lever          reply:
105712bdbb2SJeff Layton            attributes:
106712bdbb2SJeff Layton              - requests
107712bdbb2SJeff Layton    -
108712bdbb2SJeff Layton      name: ip-map-set-reqs
109712bdbb2SJeff Layton      doc: Respond to one or more ip_map requests
110712bdbb2SJeff Layton      attribute-set: ip-map-reqs
111712bdbb2SJeff Layton      flags: [admin-perm]
112712bdbb2SJeff Layton      do:
113712bdbb2SJeff Layton          request:
114712bdbb2SJeff Layton            attributes:
115712bdbb2SJeff Layton              - requests
1160850e860SJeff Layton    -
1170850e860SJeff Layton      name: unix-gid-get-reqs
1180850e860SJeff Layton      doc: Dump all pending unix_gid requests
1190850e860SJeff Layton      attribute-set: unix-gid-reqs
1200850e860SJeff Layton      flags: [admin-perm]
1210850e860SJeff Layton      dump:
122*80ec8054SChuck Lever          reply:
1230850e860SJeff Layton            attributes:
1240850e860SJeff Layton              - requests
1250850e860SJeff Layton    -
1260850e860SJeff Layton      name: unix-gid-set-reqs
1270850e860SJeff Layton      doc: Respond to one or more unix_gid requests
1280850e860SJeff Layton      attribute-set: unix-gid-reqs
1290850e860SJeff Layton      flags: [admin-perm]
1300850e860SJeff Layton      do:
1310850e860SJeff Layton          request:
1320850e860SJeff Layton            attributes:
1330850e860SJeff Layton              - requests
134565ee23eSJeff Layton    -
135565ee23eSJeff Layton      name: cache-flush
136565ee23eSJeff Layton      doc: Flush sunrpc caches (ip_map and/or unix_gid)
137565ee23eSJeff Layton      attribute-set: cache-flush
138565ee23eSJeff Layton      flags: [admin-perm]
139565ee23eSJeff Layton      do:
140565ee23eSJeff Layton        request:
141565ee23eSJeff Layton          attributes:
142565ee23eSJeff Layton            - mask
143af81cb24SJeff Layton
144af81cb24SJeff Laytonmcast-groups:
145af81cb24SJeff Layton  list:
146af81cb24SJeff Layton    -
147af81cb24SJeff Layton      name: none
148af81cb24SJeff Layton    -
149af81cb24SJeff Layton      name: exportd
150