1 /* SPDX-License-Identifier: GPL-2.0 */
3 * ceph_fs.h - Ceph constants and data types to share between kernel and
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.
16 #include <linux/ceph/msgr.h>
17 #include <linux/ceph/rados.h>
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.
25 #define CEPH_OSDC_PROTOCOL 24 /* server/client */
26 #define CEPH_MDSC_PROTOCOL 32 /* server/client */
27 #define CEPH_MONC_PROTOCOL 15 /* server/client */
30 #define CEPH_INO_ROOT 1
31 #define CEPH_INO_CEPH 2 /* hidden .ceph dir */
32 #define CEPH_INO_GLOBAL_SNAPREALM 3 /* global dummy snaprealm */
34 /* arbitrary limit on max # of monitors (cluster of 3 is typical) */
35 #define CEPH_MAX_MON 31
38 * legacy ceph_file_layoute
40 struct ceph_file_layout_legacy
{
41 /* file -> object mapping */
42 __le32 fl_stripe_unit
; /* stripe unit, in bytes. must be multiple
44 __le32 fl_stripe_count
; /* over this many objects */
45 __le32 fl_object_size
; /* until objects are this big, then move to
47 __le32 fl_cas_hash
; /* UNUSED. 0 = none; 1 = sha256 */
49 /* pg -> disk layout */
50 __le32 fl_object_stripe_unit
; /* UNUSED. for per-object parity, if any */
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
));
59 * ceph_file_layout - describe data layout for a file/inode
61 struct 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 */
70 extern int ceph_file_layout_is_valid(const struct ceph_file_layout
*layout
);
71 extern void ceph_file_layout_from_legacy(struct ceph_file_layout
*fl
,
72 struct ceph_file_layout_legacy
*legacy
);
73 extern void ceph_file_layout_to_legacy(struct ceph_file_layout
*fl
,
74 struct ceph_file_layout_legacy
*legacy
);
76 #define CEPH_MIN_STRIPE_UNIT 65536
78 struct ceph_dir_layout
{
79 __u8 dl_dir_hash
; /* see ceph_hash.h for ids */
83 } __attribute__ ((packed
));
85 /* crypto algorithms */
86 #define CEPH_CRYPTO_NONE 0x0
87 #define CEPH_CRYPTO_AES 0x1
89 #define CEPH_AES_IV "cephsageyudagreg"
91 /* security/authentication protocols */
92 #define CEPH_AUTH_UNKNOWN 0x0
93 #define CEPH_AUTH_NONE 0x1
94 #define CEPH_AUTH_CEPHX 0x2
96 #define CEPH_AUTH_MODE_NONE 0
97 #define CEPH_AUTH_MODE_AUTHORIZER 1
98 #define CEPH_AUTH_MODE_MON 10
100 /* msgr2 protocol modes */
101 #define CEPH_CON_MODE_UNKNOWN 0x0
102 #define CEPH_CON_MODE_CRC 0x1
103 #define CEPH_CON_MODE_SECURE 0x2
105 #define CEPH_AUTH_UID_DEFAULT ((__u64) -1)
107 const char *ceph_auth_proto_name(int proto
);
108 const char *ceph_con_mode_name(int mode
);
110 /*********************************************
119 #define CEPH_MSG_SHUTDOWN 1
120 #define CEPH_MSG_PING 2
122 /* client <-> monitor */
123 #define CEPH_MSG_MON_MAP 4
124 #define CEPH_MSG_MON_GET_MAP 5
125 #define CEPH_MSG_STATFS 13
126 #define CEPH_MSG_STATFS_REPLY 14
127 #define CEPH_MSG_MON_SUBSCRIBE 15
128 #define CEPH_MSG_MON_SUBSCRIBE_ACK 16
129 #define CEPH_MSG_AUTH 17
130 #define CEPH_MSG_AUTH_REPLY 18
131 #define CEPH_MSG_MON_GET_VERSION 19
132 #define CEPH_MSG_MON_GET_VERSION_REPLY 20
135 #define CEPH_MSG_MDS_MAP 21
136 #define CEPH_MSG_FS_MAP_USER 103
138 #define CEPH_MSG_CLIENT_SESSION 22
139 #define CEPH_MSG_CLIENT_RECONNECT 23
141 #define CEPH_MSG_CLIENT_REQUEST 24
142 #define CEPH_MSG_CLIENT_REQUEST_FORWARD 25
143 #define CEPH_MSG_CLIENT_REPLY 26
144 #define CEPH_MSG_CLIENT_METRICS 29
145 #define CEPH_MSG_CLIENT_CAPS 0x310
146 #define CEPH_MSG_CLIENT_LEASE 0x311
147 #define CEPH_MSG_CLIENT_SNAP 0x312
148 #define CEPH_MSG_CLIENT_CAPRELEASE 0x313
149 #define CEPH_MSG_CLIENT_QUOTA 0x314
152 #define CEPH_MSG_POOLOP_REPLY 48
153 #define CEPH_MSG_POOLOP 49
156 #define CEPH_MSG_MON_COMMAND 50
157 #define CEPH_MSG_MON_COMMAND_ACK 51
160 #define CEPH_MSG_OSD_MAP 41
161 #define CEPH_MSG_OSD_OP 42
162 #define CEPH_MSG_OSD_OPREPLY 43
163 #define CEPH_MSG_WATCH_NOTIFY 44
164 #define CEPH_MSG_OSD_BACKOFF 61
167 /* watch-notify operations */
169 CEPH_WATCH_EVENT_NOTIFY
= 1, /* notifying watcher */
170 CEPH_WATCH_EVENT_NOTIFY_COMPLETE
= 2, /* notifier notified when done */
171 CEPH_WATCH_EVENT_DISCONNECT
= 3, /* we were disconnected */
175 struct ceph_mon_request_header
{
178 __le64 session_mon_tid
;
179 } __attribute__ ((packed
));
181 struct ceph_mon_statfs
{
182 struct ceph_mon_request_header monhdr
;
183 struct ceph_fsid fsid
;
184 __u8 contains_data_pool
;
186 } __attribute__ ((packed
));
189 __le64 kb
, kb_used
, kb_avail
;
191 } __attribute__ ((packed
));
193 struct ceph_mon_statfs_reply
{
194 struct ceph_fsid fsid
;
196 struct ceph_statfs st
;
197 } __attribute__ ((packed
));
199 struct ceph_mon_command
{
200 struct ceph_mon_request_header monhdr
;
201 struct ceph_fsid fsid
;
202 __le32 num_strs
; /* always 1 */
205 } __attribute__ ((packed
));
207 struct ceph_osd_getmap
{
208 struct ceph_mon_request_header monhdr
;
209 struct ceph_fsid fsid
;
211 } __attribute__ ((packed
));
213 struct ceph_mds_getmap
{
214 struct ceph_mon_request_header monhdr
;
215 struct ceph_fsid fsid
;
216 } __attribute__ ((packed
));
218 struct ceph_client_mount
{
219 struct ceph_mon_request_header monhdr
;
220 } __attribute__ ((packed
));
222 #define CEPH_SUBSCRIBE_ONETIME 1 /* i want only 1 update after have */
224 struct ceph_mon_subscribe_item
{
227 } __attribute__ ((packed
));
229 struct ceph_mon_subscribe_ack
{
230 __le32 duration
; /* seconds */
231 struct ceph_fsid fsid
;
232 } __attribute__ ((packed
));
234 #define CEPH_FS_CLUSTER_ID_NONE -1
239 #define CEPH_MDSMAP_DOWN (1<<0) /* cluster deliberately down */
246 #define CEPH_MDS_STATE_DNE 0 /* down, does not exist. */
247 #define CEPH_MDS_STATE_STOPPED -1 /* down, once existed, but no subtrees.
249 #define CEPH_MDS_STATE_BOOT -4 /* up, boot announcement. */
250 #define CEPH_MDS_STATE_STANDBY -5 /* up, idle. waiting for assignment. */
251 #define CEPH_MDS_STATE_CREATING -6 /* up, creating MDS instance. */
252 #define CEPH_MDS_STATE_STARTING -7 /* up, starting previously stopped mds */
253 #define CEPH_MDS_STATE_STANDBY_REPLAY -8 /* up, tailing active node's journal */
254 #define CEPH_MDS_STATE_REPLAYONCE -9 /* up, replaying an active node's journal */
256 #define CEPH_MDS_STATE_REPLAY 8 /* up, replaying journal. */
257 #define CEPH_MDS_STATE_RESOLVE 9 /* up, disambiguating distributed
258 operations (import, rename, etc.) */
259 #define CEPH_MDS_STATE_RECONNECT 10 /* up, reconnect to clients */
260 #define CEPH_MDS_STATE_REJOIN 11 /* up, rejoining distributed cache */
261 #define CEPH_MDS_STATE_CLIENTREPLAY 12 /* up, replaying client operations */
262 #define CEPH_MDS_STATE_ACTIVE 13 /* up, active */
263 #define CEPH_MDS_STATE_STOPPING 14 /* up, but exporting metadata */
265 extern const char *ceph_mds_state_name(int s
);
269 * metadata lock types.
270 * - these are bitmasks.. we can compose them
271 * - they also define the lock ordering by the MDS
272 * - a few of these are internal to the mds
274 #define CEPH_LOCK_DVERSION 1
275 #define CEPH_LOCK_DN 2
276 #define CEPH_LOCK_ISNAP 16
277 #define CEPH_LOCK_IVERSION 32 /* mds internal */
278 #define CEPH_LOCK_IFILE 64
279 #define CEPH_LOCK_IAUTH 128
280 #define CEPH_LOCK_ILINK 256
281 #define CEPH_LOCK_IDFT 512 /* dir frag tree */
282 #define CEPH_LOCK_INEST 1024 /* mds internal */
283 #define CEPH_LOCK_IXATTR 2048
284 #define CEPH_LOCK_IFLOCK 4096 /* advisory file locks */
285 #define CEPH_LOCK_INO 8192 /* immutable inode bits; not a lock */
286 #define CEPH_LOCK_IPOLICY 16384 /* policy lock on dirs. MDS internal */
288 /* client_session ops */
290 CEPH_SESSION_REQUEST_OPEN
,
292 CEPH_SESSION_REQUEST_CLOSE
,
294 CEPH_SESSION_REQUEST_RENEWCAPS
,
295 CEPH_SESSION_RENEWCAPS
,
297 CEPH_SESSION_RECALL_STATE
,
298 CEPH_SESSION_FLUSHMSG
,
299 CEPH_SESSION_FLUSHMSG_ACK
,
300 CEPH_SESSION_FORCE_RO
,
302 CEPH_SESSION_REQUEST_FLUSH_MDLOG
,
305 #define CEPH_SESSION_BLOCKLISTED (1 << 0) /* session blocklisted */
307 extern const char *ceph_session_op_name(int op
);
309 struct ceph_mds_session_head
{
312 struct ceph_timespec stamp
;
313 __le32 max_caps
, max_leases
;
314 } __attribute__ ((packed
));
319 * & 0x001000 -> write op
320 * & 0x010000 -> follow symlink (e.g. stat(), not lstat()).
321 & & 0x100000 -> use weird ino/path trace
323 #define CEPH_MDS_OP_WRITE 0x001000
325 CEPH_MDS_OP_LOOKUP
= 0x00100,
326 CEPH_MDS_OP_GETATTR
= 0x00101,
327 CEPH_MDS_OP_LOOKUPHASH
= 0x00102,
328 CEPH_MDS_OP_LOOKUPPARENT
= 0x00103,
329 CEPH_MDS_OP_LOOKUPINO
= 0x00104,
330 CEPH_MDS_OP_LOOKUPNAME
= 0x00105,
331 CEPH_MDS_OP_GETVXATTR
= 0x00106,
333 CEPH_MDS_OP_SETXATTR
= 0x01105,
334 CEPH_MDS_OP_RMXATTR
= 0x01106,
335 CEPH_MDS_OP_SETLAYOUT
= 0x01107,
336 CEPH_MDS_OP_SETATTR
= 0x01108,
337 CEPH_MDS_OP_SETFILELOCK
= 0x01109,
338 CEPH_MDS_OP_GETFILELOCK
= 0x00110,
339 CEPH_MDS_OP_SETDIRLAYOUT
=0x0110a,
341 CEPH_MDS_OP_MKNOD
= 0x01201,
342 CEPH_MDS_OP_LINK
= 0x01202,
343 CEPH_MDS_OP_UNLINK
= 0x01203,
344 CEPH_MDS_OP_RENAME
= 0x01204,
345 CEPH_MDS_OP_MKDIR
= 0x01220,
346 CEPH_MDS_OP_RMDIR
= 0x01221,
347 CEPH_MDS_OP_SYMLINK
= 0x01222,
349 CEPH_MDS_OP_CREATE
= 0x01301,
350 CEPH_MDS_OP_OPEN
= 0x00302,
351 CEPH_MDS_OP_READDIR
= 0x00305,
353 CEPH_MDS_OP_LOOKUPSNAP
= 0x00400,
354 CEPH_MDS_OP_MKSNAP
= 0x01400,
355 CEPH_MDS_OP_RMSNAP
= 0x01401,
356 CEPH_MDS_OP_LSSNAP
= 0x00402,
357 CEPH_MDS_OP_RENAMESNAP
= 0x01403,
360 extern const char *ceph_mds_op_name(int op
);
362 #define CEPH_SETATTR_MODE (1 << 0)
363 #define CEPH_SETATTR_UID (1 << 1)
364 #define CEPH_SETATTR_GID (1 << 2)
365 #define CEPH_SETATTR_MTIME (1 << 3)
366 #define CEPH_SETATTR_ATIME (1 << 4)
367 #define CEPH_SETATTR_SIZE (1 << 5)
368 #define CEPH_SETATTR_CTIME (1 << 6)
369 #define CEPH_SETATTR_MTIME_NOW (1 << 7)
370 #define CEPH_SETATTR_ATIME_NOW (1 << 8)
371 #define CEPH_SETATTR_BTIME (1 << 9)
372 #define CEPH_SETATTR_KILL_SGUID (1 << 10)
373 #define CEPH_SETATTR_FSCRYPT_AUTH (1 << 11)
374 #define CEPH_SETATTR_FSCRYPT_FILE (1 << 12)
377 * Ceph setxattr request flags.
379 #define CEPH_XATTR_CREATE (1 << 0)
380 #define CEPH_XATTR_REPLACE (1 << 1)
381 #define CEPH_XATTR_REMOVE (1 << 31)
384 * readdir request flags;
386 #define CEPH_READDIR_REPLY_BITFLAGS (1<<0)
389 * readdir reply flags.
391 #define CEPH_READDIR_FRAG_END (1<<0)
392 #define CEPH_READDIR_FRAG_COMPLETE (1<<8)
393 #define CEPH_READDIR_HASH_ORDER (1<<9)
394 #define CEPH_READDIR_OFFSET_HASH (1<<10)
399 #define CEPH_O_RDONLY 00000000
400 #define CEPH_O_WRONLY 00000001
401 #define CEPH_O_RDWR 00000002
402 #define CEPH_O_CREAT 00000100
403 #define CEPH_O_EXCL 00000200
404 #define CEPH_O_TRUNC 00001000
405 #define CEPH_O_DIRECTORY 00200000
406 #define CEPH_O_NOFOLLOW 00400000
408 union ceph_mds_request_args
{
410 __le32 mask
; /* CEPH_CAP_* */
411 } __attribute__ ((packed
)) getattr
;
416 struct ceph_timespec mtime
;
417 struct ceph_timespec atime
;
418 __le64 size
, old_size
; /* old_size needed by truncate */
419 __le32 mask
; /* CEPH_SETATTR_* */
420 } __attribute__ ((packed
)) setattr
;
422 __le32 frag
; /* which dir fragment */
423 __le32 max_entries
; /* how many dentries to grab */
427 } __attribute__ ((packed
)) readdir
;
431 } __attribute__ ((packed
)) mknod
;
434 } __attribute__ ((packed
)) mkdir
;
438 __le32 stripe_unit
; /* layout for newly created file */
439 __le32 stripe_count
; /* ... */
442 __le32 mask
; /* CEPH_CAP_* */
444 } __attribute__ ((packed
)) open
;
447 __le32 osdmap_epoch
; /* used for setting file/dir layouts */
448 } __attribute__ ((packed
)) setxattr
;
450 struct ceph_file_layout_legacy layout
;
451 } __attribute__ ((packed
)) setlayout
;
453 __u8 rule
; /* currently fcntl or flock */
454 __u8 type
; /* shared, exclusive, remove*/
455 __le64 owner
; /* owner of the lock */
456 __le64 pid
; /* process id requesting the lock */
457 __le64 start
; /* initial location to lock */
458 __le64 length
; /* num bytes to lock from start */
459 __u8 wait
; /* will caller wait for lock to become available? */
460 } __attribute__ ((packed
)) filelock_change
;
462 __le32 mask
; /* CEPH_CAP_* */
466 } __attribute__ ((packed
)) lookupino
;
467 } __attribute__ ((packed
));
469 union ceph_mds_request_args_ext
{
471 union ceph_mds_request_args old
;
476 struct ceph_timespec mtime
;
477 struct ceph_timespec atime
;
478 __le64 size
, old_size
; /* old_size needed by truncate */
479 __le32 mask
; /* CEPH_SETATTR_* */
480 struct ceph_timespec btime
;
481 } __attribute__ ((packed
)) setattr_ext
;
485 #define CEPH_MDS_FLAG_REPLAY 1 /* this is a replayed op */
486 #define CEPH_MDS_FLAG_WANT_DENTRY 2 /* want dentry in reply */
487 #define CEPH_MDS_FLAG_ASYNC 4 /* request is asynchronous */
489 struct ceph_mds_request_head_legacy
{
490 __le64 oldest_client_tid
;
491 __le32 mdsmap_epoch
; /* on client */
492 __le32 flags
; /* CEPH_MDS_FLAG_* */
493 __u8 num_retry
, num_fwd
; /* count retry, fwd attempts */
494 __le16 num_releases
; /* # include cap/lease release records */
495 __le32 op
; /* mds op code */
496 __le32 caller_uid
, caller_gid
;
497 __le64 ino
; /* use this ino for openc, mkdir, mknod,
498 etc. (if replaying) */
499 union ceph_mds_request_args args
;
500 } __attribute__ ((packed
));
502 #define CEPH_MDS_REQUEST_HEAD_VERSION 2
504 struct ceph_mds_request_head_old
{
505 __le16 version
; /* struct version */
506 __le64 oldest_client_tid
;
507 __le32 mdsmap_epoch
; /* on client */
508 __le32 flags
; /* CEPH_MDS_FLAG_* */
509 __u8 num_retry
, num_fwd
; /* count retry, fwd attempts */
510 __le16 num_releases
; /* # include cap/lease release records */
511 __le32 op
; /* mds op code */
512 __le32 caller_uid
, caller_gid
;
513 __le64 ino
; /* use this ino for openc, mkdir, mknod,
514 etc. (if replaying) */
515 union ceph_mds_request_args_ext args
;
516 } __attribute__ ((packed
));
518 struct ceph_mds_request_head
{
519 __le16 version
; /* struct version */
520 __le64 oldest_client_tid
;
521 __le32 mdsmap_epoch
; /* on client */
522 __le32 flags
; /* CEPH_MDS_FLAG_* */
523 __u8 num_retry
, num_fwd
; /* legacy count retry and fwd attempts */
524 __le16 num_releases
; /* # include cap/lease release records */
525 __le32 op
; /* mds op code */
526 __le32 caller_uid
, caller_gid
;
527 __le64 ino
; /* use this ino for openc, mkdir, mknod,
528 etc. (if replaying) */
529 union ceph_mds_request_args_ext args
;
531 __le32 ext_num_retry
; /* new count retry attempts */
532 __le32 ext_num_fwd
; /* new count fwd attempts */
533 } __attribute__ ((packed
));
535 /* cap/lease release record */
536 struct ceph_mds_request_release
{
537 __le64 ino
, cap_id
; /* ino and unique cap id */
538 __le32 caps
, wanted
; /* new issued, wanted */
539 __le32 seq
, issue_seq
, mseq
;
540 __le32 dname_seq
; /* if releasing a dentry lease, a */
541 __le32 dname_len
; /* string follows. */
542 } __attribute__ ((packed
));
545 struct ceph_mds_reply_head
{
549 __u8 safe
; /* true if committed to disk */
550 __u8 is_dentry
, is_target
; /* true if dentry, target inode records
551 are included with reply */
552 } __attribute__ ((packed
));
554 /* one for each node split */
555 struct ceph_frag_tree_split
{
556 __le32 frag
; /* this frag splits... */
557 __le32 by
; /* ...by this many bits */
558 } __attribute__ ((packed
));
560 struct ceph_frag_tree_head
{
561 __le32 nsplits
; /* num ceph_frag_tree_split records */
562 struct ceph_frag_tree_split splits
[];
563 } __attribute__ ((packed
));
565 /* capability issue, for bundling with mds reply */
566 struct ceph_mds_reply_cap
{
567 __le32 caps
, wanted
; /* caps issued, wanted */
570 __le64 realm
; /* snap realm */
571 __u8 flags
; /* CEPH_CAP_FLAG_* */
572 } __attribute__ ((packed
));
574 #define CEPH_CAP_FLAG_AUTH (1 << 0) /* cap is issued by auth mds */
575 #define CEPH_CAP_FLAG_RELEASE (1 << 1) /* release the cap */
577 /* inode record, for bundling with mds reply */
578 struct ceph_mds_reply_inode
{
582 __le64 version
; /* inode version */
583 __le64 xattr_version
; /* version for xattr blob */
584 struct ceph_mds_reply_cap cap
; /* caps issued for this inode */
585 struct ceph_file_layout_legacy layout
;
586 struct ceph_timespec ctime
, mtime
, atime
;
587 __le32 time_warp_seq
;
588 __le64 size
, max_size
, truncate_size
;
590 __le32 mode
, uid
, gid
;
592 __le64 files
, subdirs
, rbytes
, rfiles
, rsubdirs
; /* dir stats */
593 struct ceph_timespec rctime
;
594 struct ceph_frag_tree_head fragtree
; /* (must be at end of struct) */
595 } __attribute__ ((packed
));
596 /* followed by frag array, symlink string, dir layout, xattr blob */
598 /* reply_lease follows dname, and reply_inode */
599 struct ceph_mds_reply_lease
{
600 __le16 mask
; /* lease type(s) */
601 __le32 duration_ms
; /* lease duration */
603 } __attribute__ ((packed
));
605 #define CEPH_LEASE_VALID (1 | 2) /* old and new bit values */
606 #define CEPH_LEASE_PRIMARY_LINK 4 /* primary linkage */
608 struct ceph_mds_reply_dirfrag
{
609 __le32 frag
; /* fragment */
610 __le32 auth
; /* auth mds, if this is a delegation point */
611 __le32 ndist
; /* number of mds' this is replicated on */
613 } __attribute__ ((packed
));
615 #define CEPH_LOCK_FCNTL 1
616 #define CEPH_LOCK_FLOCK 2
617 #define CEPH_LOCK_FCNTL_INTR 3
618 #define CEPH_LOCK_FLOCK_INTR 4
621 #define CEPH_LOCK_SHARED 1
622 #define CEPH_LOCK_EXCL 2
623 #define CEPH_LOCK_UNLOCK 4
625 struct ceph_filelock
{
626 __le64 start
;/* file offset to start lock at */
627 __le64 length
; /* num bytes to lock; 0 for all following start */
628 __le64 client
; /* which client holds the lock */
629 __le64 owner
; /* owner the lock */
630 __le64 pid
; /* process id holding the lock on the client */
631 __u8 type
; /* shared lock, exclusive lock, or unlock */
632 } __attribute__ ((packed
));
635 /* file access modes */
636 #define CEPH_FILE_MODE_PIN 0
637 #define CEPH_FILE_MODE_RD 1
638 #define CEPH_FILE_MODE_WR 2
639 #define CEPH_FILE_MODE_RDWR 3 /* RD | WR */
640 #define CEPH_FILE_MODE_LAZY 4 /* lazy io */
641 #define CEPH_FILE_MODE_BITS 4
642 #define CEPH_FILE_MODE_MASK ((1 << CEPH_FILE_MODE_BITS) - 1)
644 int ceph_flags_to_mode(int flags
);
646 #define CEPH_INLINE_NONE ((__u64)-1)
648 /* capability bits */
649 #define CEPH_CAP_PIN 1 /* no specific capabilities beyond the pin */
651 /* generic cap bits */
652 #define CEPH_CAP_GSHARED 1 /* client can reads */
653 #define CEPH_CAP_GEXCL 2 /* client can read and update */
654 #define CEPH_CAP_GCACHE 4 /* (file) client can cache reads */
655 #define CEPH_CAP_GRD 8 /* (file) client can read */
656 #define CEPH_CAP_GWR 16 /* (file) client can write */
657 #define CEPH_CAP_GBUFFER 32 /* (file) client can buffer writes */
658 #define CEPH_CAP_GWREXTEND 64 /* (file) client can extend EOF */
659 #define CEPH_CAP_GLAZYIO 128 /* (file) client can perform lazy io */
661 #define CEPH_CAP_SIMPLE_BITS 2
662 #define CEPH_CAP_FILE_BITS 8
665 #define CEPH_CAP_SAUTH 2
666 #define CEPH_CAP_SLINK 4
667 #define CEPH_CAP_SXATTR 6
668 #define CEPH_CAP_SFILE 8
669 #define CEPH_CAP_SFLOCK 20
671 #define CEPH_CAP_BITS 22
673 /* composed values */
674 #define CEPH_CAP_AUTH_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SAUTH)
675 #define CEPH_CAP_AUTH_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SAUTH)
676 #define CEPH_CAP_LINK_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SLINK)
677 #define CEPH_CAP_LINK_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SLINK)
678 #define CEPH_CAP_XATTR_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SXATTR)
679 #define CEPH_CAP_XATTR_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SXATTR)
680 #define CEPH_CAP_FILE(x) (x << CEPH_CAP_SFILE)
681 #define CEPH_CAP_FILE_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SFILE)
682 #define CEPH_CAP_FILE_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SFILE)
683 #define CEPH_CAP_FILE_CACHE (CEPH_CAP_GCACHE << CEPH_CAP_SFILE)
684 #define CEPH_CAP_FILE_RD (CEPH_CAP_GRD << CEPH_CAP_SFILE)
685 #define CEPH_CAP_FILE_WR (CEPH_CAP_GWR << CEPH_CAP_SFILE)
686 #define CEPH_CAP_FILE_BUFFER (CEPH_CAP_GBUFFER << CEPH_CAP_SFILE)
687 #define CEPH_CAP_FILE_WREXTEND (CEPH_CAP_GWREXTEND << CEPH_CAP_SFILE)
688 #define CEPH_CAP_FILE_LAZYIO (CEPH_CAP_GLAZYIO << CEPH_CAP_SFILE)
689 #define CEPH_CAP_FLOCK_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SFLOCK)
690 #define CEPH_CAP_FLOCK_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SFLOCK)
693 /* cap masks (for getattr) */
694 #define CEPH_STAT_CAP_INODE CEPH_CAP_PIN
695 #define CEPH_STAT_CAP_TYPE CEPH_CAP_PIN /* mode >> 12 */
696 #define CEPH_STAT_CAP_SYMLINK CEPH_CAP_PIN
697 #define CEPH_STAT_CAP_UID CEPH_CAP_AUTH_SHARED
698 #define CEPH_STAT_CAP_GID CEPH_CAP_AUTH_SHARED
699 #define CEPH_STAT_CAP_MODE CEPH_CAP_AUTH_SHARED
700 #define CEPH_STAT_CAP_NLINK CEPH_CAP_LINK_SHARED
701 #define CEPH_STAT_CAP_LAYOUT CEPH_CAP_FILE_SHARED
702 #define CEPH_STAT_CAP_MTIME CEPH_CAP_FILE_SHARED
703 #define CEPH_STAT_CAP_SIZE CEPH_CAP_FILE_SHARED
704 #define CEPH_STAT_CAP_ATIME CEPH_CAP_FILE_SHARED /* fixme */
705 #define CEPH_STAT_CAP_XATTR CEPH_CAP_XATTR_SHARED
706 #define CEPH_STAT_CAP_INODE_ALL (CEPH_CAP_PIN | \
707 CEPH_CAP_AUTH_SHARED | \
708 CEPH_CAP_LINK_SHARED | \
709 CEPH_CAP_FILE_SHARED | \
710 CEPH_CAP_XATTR_SHARED)
711 #define CEPH_STAT_CAP_INLINE_DATA (CEPH_CAP_FILE_SHARED | \
713 #define CEPH_STAT_RSTAT CEPH_CAP_FILE_WREXTEND
715 #define CEPH_CAP_ANY_SHARED (CEPH_CAP_AUTH_SHARED | \
716 CEPH_CAP_LINK_SHARED | \
717 CEPH_CAP_XATTR_SHARED | \
718 CEPH_CAP_FILE_SHARED)
719 #define CEPH_CAP_ANY_RD (CEPH_CAP_ANY_SHARED | CEPH_CAP_FILE_RD | \
722 #define CEPH_CAP_ANY_EXCL (CEPH_CAP_AUTH_EXCL | \
723 CEPH_CAP_LINK_EXCL | \
724 CEPH_CAP_XATTR_EXCL | \
726 #define CEPH_CAP_ANY_FILE_RD (CEPH_CAP_FILE_RD | CEPH_CAP_FILE_CACHE | \
727 CEPH_CAP_FILE_SHARED)
728 #define CEPH_CAP_ANY_FILE_WR (CEPH_CAP_FILE_WR | CEPH_CAP_FILE_BUFFER | \
730 #define CEPH_CAP_ANY_WR (CEPH_CAP_ANY_EXCL | CEPH_CAP_ANY_FILE_WR)
731 #define CEPH_CAP_ANY (CEPH_CAP_ANY_RD | CEPH_CAP_ANY_EXCL | \
732 CEPH_CAP_ANY_FILE_WR | CEPH_CAP_FILE_LAZYIO | \
734 #define CEPH_CAP_ALL_FILE (CEPH_CAP_PIN | CEPH_CAP_ANY_SHARED | \
735 CEPH_CAP_AUTH_EXCL | CEPH_CAP_XATTR_EXCL | \
736 CEPH_CAP_ANY_FILE_RD | CEPH_CAP_ANY_FILE_WR)
738 #define CEPH_CAP_LOCKS (CEPH_LOCK_IFILE | CEPH_LOCK_IAUTH | CEPH_LOCK_ILINK | \
741 /* cap masks async dir operations */
742 #define CEPH_CAP_DIR_CREATE CEPH_CAP_FILE_CACHE
743 #define CEPH_CAP_DIR_UNLINK CEPH_CAP_FILE_RD
744 #define CEPH_CAP_ANY_DIR_OPS (CEPH_CAP_FILE_CACHE | CEPH_CAP_FILE_RD | \
745 CEPH_CAP_FILE_WREXTEND | CEPH_CAP_FILE_LAZYIO)
747 int ceph_caps_for_mode(int mode
);
750 CEPH_CAP_OP_GRANT
, /* mds->client grant */
751 CEPH_CAP_OP_REVOKE
, /* mds->client revoke */
752 CEPH_CAP_OP_TRUNC
, /* mds->client trunc notify */
753 CEPH_CAP_OP_EXPORT
, /* mds has exported the cap */
754 CEPH_CAP_OP_IMPORT
, /* mds has imported the cap */
755 CEPH_CAP_OP_UPDATE
, /* client->mds update */
756 CEPH_CAP_OP_DROP
, /* client->mds drop cap bits */
757 CEPH_CAP_OP_FLUSH
, /* client->mds cap writeback */
758 CEPH_CAP_OP_FLUSH_ACK
, /* mds->client flushed */
759 CEPH_CAP_OP_FLUSHSNAP
, /* client->mds flush snapped metadata */
760 CEPH_CAP_OP_FLUSHSNAP_ACK
, /* mds->client flushed snapped metadata */
761 CEPH_CAP_OP_RELEASE
, /* client->mds release (clean) cap */
762 CEPH_CAP_OP_RENEW
, /* client->mds renewal request */
765 extern const char *ceph_cap_op_name(int op
);
767 /* flags field in client cap messages (version >= 10) */
768 #define CEPH_CLIENT_CAPS_SYNC (1<<0)
769 #define CEPH_CLIENT_CAPS_NO_CAPSNAP (1<<1)
770 #define CEPH_CLIENT_CAPS_PENDING_CAPSNAP (1<<2)
773 * caps message, used for capability callbacks, acks, requests, etc.
775 struct ceph_mds_caps
{
776 __le32 op
; /* CEPH_CAP_OP_* */
779 __le32 seq
, issue_seq
;
780 __le32 caps
, wanted
, dirty
; /* latest issued/wanted/dirty */
783 __le32 snap_trace_len
;
786 __le32 uid
, gid
, mode
;
793 __le64 xattr_version
;
795 /* a union of non-export and export bodies. */
796 __le64 size
, max_size
, truncate_size
;
798 struct ceph_timespec mtime
, atime
, ctime
;
799 struct ceph_file_layout_legacy layout
;
800 __le32 time_warp_seq
;
801 } __attribute__ ((packed
));
803 struct ceph_mds_cap_peer
{
809 } __attribute__ ((packed
));
811 /* cap release msg head */
812 struct ceph_mds_cap_release
{
813 __le32 num
; /* number of cap_items that follow */
814 } __attribute__ ((packed
));
816 struct ceph_mds_cap_item
{
819 __le32 migrate_seq
, seq
;
820 } __attribute__ ((packed
));
822 #define CEPH_MDS_LEASE_REVOKE 1 /* mds -> client */
823 #define CEPH_MDS_LEASE_RELEASE 2 /* client -> mds */
824 #define CEPH_MDS_LEASE_RENEW 3 /* client <-> mds */
825 #define CEPH_MDS_LEASE_REVOKE_ACK 4 /* client -> mds */
827 extern const char *ceph_lease_op_name(int o
);
829 /* lease msg header */
830 struct ceph_mds_lease
{
831 __u8 action
; /* CEPH_MDS_LEASE_* */
832 __le16 mask
; /* which lease */
834 __le64 first
, last
; /* snap range */
836 __le32 duration_ms
; /* duration of renewal */
837 } __attribute__ ((packed
));
838 /* followed by a __le32+string for dname */
840 /* client reconnect */
841 struct ceph_mds_cap_reconnect
{
846 __le64 pathbase
; /* base ino for our path to this ino */
847 __le32 flock_len
; /* size of flock state blob, if any */
848 } __attribute__ ((packed
));
849 /* followed by flock blob */
851 struct ceph_mds_cap_reconnect_v1
{
856 struct ceph_timespec mtime
, atime
;
858 __le64 pathbase
; /* base ino for our path to this ino */
859 } __attribute__ ((packed
));
861 struct ceph_mds_snaprealm_reconnect
{
862 __le64 ino
; /* snap realm base */
863 __le64 seq
; /* snap seq for this snap realm */
864 __le64 parent
; /* parent realm */
865 } __attribute__ ((packed
));
871 CEPH_SNAP_OP_UPDATE
, /* CREATE or DESTROY */
873 CEPH_SNAP_OP_DESTROY
,
877 extern const char *ceph_snap_op_name(int o
);
879 /* snap msg header */
880 struct ceph_mds_snap_head
{
881 __le32 op
; /* CEPH_SNAP_OP_* */
882 __le64 split
; /* ino to split off, if any */
883 __le32 num_split_inos
; /* # inos belonging to new child realm */
884 __le32 num_split_realms
; /* # child realms udner new child realm */
885 __le32 trace_len
; /* size of snap trace blob */
886 } __attribute__ ((packed
));
887 /* followed by split ino list, then split realms, then the trace blob */
890 * encode info about a snaprealm, as viewed by a client
892 struct ceph_mds_snap_realm
{
893 __le64 ino
; /* ino */
894 __le64 created
; /* snap: when created */
895 __le64 parent
; /* ino: parent realm */
896 __le64 parent_since
; /* snap: same parent since */
897 __le64 seq
; /* snap: version */
899 __le32 num_prior_parent_snaps
;
900 } __attribute__ ((packed
));
901 /* followed by my snap list, then prior parent snap list */
906 struct ceph_mds_quota
{
907 __le64 ino
; /* ino */
908 struct ceph_timespec rctime
;
909 __le64 rbytes
; /* dir stats */
912 __u8 struct_v
; /* compat */
915 __le64 max_bytes
; /* quota max. bytes */
916 __le64 max_files
; /* quota max. files */
917 } __attribute__ ((packed
));