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