Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * ceph_fs.h - Ceph constants and data types to share between kernel and
4 * user space.
5 *
6 * Most types in this file are defined as little-endian, and are
7 * primarily intended to describe data structures that pass over the
8 * wire or that are stored on disk.
9 *
10 * LGPL2
11 */
12
13#ifndef CEPH_FS_H
14#define CEPH_FS_H
15
16#include <linux/ceph/msgr.h>
17#include <linux/ceph/rados.h>
18
19/*
20 * subprotocol versions. when specific messages types or high-level
21 * protocols change, bump the affected components. we keep rev
22 * internal cluster protocols separately from the public,
23 * client-facing protocol.
24 */
25#define CEPH_OSDC_PROTOCOL 24 /* server/client */
26#define CEPH_MDSC_PROTOCOL 32 /* server/client */
27#define CEPH_MONC_PROTOCOL 15 /* server/client */
28
29
30#define CEPH_INO_ROOT 1
31#define CEPH_INO_CEPH 2 /* hidden .ceph dir */
32#define CEPH_INO_DOTDOT 3 /* used by ceph fuse for parent (..) */
33
34/* arbitrary limit on max # of monitors (cluster of 3 is typical) */
35#define CEPH_MAX_MON 31
36
37/*
38 * legacy ceph_file_layoute
39 */
40struct ceph_file_layout_legacy {
41 /* file -> object mapping */
42 __le32 fl_stripe_unit; /* stripe unit, in bytes. must be multiple
43 of page size. */
44 __le32 fl_stripe_count; /* over this many objects */
45 __le32 fl_object_size; /* until objects are this big, then move to
46 new objects */
47 __le32 fl_cas_hash; /* UNUSED. 0 = none; 1 = sha256 */
48
49 /* pg -> disk layout */
50 __le32 fl_object_stripe_unit; /* UNUSED. for per-object parity, if any */
51
52 /* object -> pg layout */
53 __le32 fl_unused; /* unused; used to be preferred primary for pg (-1 for none) */
54 __le32 fl_pg_pool; /* namespace, crush ruleset, rep level */
55} __attribute__ ((packed));
56
57struct ceph_string;
58/*
59 * ceph_file_layout - describe data layout for a file/inode
60 */
61struct ceph_file_layout {
62 /* file -> object mapping */
63 u32 stripe_unit; /* stripe unit, in bytes */
64 u32 stripe_count; /* over this many objects */
65 u32 object_size; /* until objects are this big */
66 s64 pool_id; /* rados pool id */
67 struct ceph_string __rcu *pool_ns; /* rados pool namespace */
68};
69
70extern int ceph_file_layout_is_valid(const struct ceph_file_layout *layout);
71extern void ceph_file_layout_from_legacy(struct ceph_file_layout *fl,
72 struct ceph_file_layout_legacy *legacy);
73extern void ceph_file_layout_to_legacy(struct ceph_file_layout *fl,
74 struct ceph_file_layout_legacy *legacy);
75
76#define CEPH_MIN_STRIPE_UNIT 65536
77
78struct ceph_dir_layout {
79 __u8 dl_dir_hash; /* see ceph_hash.h for ids */
80 __u8 dl_unused1;
81 __u16 dl_unused2;
82 __u32 dl_unused3;
83} __attribute__ ((packed));
84
85/* crypto algorithms */
86#define CEPH_CRYPTO_NONE 0x0
87#define CEPH_CRYPTO_AES 0x1
88
89#define CEPH_AES_IV "cephsageyudagreg"
90
91/* security/authentication protocols */
92#define CEPH_AUTH_UNKNOWN 0x0
93#define CEPH_AUTH_NONE 0x1
94#define CEPH_AUTH_CEPHX 0x2
95
96#define CEPH_AUTH_UID_DEFAULT ((__u64) -1)
97
98
99/*********************************************
100 * message layer
101 */
102
103/*
104 * message types
105 */
106
107/* misc */
108#define CEPH_MSG_SHUTDOWN 1
109#define CEPH_MSG_PING 2
110
111/* client <-> monitor */
112#define CEPH_MSG_MON_MAP 4
113#define CEPH_MSG_MON_GET_MAP 5
114#define CEPH_MSG_STATFS 13
115#define CEPH_MSG_STATFS_REPLY 14
116#define CEPH_MSG_MON_SUBSCRIBE 15
117#define CEPH_MSG_MON_SUBSCRIBE_ACK 16
118#define CEPH_MSG_AUTH 17
119#define CEPH_MSG_AUTH_REPLY 18
120#define CEPH_MSG_MON_GET_VERSION 19
121#define CEPH_MSG_MON_GET_VERSION_REPLY 20
122
123/* client <-> mds */
124#define CEPH_MSG_MDS_MAP 21
125#define CEPH_MSG_FS_MAP_USER 103
126
127#define CEPH_MSG_CLIENT_SESSION 22
128#define CEPH_MSG_CLIENT_RECONNECT 23
129
130#define CEPH_MSG_CLIENT_REQUEST 24
131#define CEPH_MSG_CLIENT_REQUEST_FORWARD 25
132#define CEPH_MSG_CLIENT_REPLY 26
133#define CEPH_MSG_CLIENT_CAPS 0x310
134#define CEPH_MSG_CLIENT_LEASE 0x311
135#define CEPH_MSG_CLIENT_SNAP 0x312
136#define CEPH_MSG_CLIENT_CAPRELEASE 0x313
137#define CEPH_MSG_CLIENT_QUOTA 0x314
138
139/* pool ops */
140#define CEPH_MSG_POOLOP_REPLY 48
141#define CEPH_MSG_POOLOP 49
142
143/* mon commands */
144#define CEPH_MSG_MON_COMMAND 50
145#define CEPH_MSG_MON_COMMAND_ACK 51
146
147/* osd */
148#define CEPH_MSG_OSD_MAP 41
149#define CEPH_MSG_OSD_OP 42
150#define CEPH_MSG_OSD_OPREPLY 43
151#define CEPH_MSG_WATCH_NOTIFY 44
152#define CEPH_MSG_OSD_BACKOFF 61
153
154
155/* watch-notify operations */
156enum {
157 CEPH_WATCH_EVENT_NOTIFY = 1, /* notifying watcher */
158 CEPH_WATCH_EVENT_NOTIFY_COMPLETE = 2, /* notifier notified when done */
159 CEPH_WATCH_EVENT_DISCONNECT = 3, /* we were disconnected */
160};
161
162
163struct ceph_mon_request_header {
164 __le64 have_version;
165 __le16 session_mon;
166 __le64 session_mon_tid;
167} __attribute__ ((packed));
168
169struct ceph_mon_statfs {
170 struct ceph_mon_request_header monhdr;
171 struct ceph_fsid fsid;
172 __u8 contains_data_pool;
173 __le64 data_pool;
174} __attribute__ ((packed));
175
176struct ceph_statfs {
177 __le64 kb, kb_used, kb_avail;
178 __le64 num_objects;
179} __attribute__ ((packed));
180
181struct ceph_mon_statfs_reply {
182 struct ceph_fsid fsid;
183 __le64 version;
184 struct ceph_statfs st;
185} __attribute__ ((packed));
186
187struct ceph_mon_command {
188 struct ceph_mon_request_header monhdr;
189 struct ceph_fsid fsid;
190 __le32 num_strs; /* always 1 */
191 __le32 str_len;
192 char str[];
193} __attribute__ ((packed));
194
195struct ceph_osd_getmap {
196 struct ceph_mon_request_header monhdr;
197 struct ceph_fsid fsid;
198 __le32 start;
199} __attribute__ ((packed));
200
201struct ceph_mds_getmap {
202 struct ceph_mon_request_header monhdr;
203 struct ceph_fsid fsid;
204} __attribute__ ((packed));
205
206struct ceph_client_mount {
207 struct ceph_mon_request_header monhdr;
208} __attribute__ ((packed));
209
210#define CEPH_SUBSCRIBE_ONETIME 1 /* i want only 1 update after have */
211
212struct ceph_mon_subscribe_item {
213 __le64 start;
214 __u8 flags;
215} __attribute__ ((packed));
216
217struct ceph_mon_subscribe_ack {
218 __le32 duration; /* seconds */
219 struct ceph_fsid fsid;
220} __attribute__ ((packed));
221
222#define CEPH_FS_CLUSTER_ID_NONE -1
223
224/*
225 * mdsmap flags
226 */
227#define CEPH_MDSMAP_DOWN (1<<0) /* cluster deliberately down */
228
229/*
230 * mds states
231 * > 0 -> in
232 * <= 0 -> out
233 */
234#define CEPH_MDS_STATE_DNE 0 /* down, does not exist. */
235#define CEPH_MDS_STATE_STOPPED -1 /* down, once existed, but no subtrees.
236 empty log. */
237#define CEPH_MDS_STATE_BOOT -4 /* up, boot announcement. */
238#define CEPH_MDS_STATE_STANDBY -5 /* up, idle. waiting for assignment. */
239#define CEPH_MDS_STATE_CREATING -6 /* up, creating MDS instance. */
240#define CEPH_MDS_STATE_STARTING -7 /* up, starting previously stopped mds */
241#define CEPH_MDS_STATE_STANDBY_REPLAY -8 /* up, tailing active node's journal */
242#define CEPH_MDS_STATE_REPLAYONCE -9 /* up, replaying an active node's journal */
243
244#define CEPH_MDS_STATE_REPLAY 8 /* up, replaying journal. */
245#define CEPH_MDS_STATE_RESOLVE 9 /* up, disambiguating distributed
246 operations (import, rename, etc.) */
247#define CEPH_MDS_STATE_RECONNECT 10 /* up, reconnect to clients */
248#define CEPH_MDS_STATE_REJOIN 11 /* up, rejoining distributed cache */
249#define CEPH_MDS_STATE_CLIENTREPLAY 12 /* up, replaying client operations */
250#define CEPH_MDS_STATE_ACTIVE 13 /* up, active */
251#define CEPH_MDS_STATE_STOPPING 14 /* up, but exporting metadata */
252
253extern const char *ceph_mds_state_name(int s);
254
255
256/*
257 * metadata lock types.
258 * - these are bitmasks.. we can compose them
259 * - they also define the lock ordering by the MDS
260 * - a few of these are internal to the mds
261 */
262#define CEPH_LOCK_DVERSION 1
263#define CEPH_LOCK_DN 2
264#define CEPH_LOCK_ISNAP 16
265#define CEPH_LOCK_IVERSION 32 /* mds internal */
266#define CEPH_LOCK_IFILE 64
267#define CEPH_LOCK_IAUTH 128
268#define CEPH_LOCK_ILINK 256
269#define CEPH_LOCK_IDFT 512 /* dir frag tree */
270#define CEPH_LOCK_INEST 1024 /* mds internal */
271#define CEPH_LOCK_IXATTR 2048
272#define CEPH_LOCK_IFLOCK 4096 /* advisory file locks */
273#define CEPH_LOCK_INO 8192 /* immutable inode bits; not a lock */
274#define CEPH_LOCK_IPOLICY 16384 /* policy lock on dirs. MDS internal */
275
276/* client_session ops */
277enum {
278 CEPH_SESSION_REQUEST_OPEN,
279 CEPH_SESSION_OPEN,
280 CEPH_SESSION_REQUEST_CLOSE,
281 CEPH_SESSION_CLOSE,
282 CEPH_SESSION_REQUEST_RENEWCAPS,
283 CEPH_SESSION_RENEWCAPS,
284 CEPH_SESSION_STALE,
285 CEPH_SESSION_RECALL_STATE,
286 CEPH_SESSION_FLUSHMSG,
287 CEPH_SESSION_FLUSHMSG_ACK,
288 CEPH_SESSION_FORCE_RO,
289 CEPH_SESSION_REJECT,
290};
291
292extern const char *ceph_session_op_name(int op);
293
294struct ceph_mds_session_head {
295 __le32 op;
296 __le64 seq;
297 struct ceph_timespec stamp;
298 __le32 max_caps, max_leases;
299} __attribute__ ((packed));
300
301/* client_request */
302/*
303 * metadata ops.
304 * & 0x001000 -> write op
305 * & 0x010000 -> follow symlink (e.g. stat(), not lstat()).
306 & & 0x100000 -> use weird ino/path trace
307 */
308#define CEPH_MDS_OP_WRITE 0x001000
309enum {
310 CEPH_MDS_OP_LOOKUP = 0x00100,
311 CEPH_MDS_OP_GETATTR = 0x00101,
312 CEPH_MDS_OP_LOOKUPHASH = 0x00102,
313 CEPH_MDS_OP_LOOKUPPARENT = 0x00103,
314 CEPH_MDS_OP_LOOKUPINO = 0x00104,
315 CEPH_MDS_OP_LOOKUPNAME = 0x00105,
316
317 CEPH_MDS_OP_SETXATTR = 0x01105,
318 CEPH_MDS_OP_RMXATTR = 0x01106,
319 CEPH_MDS_OP_SETLAYOUT = 0x01107,
320 CEPH_MDS_OP_SETATTR = 0x01108,
321 CEPH_MDS_OP_SETFILELOCK= 0x01109,
322 CEPH_MDS_OP_GETFILELOCK= 0x00110,
323 CEPH_MDS_OP_SETDIRLAYOUT=0x0110a,
324
325 CEPH_MDS_OP_MKNOD = 0x01201,
326 CEPH_MDS_OP_LINK = 0x01202,
327 CEPH_MDS_OP_UNLINK = 0x01203,
328 CEPH_MDS_OP_RENAME = 0x01204,
329 CEPH_MDS_OP_MKDIR = 0x01220,
330 CEPH_MDS_OP_RMDIR = 0x01221,
331 CEPH_MDS_OP_SYMLINK = 0x01222,
332
333 CEPH_MDS_OP_CREATE = 0x01301,
334 CEPH_MDS_OP_OPEN = 0x00302,
335 CEPH_MDS_OP_READDIR = 0x00305,
336
337 CEPH_MDS_OP_LOOKUPSNAP = 0x00400,
338 CEPH_MDS_OP_MKSNAP = 0x01400,
339 CEPH_MDS_OP_RMSNAP = 0x01401,
340 CEPH_MDS_OP_LSSNAP = 0x00402,
341 CEPH_MDS_OP_RENAMESNAP = 0x01403,
342};
343
344extern const char *ceph_mds_op_name(int op);
345
346
347#define CEPH_SETATTR_MODE 1
348#define CEPH_SETATTR_UID 2
349#define CEPH_SETATTR_GID 4
350#define CEPH_SETATTR_MTIME 8
351#define CEPH_SETATTR_ATIME 16
352#define CEPH_SETATTR_SIZE 32
353#define CEPH_SETATTR_CTIME 64
354
355/*
356 * Ceph setxattr request flags.
357 */
358#define CEPH_XATTR_CREATE (1 << 0)
359#define CEPH_XATTR_REPLACE (1 << 1)
360#define CEPH_XATTR_REMOVE (1 << 31)
361
362/*
363 * readdir request flags;
364 */
365#define CEPH_READDIR_REPLY_BITFLAGS (1<<0)
366
367/*
368 * readdir reply flags.
369 */
370#define CEPH_READDIR_FRAG_END (1<<0)
371#define CEPH_READDIR_FRAG_COMPLETE (1<<8)
372#define CEPH_READDIR_HASH_ORDER (1<<9)
373#define CEPH_READDIR_OFFSET_HASH (1<<10)
374
375/*
376 * open request flags
377 */
378#define CEPH_O_RDONLY 00000000
379#define CEPH_O_WRONLY 00000001
380#define CEPH_O_RDWR 00000002
381#define CEPH_O_CREAT 00000100
382#define CEPH_O_EXCL 00000200
383#define CEPH_O_TRUNC 00001000
384#define CEPH_O_DIRECTORY 00200000
385#define CEPH_O_NOFOLLOW 00400000
386
387union ceph_mds_request_args {
388 struct {
389 __le32 mask; /* CEPH_CAP_* */
390 } __attribute__ ((packed)) getattr;
391 struct {
392 __le32 mode;
393 __le32 uid;
394 __le32 gid;
395 struct ceph_timespec mtime;
396 struct ceph_timespec atime;
397 __le64 size, old_size; /* old_size needed by truncate */
398 __le32 mask; /* CEPH_SETATTR_* */
399 } __attribute__ ((packed)) setattr;
400 struct {
401 __le32 frag; /* which dir fragment */
402 __le32 max_entries; /* how many dentries to grab */
403 __le32 max_bytes;
404 __le16 flags;
405 __le32 offset_hash;
406 } __attribute__ ((packed)) readdir;
407 struct {
408 __le32 mode;
409 __le32 rdev;
410 } __attribute__ ((packed)) mknod;
411 struct {
412 __le32 mode;
413 } __attribute__ ((packed)) mkdir;
414 struct {
415 __le32 flags;
416 __le32 mode;
417 __le32 stripe_unit; /* layout for newly created file */
418 __le32 stripe_count; /* ... */
419 __le32 object_size;
420 __le32 file_replication;
421 __le32 mask; /* CEPH_CAP_* */
422 __le32 old_size;
423 } __attribute__ ((packed)) open;
424 struct {
425 __le32 flags;
426 } __attribute__ ((packed)) setxattr;
427 struct {
428 struct ceph_file_layout_legacy layout;
429 } __attribute__ ((packed)) setlayout;
430 struct {
431 __u8 rule; /* currently fcntl or flock */
432 __u8 type; /* shared, exclusive, remove*/
433 __le64 owner; /* owner of the lock */
434 __le64 pid; /* process id requesting the lock */
435 __le64 start; /* initial location to lock */
436 __le64 length; /* num bytes to lock from start */
437 __u8 wait; /* will caller wait for lock to become available? */
438 } __attribute__ ((packed)) filelock_change;
439 struct {
440 __le32 mask; /* CEPH_CAP_* */
441 __le64 snapid;
442 __le64 parent;
443 __le32 hash;
444 } __attribute__ ((packed)) lookupino;
445} __attribute__ ((packed));
446
447#define CEPH_MDS_FLAG_REPLAY 1 /* this is a replayed op */
448#define CEPH_MDS_FLAG_WANT_DENTRY 2 /* want dentry in reply */
449#define CEPH_MDS_FLAG_ASYNC 4 /* request is asynchronous */
450
451struct ceph_mds_request_head {
452 __le64 oldest_client_tid;
453 __le32 mdsmap_epoch; /* on client */
454 __le32 flags; /* CEPH_MDS_FLAG_* */
455 __u8 num_retry, num_fwd; /* count retry, fwd attempts */
456 __le16 num_releases; /* # include cap/lease release records */
457 __le32 op; /* mds op code */
458 __le32 caller_uid, caller_gid;
459 __le64 ino; /* use this ino for openc, mkdir, mknod,
460 etc. (if replaying) */
461 union ceph_mds_request_args args;
462} __attribute__ ((packed));
463
464/* cap/lease release record */
465struct ceph_mds_request_release {
466 __le64 ino, cap_id; /* ino and unique cap id */
467 __le32 caps, wanted; /* new issued, wanted */
468 __le32 seq, issue_seq, mseq;
469 __le32 dname_seq; /* if releasing a dentry lease, a */
470 __le32 dname_len; /* string follows. */
471} __attribute__ ((packed));
472
473/* client reply */
474struct ceph_mds_reply_head {
475 __le32 op;
476 __le32 result;
477 __le32 mdsmap_epoch;
478 __u8 safe; /* true if committed to disk */
479 __u8 is_dentry, is_target; /* true if dentry, target inode records
480 are included with reply */
481} __attribute__ ((packed));
482
483/* one for each node split */
484struct ceph_frag_tree_split {
485 __le32 frag; /* this frag splits... */
486 __le32 by; /* ...by this many bits */
487} __attribute__ ((packed));
488
489struct ceph_frag_tree_head {
490 __le32 nsplits; /* num ceph_frag_tree_split records */
491 struct ceph_frag_tree_split splits[];
492} __attribute__ ((packed));
493
494/* capability issue, for bundling with mds reply */
495struct ceph_mds_reply_cap {
496 __le32 caps, wanted; /* caps issued, wanted */
497 __le64 cap_id;
498 __le32 seq, mseq;
499 __le64 realm; /* snap realm */
500 __u8 flags; /* CEPH_CAP_FLAG_* */
501} __attribute__ ((packed));
502
503#define CEPH_CAP_FLAG_AUTH (1 << 0) /* cap is issued by auth mds */
504#define CEPH_CAP_FLAG_RELEASE (1 << 1) /* release the cap */
505
506/* inode record, for bundling with mds reply */
507struct ceph_mds_reply_inode {
508 __le64 ino;
509 __le64 snapid;
510 __le32 rdev;
511 __le64 version; /* inode version */
512 __le64 xattr_version; /* version for xattr blob */
513 struct ceph_mds_reply_cap cap; /* caps issued for this inode */
514 struct ceph_file_layout_legacy layout;
515 struct ceph_timespec ctime, mtime, atime;
516 __le32 time_warp_seq;
517 __le64 size, max_size, truncate_size;
518 __le32 truncate_seq;
519 __le32 mode, uid, gid;
520 __le32 nlink;
521 __le64 files, subdirs, rbytes, rfiles, rsubdirs; /* dir stats */
522 struct ceph_timespec rctime;
523 struct ceph_frag_tree_head fragtree; /* (must be at end of struct) */
524} __attribute__ ((packed));
525/* followed by frag array, symlink string, dir layout, xattr blob */
526
527/* reply_lease follows dname, and reply_inode */
528struct ceph_mds_reply_lease {
529 __le16 mask; /* lease type(s) */
530 __le32 duration_ms; /* lease duration */
531 __le32 seq;
532} __attribute__ ((packed));
533
534#define CEPH_LEASE_VALID (1 | 2) /* old and new bit values */
535#define CEPH_LEASE_PRIMARY_LINK 4 /* primary linkage */
536
537struct ceph_mds_reply_dirfrag {
538 __le32 frag; /* fragment */
539 __le32 auth; /* auth mds, if this is a delegation point */
540 __le32 ndist; /* number of mds' this is replicated on */
541 __le32 dist[];
542} __attribute__ ((packed));
543
544#define CEPH_LOCK_FCNTL 1
545#define CEPH_LOCK_FLOCK 2
546#define CEPH_LOCK_FCNTL_INTR 3
547#define CEPH_LOCK_FLOCK_INTR 4
548
549
550#define CEPH_LOCK_SHARED 1
551#define CEPH_LOCK_EXCL 2
552#define CEPH_LOCK_UNLOCK 4
553
554struct ceph_filelock {
555 __le64 start;/* file offset to start lock at */
556 __le64 length; /* num bytes to lock; 0 for all following start */
557 __le64 client; /* which client holds the lock */
558 __le64 owner; /* owner the lock */
559 __le64 pid; /* process id holding the lock on the client */
560 __u8 type; /* shared lock, exclusive lock, or unlock */
561} __attribute__ ((packed));
562
563
564/* file access modes */
565#define CEPH_FILE_MODE_PIN 0
566#define CEPH_FILE_MODE_RD 1
567#define CEPH_FILE_MODE_WR 2
568#define CEPH_FILE_MODE_RDWR 3 /* RD | WR */
569#define CEPH_FILE_MODE_LAZY 4 /* lazy io */
570#define CEPH_FILE_MODE_BITS 4
571#define CEPH_FILE_MODE_MASK ((1 << CEPH_FILE_MODE_BITS) - 1)
572
573int ceph_flags_to_mode(int flags);
574
575#define CEPH_INLINE_NONE ((__u64)-1)
576
577/* capability bits */
578#define CEPH_CAP_PIN 1 /* no specific capabilities beyond the pin */
579
580/* generic cap bits */
581#define CEPH_CAP_GSHARED 1 /* client can reads */
582#define CEPH_CAP_GEXCL 2 /* client can read and update */
583#define CEPH_CAP_GCACHE 4 /* (file) client can cache reads */
584#define CEPH_CAP_GRD 8 /* (file) client can read */
585#define CEPH_CAP_GWR 16 /* (file) client can write */
586#define CEPH_CAP_GBUFFER 32 /* (file) client can buffer writes */
587#define CEPH_CAP_GWREXTEND 64 /* (file) client can extend EOF */
588#define CEPH_CAP_GLAZYIO 128 /* (file) client can perform lazy io */
589
590#define CEPH_CAP_SIMPLE_BITS 2
591#define CEPH_CAP_FILE_BITS 8
592
593/* per-lock shift */
594#define CEPH_CAP_SAUTH 2
595#define CEPH_CAP_SLINK 4
596#define CEPH_CAP_SXATTR 6
597#define CEPH_CAP_SFILE 8
598#define CEPH_CAP_SFLOCK 20
599
600#define CEPH_CAP_BITS 22
601
602/* composed values */
603#define CEPH_CAP_AUTH_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SAUTH)
604#define CEPH_CAP_AUTH_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SAUTH)
605#define CEPH_CAP_LINK_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SLINK)
606#define CEPH_CAP_LINK_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SLINK)
607#define CEPH_CAP_XATTR_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SXATTR)
608#define CEPH_CAP_XATTR_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SXATTR)
609#define CEPH_CAP_FILE(x) (x << CEPH_CAP_SFILE)
610#define CEPH_CAP_FILE_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SFILE)
611#define CEPH_CAP_FILE_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SFILE)
612#define CEPH_CAP_FILE_CACHE (CEPH_CAP_GCACHE << CEPH_CAP_SFILE)
613#define CEPH_CAP_FILE_RD (CEPH_CAP_GRD << CEPH_CAP_SFILE)
614#define CEPH_CAP_FILE_WR (CEPH_CAP_GWR << CEPH_CAP_SFILE)
615#define CEPH_CAP_FILE_BUFFER (CEPH_CAP_GBUFFER << CEPH_CAP_SFILE)
616#define CEPH_CAP_FILE_WREXTEND (CEPH_CAP_GWREXTEND << CEPH_CAP_SFILE)
617#define CEPH_CAP_FILE_LAZYIO (CEPH_CAP_GLAZYIO << CEPH_CAP_SFILE)
618#define CEPH_CAP_FLOCK_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SFLOCK)
619#define CEPH_CAP_FLOCK_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SFLOCK)
620
621
622/* cap masks (for getattr) */
623#define CEPH_STAT_CAP_INODE CEPH_CAP_PIN
624#define CEPH_STAT_CAP_TYPE CEPH_CAP_PIN /* mode >> 12 */
625#define CEPH_STAT_CAP_SYMLINK CEPH_CAP_PIN
626#define CEPH_STAT_CAP_UID CEPH_CAP_AUTH_SHARED
627#define CEPH_STAT_CAP_GID CEPH_CAP_AUTH_SHARED
628#define CEPH_STAT_CAP_MODE CEPH_CAP_AUTH_SHARED
629#define CEPH_STAT_CAP_NLINK CEPH_CAP_LINK_SHARED
630#define CEPH_STAT_CAP_LAYOUT CEPH_CAP_FILE_SHARED
631#define CEPH_STAT_CAP_MTIME CEPH_CAP_FILE_SHARED
632#define CEPH_STAT_CAP_SIZE CEPH_CAP_FILE_SHARED
633#define CEPH_STAT_CAP_ATIME CEPH_CAP_FILE_SHARED /* fixme */
634#define CEPH_STAT_CAP_XATTR CEPH_CAP_XATTR_SHARED
635#define CEPH_STAT_CAP_INODE_ALL (CEPH_CAP_PIN | \
636 CEPH_CAP_AUTH_SHARED | \
637 CEPH_CAP_LINK_SHARED | \
638 CEPH_CAP_FILE_SHARED | \
639 CEPH_CAP_XATTR_SHARED)
640#define CEPH_STAT_CAP_INLINE_DATA (CEPH_CAP_FILE_SHARED | \
641 CEPH_CAP_FILE_RD)
642#define CEPH_STAT_RSTAT CEPH_CAP_FILE_WREXTEND
643
644#define CEPH_CAP_ANY_SHARED (CEPH_CAP_AUTH_SHARED | \
645 CEPH_CAP_LINK_SHARED | \
646 CEPH_CAP_XATTR_SHARED | \
647 CEPH_CAP_FILE_SHARED)
648#define CEPH_CAP_ANY_RD (CEPH_CAP_ANY_SHARED | CEPH_CAP_FILE_RD | \
649 CEPH_CAP_FILE_CACHE)
650
651#define CEPH_CAP_ANY_EXCL (CEPH_CAP_AUTH_EXCL | \
652 CEPH_CAP_LINK_EXCL | \
653 CEPH_CAP_XATTR_EXCL | \
654 CEPH_CAP_FILE_EXCL)
655#define CEPH_CAP_ANY_FILE_RD (CEPH_CAP_FILE_RD | CEPH_CAP_FILE_CACHE | \
656 CEPH_CAP_FILE_SHARED)
657#define CEPH_CAP_ANY_FILE_WR (CEPH_CAP_FILE_WR | CEPH_CAP_FILE_BUFFER | \
658 CEPH_CAP_FILE_EXCL)
659#define CEPH_CAP_ANY_WR (CEPH_CAP_ANY_EXCL | CEPH_CAP_ANY_FILE_WR)
660#define CEPH_CAP_ANY (CEPH_CAP_ANY_RD | CEPH_CAP_ANY_EXCL | \
661 CEPH_CAP_ANY_FILE_WR | CEPH_CAP_FILE_LAZYIO | \
662 CEPH_CAP_PIN)
663#define CEPH_CAP_ALL_FILE (CEPH_CAP_PIN | CEPH_CAP_ANY_SHARED | \
664 CEPH_CAP_AUTH_EXCL | CEPH_CAP_XATTR_EXCL | \
665 CEPH_CAP_ANY_FILE_RD | CEPH_CAP_ANY_FILE_WR)
666
667#define CEPH_CAP_LOCKS (CEPH_LOCK_IFILE | CEPH_LOCK_IAUTH | CEPH_LOCK_ILINK | \
668 CEPH_LOCK_IXATTR)
669
670/* cap masks async dir operations */
671#define CEPH_CAP_DIR_CREATE CEPH_CAP_FILE_CACHE
672#define CEPH_CAP_DIR_UNLINK CEPH_CAP_FILE_RD
673#define CEPH_CAP_ANY_DIR_OPS (CEPH_CAP_FILE_CACHE | CEPH_CAP_FILE_RD | \
674 CEPH_CAP_FILE_WREXTEND | CEPH_CAP_FILE_LAZYIO)
675
676int ceph_caps_for_mode(int mode);
677
678enum {
679 CEPH_CAP_OP_GRANT, /* mds->client grant */
680 CEPH_CAP_OP_REVOKE, /* mds->client revoke */
681 CEPH_CAP_OP_TRUNC, /* mds->client trunc notify */
682 CEPH_CAP_OP_EXPORT, /* mds has exported the cap */
683 CEPH_CAP_OP_IMPORT, /* mds has imported the cap */
684 CEPH_CAP_OP_UPDATE, /* client->mds update */
685 CEPH_CAP_OP_DROP, /* client->mds drop cap bits */
686 CEPH_CAP_OP_FLUSH, /* client->mds cap writeback */
687 CEPH_CAP_OP_FLUSH_ACK, /* mds->client flushed */
688 CEPH_CAP_OP_FLUSHSNAP, /* client->mds flush snapped metadata */
689 CEPH_CAP_OP_FLUSHSNAP_ACK, /* mds->client flushed snapped metadata */
690 CEPH_CAP_OP_RELEASE, /* client->mds release (clean) cap */
691 CEPH_CAP_OP_RENEW, /* client->mds renewal request */
692};
693
694extern const char *ceph_cap_op_name(int op);
695
696/* flags field in client cap messages (version >= 10) */
697#define CEPH_CLIENT_CAPS_SYNC (1<<0)
698#define CEPH_CLIENT_CAPS_NO_CAPSNAP (1<<1)
699#define CEPH_CLIENT_CAPS_PENDING_CAPSNAP (1<<2)
700
701/*
702 * caps message, used for capability callbacks, acks, requests, etc.
703 */
704struct ceph_mds_caps {
705 __le32 op; /* CEPH_CAP_OP_* */
706 __le64 ino, realm;
707 __le64 cap_id;
708 __le32 seq, issue_seq;
709 __le32 caps, wanted, dirty; /* latest issued/wanted/dirty */
710 __le32 migrate_seq;
711 __le64 snap_follows;
712 __le32 snap_trace_len;
713
714 /* authlock */
715 __le32 uid, gid, mode;
716
717 /* linklock */
718 __le32 nlink;
719
720 /* xattrlock */
721 __le32 xattr_len;
722 __le64 xattr_version;
723
724 /* filelock */
725 __le64 size, max_size, truncate_size;
726 __le32 truncate_seq;
727 struct ceph_timespec mtime, atime, ctime;
728 struct ceph_file_layout_legacy layout;
729 __le32 time_warp_seq;
730} __attribute__ ((packed));
731
732struct ceph_mds_cap_peer {
733 __le64 cap_id;
734 __le32 seq;
735 __le32 mseq;
736 __le32 mds;
737 __u8 flags;
738} __attribute__ ((packed));
739
740/* cap release msg head */
741struct ceph_mds_cap_release {
742 __le32 num; /* number of cap_items that follow */
743} __attribute__ ((packed));
744
745struct ceph_mds_cap_item {
746 __le64 ino;
747 __le64 cap_id;
748 __le32 migrate_seq, seq;
749} __attribute__ ((packed));
750
751#define CEPH_MDS_LEASE_REVOKE 1 /* mds -> client */
752#define CEPH_MDS_LEASE_RELEASE 2 /* client -> mds */
753#define CEPH_MDS_LEASE_RENEW 3 /* client <-> mds */
754#define CEPH_MDS_LEASE_REVOKE_ACK 4 /* client -> mds */
755
756extern const char *ceph_lease_op_name(int o);
757
758/* lease msg header */
759struct ceph_mds_lease {
760 __u8 action; /* CEPH_MDS_LEASE_* */
761 __le16 mask; /* which lease */
762 __le64 ino;
763 __le64 first, last; /* snap range */
764 __le32 seq;
765 __le32 duration_ms; /* duration of renewal */
766} __attribute__ ((packed));
767/* followed by a __le32+string for dname */
768
769/* client reconnect */
770struct ceph_mds_cap_reconnect {
771 __le64 cap_id;
772 __le32 wanted;
773 __le32 issued;
774 __le64 snaprealm;
775 __le64 pathbase; /* base ino for our path to this ino */
776 __le32 flock_len; /* size of flock state blob, if any */
777} __attribute__ ((packed));
778/* followed by flock blob */
779
780struct ceph_mds_cap_reconnect_v1 {
781 __le64 cap_id;
782 __le32 wanted;
783 __le32 issued;
784 __le64 size;
785 struct ceph_timespec mtime, atime;
786 __le64 snaprealm;
787 __le64 pathbase; /* base ino for our path to this ino */
788} __attribute__ ((packed));
789
790struct ceph_mds_snaprealm_reconnect {
791 __le64 ino; /* snap realm base */
792 __le64 seq; /* snap seq for this snap realm */
793 __le64 parent; /* parent realm */
794} __attribute__ ((packed));
795
796/*
797 * snaps
798 */
799enum {
800 CEPH_SNAP_OP_UPDATE, /* CREATE or DESTROY */
801 CEPH_SNAP_OP_CREATE,
802 CEPH_SNAP_OP_DESTROY,
803 CEPH_SNAP_OP_SPLIT,
804};
805
806extern const char *ceph_snap_op_name(int o);
807
808/* snap msg header */
809struct ceph_mds_snap_head {
810 __le32 op; /* CEPH_SNAP_OP_* */
811 __le64 split; /* ino to split off, if any */
812 __le32 num_split_inos; /* # inos belonging to new child realm */
813 __le32 num_split_realms; /* # child realms udner new child realm */
814 __le32 trace_len; /* size of snap trace blob */
815} __attribute__ ((packed));
816/* followed by split ino list, then split realms, then the trace blob */
817
818/*
819 * encode info about a snaprealm, as viewed by a client
820 */
821struct ceph_mds_snap_realm {
822 __le64 ino; /* ino */
823 __le64 created; /* snap: when created */
824 __le64 parent; /* ino: parent realm */
825 __le64 parent_since; /* snap: same parent since */
826 __le64 seq; /* snap: version */
827 __le32 num_snaps;
828 __le32 num_prior_parent_snaps;
829} __attribute__ ((packed));
830/* followed by my snap list, then prior parent snap list */
831
832/*
833 * quotas
834 */
835struct ceph_mds_quota {
836 __le64 ino; /* ino */
837 struct ceph_timespec rctime;
838 __le64 rbytes; /* dir stats */
839 __le64 rfiles;
840 __le64 rsubdirs;
841 __u8 struct_v; /* compat */
842 __u8 struct_compat;
843 __le32 struct_len;
844 __le64 max_bytes; /* quota max. bytes */
845 __le64 max_files; /* quota max. files */
846} __attribute__ ((packed));
847
848#endif