5 * Data types for the Ceph distributed object storage layer RADOS
6 * (Reliable Autonomic Distributed Object Store).
12 * osdmap encoding versions
14 #define CEPH_OSDMAP_INC_VERSION 5
15 #define CEPH_OSDMAP_INC_VERSION_EXT 5
16 #define CEPH_OSDMAP_VERSION 5
17 #define CEPH_OSDMAP_VERSION_EXT 5
23 unsigned char fsid
[16];
26 static inline int ceph_fsid_compare(const struct ceph_fsid
*a
,
27 const struct ceph_fsid
*b
)
29 return memcmp(a
, b
, sizeof(*a
));
35 typedef __le64 ceph_snapid_t
;
36 #define CEPH_SNAPDIR ((__u64)(-1)) /* reserved for hidden .snap dir */
37 #define CEPH_NOSNAP ((__u64)(-2)) /* "head", "live" revision */
38 #define CEPH_MAXSNAP ((__u64)(-3)) /* largest valid snapid */
40 struct ceph_timespec
{
43 } __attribute__ ((packed
));
47 * object layout - how objects are mapped into PGs
49 #define CEPH_OBJECT_LAYOUT_HASH 1
50 #define CEPH_OBJECT_LAYOUT_LINEAR 2
51 #define CEPH_OBJECT_LAYOUT_HASHINO 3
54 * pg layout -- how PGs are mapped onto (sets of) OSDs
56 #define CEPH_PG_LAYOUT_CRUSH 0
57 #define CEPH_PG_LAYOUT_HASH 1
58 #define CEPH_PG_LAYOUT_LINEAR 2
59 #define CEPH_PG_LAYOUT_HYBRID 3
61 #define CEPH_PG_MAX_SIZE 16 /* max # osds in a single pg */
65 * we encode this into one __le64.
68 __le16 preferred
; /* preferred primary osd */
69 __le16 ps
; /* placement seed */
70 __le32 pool
; /* object pool */
71 } __attribute__ ((packed
));
74 * pg_pool is a set of pgs storing a pool of objects
76 * pg_num -- base number of pseudorandomly placed pgs
78 * pgp_num -- effective number when calculating pg placement. this
79 * is used for pg_num increases. new pgs result in data being "split"
80 * into new pgs. for this to proceed smoothly, new pgs are intiially
81 * colocated with their parents; that is, pgp_num doesn't increase
82 * until the new pgs have successfully split. only _then_ are the new
83 * pgs placed independently.
85 * lpg_num -- localized pg count (per device). replicas are randomly
88 * lpgp_num -- as above.
90 #define CEPH_PG_TYPE_REP 1
91 #define CEPH_PG_TYPE_RAID4 2
92 #define CEPH_PG_POOL_VERSION 2
94 __u8 type
; /* CEPH_PG_TYPE_* */
95 __u8 size
; /* number of osds in each pg */
96 __u8 crush_ruleset
; /* crush placement rule */
97 __u8 object_hash
; /* hash mapping object name to ps */
98 __le32 pg_num
, pgp_num
; /* number of pg's */
99 __le32 lpg_num
, lpgp_num
; /* number of localized pg's */
100 __le32 last_change
; /* most recent epoch changed */
101 __le64 snap_seq
; /* seq for per-pool snapshot */
102 __le32 snap_epoch
; /* epoch of last snap */
104 __le32 num_removed_snap_intervals
;
106 } __attribute__ ((packed
));
109 * stable_mod func is used to control number of placement groups.
110 * similar to straight-up modulo, but produces a stable mapping as b
111 * increases over time. b is the number of bins, and bmask is the
112 * containing power of 2 minus 1.
114 * b <= bmask and bmask=(2**n)-1
115 * e.g., b=12 -> bmask=15, b=123 -> bmask=127
117 static inline int ceph_stable_mod(int x
, int b
, int bmask
)
122 return x
& (bmask
>> 1);
126 * object layout - how a given object should be stored.
128 struct ceph_object_layout
{
129 struct ceph_pg ol_pgid
; /* raw pg, with _full_ ps precision. */
130 __le32 ol_stripe_unit
; /* for per-object parity, if any */
131 } __attribute__ ((packed
));
134 * compound epoch+version, used by storage layer to serialize mutations
136 struct ceph_eversion
{
139 } __attribute__ ((packed
));
146 #define CEPH_OSD_EXISTS 1
147 #define CEPH_OSD_UP 2
149 /* osd weights. fixed point value: 0x10000 == 1.0 ("in"), 0 == "out" */
150 #define CEPH_OSD_IN 0x10000
151 #define CEPH_OSD_OUT 0
157 #define CEPH_OSDMAP_NEARFULL (1<<0) /* sync writes (near ENOSPC) */
158 #define CEPH_OSDMAP_FULL (1<<1) /* no data writes (ENOSPC) */
159 #define CEPH_OSDMAP_PAUSERD (1<<2) /* pause all reads */
160 #define CEPH_OSDMAP_PAUSEWR (1<<3) /* pause all writes */
161 #define CEPH_OSDMAP_PAUSEREC (1<<4) /* pause recovery */
166 #define CEPH_OSD_OP_MODE 0xf000
167 #define CEPH_OSD_OP_MODE_RD 0x1000
168 #define CEPH_OSD_OP_MODE_WR 0x2000
169 #define CEPH_OSD_OP_MODE_RMW 0x3000
170 #define CEPH_OSD_OP_MODE_SUB 0x4000
172 #define CEPH_OSD_OP_TYPE 0x0f00
173 #define CEPH_OSD_OP_TYPE_LOCK 0x0100
174 #define CEPH_OSD_OP_TYPE_DATA 0x0200
175 #define CEPH_OSD_OP_TYPE_ATTR 0x0300
176 #define CEPH_OSD_OP_TYPE_EXEC 0x0400
177 #define CEPH_OSD_OP_TYPE_PG 0x0500
182 CEPH_OSD_OP_READ
= CEPH_OSD_OP_MODE_RD
| CEPH_OSD_OP_TYPE_DATA
| 1,
183 CEPH_OSD_OP_STAT
= CEPH_OSD_OP_MODE_RD
| CEPH_OSD_OP_TYPE_DATA
| 2,
186 CEPH_OSD_OP_MASKTRUNC
= CEPH_OSD_OP_MODE_RD
| CEPH_OSD_OP_TYPE_DATA
| 4,
189 CEPH_OSD_OP_WRITE
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 1,
190 CEPH_OSD_OP_WRITEFULL
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 2,
191 CEPH_OSD_OP_TRUNCATE
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 3,
192 CEPH_OSD_OP_ZERO
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 4,
193 CEPH_OSD_OP_DELETE
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 5,
196 CEPH_OSD_OP_APPEND
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 6,
197 CEPH_OSD_OP_STARTSYNC
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 7,
198 CEPH_OSD_OP_SETTRUNC
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 8,
199 CEPH_OSD_OP_TRIMTRUNC
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 9,
201 CEPH_OSD_OP_TMAPUP
= CEPH_OSD_OP_MODE_RMW
| CEPH_OSD_OP_TYPE_DATA
| 10,
202 CEPH_OSD_OP_TMAPPUT
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 11,
203 CEPH_OSD_OP_TMAPGET
= CEPH_OSD_OP_MODE_RD
| CEPH_OSD_OP_TYPE_DATA
| 12,
205 CEPH_OSD_OP_CREATE
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_DATA
| 13,
209 CEPH_OSD_OP_GETXATTR
= CEPH_OSD_OP_MODE_RD
| CEPH_OSD_OP_TYPE_ATTR
| 1,
210 CEPH_OSD_OP_GETXATTRS
= CEPH_OSD_OP_MODE_RD
| CEPH_OSD_OP_TYPE_ATTR
| 2,
213 CEPH_OSD_OP_SETXATTR
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_ATTR
| 1,
214 CEPH_OSD_OP_SETXATTRS
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_ATTR
| 2,
215 CEPH_OSD_OP_RESETXATTRS
= CEPH_OSD_OP_MODE_WR
|CEPH_OSD_OP_TYPE_ATTR
| 3,
216 CEPH_OSD_OP_RMXATTR
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_ATTR
| 4,
219 CEPH_OSD_OP_PULL
= CEPH_OSD_OP_MODE_SUB
| 1,
220 CEPH_OSD_OP_PUSH
= CEPH_OSD_OP_MODE_SUB
| 2,
221 CEPH_OSD_OP_BALANCEREADS
= CEPH_OSD_OP_MODE_SUB
| 3,
222 CEPH_OSD_OP_UNBALANCEREADS
= CEPH_OSD_OP_MODE_SUB
| 4,
223 CEPH_OSD_OP_SCRUB
= CEPH_OSD_OP_MODE_SUB
| 5,
226 CEPH_OSD_OP_WRLOCK
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_LOCK
| 1,
227 CEPH_OSD_OP_WRUNLOCK
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_LOCK
| 2,
228 CEPH_OSD_OP_RDLOCK
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_LOCK
| 3,
229 CEPH_OSD_OP_RDUNLOCK
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_LOCK
| 4,
230 CEPH_OSD_OP_UPLOCK
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_LOCK
| 5,
231 CEPH_OSD_OP_DNLOCK
= CEPH_OSD_OP_MODE_WR
| CEPH_OSD_OP_TYPE_LOCK
| 6,
234 CEPH_OSD_OP_CALL
= CEPH_OSD_OP_MODE_RD
| CEPH_OSD_OP_TYPE_EXEC
| 1,
237 CEPH_OSD_OP_PGLS
= CEPH_OSD_OP_MODE_RD
| CEPH_OSD_OP_TYPE_PG
| 1,
240 static inline int ceph_osd_op_type_lock(int op
)
242 return (op
& CEPH_OSD_OP_TYPE
) == CEPH_OSD_OP_TYPE_LOCK
;
244 static inline int ceph_osd_op_type_data(int op
)
246 return (op
& CEPH_OSD_OP_TYPE
) == CEPH_OSD_OP_TYPE_DATA
;
248 static inline int ceph_osd_op_type_attr(int op
)
250 return (op
& CEPH_OSD_OP_TYPE
) == CEPH_OSD_OP_TYPE_ATTR
;
252 static inline int ceph_osd_op_type_exec(int op
)
254 return (op
& CEPH_OSD_OP_TYPE
) == CEPH_OSD_OP_TYPE_EXEC
;
256 static inline int ceph_osd_op_type_pg(int op
)
258 return (op
& CEPH_OSD_OP_TYPE
) == CEPH_OSD_OP_TYPE_PG
;
261 static inline int ceph_osd_op_mode_subop(int op
)
263 return (op
& CEPH_OSD_OP_MODE
) == CEPH_OSD_OP_MODE_SUB
;
265 static inline int ceph_osd_op_mode_read(int op
)
267 return (op
& CEPH_OSD_OP_MODE
) == CEPH_OSD_OP_MODE_RD
;
269 static inline int ceph_osd_op_mode_modify(int op
)
271 return (op
& CEPH_OSD_OP_MODE
) == CEPH_OSD_OP_MODE_WR
;
274 #define CEPH_OSD_TMAP_HDR 'h'
275 #define CEPH_OSD_TMAP_SET 's'
276 #define CEPH_OSD_TMAP_RM 'r'
278 extern const char *ceph_osd_op_name(int op
);
284 * An op may be READ, WRITE, or READ|WRITE.
287 CEPH_OSD_FLAG_ACK
= 1, /* want (or is) "ack" ack */
288 CEPH_OSD_FLAG_ONNVRAM
= 2, /* want (or is) "onnvram" ack */
289 CEPH_OSD_FLAG_ONDISK
= 4, /* want (or is) "ondisk" ack */
290 CEPH_OSD_FLAG_RETRY
= 8, /* resend attempt */
291 CEPH_OSD_FLAG_READ
= 16, /* op may read */
292 CEPH_OSD_FLAG_WRITE
= 32, /* op may write */
293 CEPH_OSD_FLAG_ORDERSNAP
= 64, /* EOLDSNAP if snapc is out of order */
294 CEPH_OSD_FLAG_PEERSTAT
= 128, /* msg includes osd_peer_stat */
295 CEPH_OSD_FLAG_BALANCE_READS
= 256,
296 CEPH_OSD_FLAG_PARALLELEXEC
= 512, /* execute op in parallel */
297 CEPH_OSD_FLAG_PGOP
= 1024, /* pg op, no object */
298 CEPH_OSD_FLAG_EXEC
= 2048, /* op may exec */
302 CEPH_OSD_OP_FLAG_EXCL
= 1, /* EXCL object create */
305 #define EOLDSNAPC ERESTART /* ORDERSNAP flag set; writer has old snapc*/
306 #define EBLACKLISTED ESHUTDOWN /* blacklisted */
309 * an individual object operation. each may be accompanied by some data
313 __le16 op
; /* CEPH_OSD_OP_* */
314 __le32 flags
; /* CEPH_OSD_FLAG_* */
317 __le64 offset
, length
;
318 __le64 truncate_size
;
320 } __attribute__ ((packed
)) extent
;
324 } __attribute__ ((packed
)) xattr
;
330 } __attribute__ ((packed
)) cls
;
332 __le64 cookie
, count
;
333 } __attribute__ ((packed
)) pgls
;
336 } __attribute__ ((packed
));
339 * osd request message header. each request may include multiple
340 * ceph_osd_op object operations.
342 struct ceph_osd_request_head
{
343 __le32 client_inc
; /* client incarnation */
344 struct ceph_object_layout layout
; /* pgid */
345 __le32 osdmap_epoch
; /* client's osdmap epoch */
349 struct ceph_timespec mtime
; /* for mutations only */
350 struct ceph_eversion reassert_version
; /* if we are replaying op */
352 __le32 object_len
; /* length of object name */
354 __le64 snapid
; /* snapid to read */
355 __le64 snap_seq
; /* writer's snap context */
359 struct ceph_osd_op ops
[]; /* followed by ops[], obj, ticket, snaps */
360 } __attribute__ ((packed
));
362 struct ceph_osd_reply_head
{
363 __le32 client_inc
; /* client incarnation */
365 struct ceph_object_layout layout
;
367 struct ceph_eversion reassert_version
; /* for replaying uncommitted */
369 __le32 result
; /* result code */
371 __le32 object_len
; /* length of object name */
373 struct ceph_osd_op ops
[0]; /* ops[], object */
374 } __attribute__ ((packed
));