1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef CEPH_RADOS_H
3*4882a593Smuzhiyun #define CEPH_RADOS_H
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun /*
6*4882a593Smuzhiyun * Data types for the Ceph distributed object storage layer RADOS
7*4882a593Smuzhiyun * (Reliable Autonomic Distributed Object Store).
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <linux/ceph/msgr.h>
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun /*
13*4882a593Smuzhiyun * fs id
14*4882a593Smuzhiyun */
15*4882a593Smuzhiyun struct ceph_fsid {
16*4882a593Smuzhiyun unsigned char fsid[16];
17*4882a593Smuzhiyun };
18*4882a593Smuzhiyun
ceph_fsid_compare(const struct ceph_fsid * a,const struct ceph_fsid * b)19*4882a593Smuzhiyun static inline int ceph_fsid_compare(const struct ceph_fsid *a,
20*4882a593Smuzhiyun const struct ceph_fsid *b)
21*4882a593Smuzhiyun {
22*4882a593Smuzhiyun return memcmp(a, b, sizeof(*a));
23*4882a593Smuzhiyun }
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun /*
26*4882a593Smuzhiyun * ino, object, etc.
27*4882a593Smuzhiyun */
28*4882a593Smuzhiyun typedef __le64 ceph_snapid_t;
29*4882a593Smuzhiyun #define CEPH_SNAPDIR ((__u64)(-1)) /* reserved for hidden .snap dir */
30*4882a593Smuzhiyun #define CEPH_NOSNAP ((__u64)(-2)) /* "head", "live" revision */
31*4882a593Smuzhiyun #define CEPH_MAXSNAP ((__u64)(-3)) /* largest valid snapid */
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun struct ceph_timespec {
34*4882a593Smuzhiyun __le32 tv_sec;
35*4882a593Smuzhiyun __le32 tv_nsec;
36*4882a593Smuzhiyun } __attribute__ ((packed));
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun /*
40*4882a593Smuzhiyun * object layout - how objects are mapped into PGs
41*4882a593Smuzhiyun */
42*4882a593Smuzhiyun #define CEPH_OBJECT_LAYOUT_HASH 1
43*4882a593Smuzhiyun #define CEPH_OBJECT_LAYOUT_LINEAR 2
44*4882a593Smuzhiyun #define CEPH_OBJECT_LAYOUT_HASHINO 3
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun /*
47*4882a593Smuzhiyun * pg layout -- how PGs are mapped onto (sets of) OSDs
48*4882a593Smuzhiyun */
49*4882a593Smuzhiyun #define CEPH_PG_LAYOUT_CRUSH 0
50*4882a593Smuzhiyun #define CEPH_PG_LAYOUT_HASH 1
51*4882a593Smuzhiyun #define CEPH_PG_LAYOUT_LINEAR 2
52*4882a593Smuzhiyun #define CEPH_PG_LAYOUT_HYBRID 3
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun #define CEPH_PG_MAX_SIZE 32 /* max # osds in a single pg */
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun /*
57*4882a593Smuzhiyun * placement group.
58*4882a593Smuzhiyun * we encode this into one __le64.
59*4882a593Smuzhiyun */
60*4882a593Smuzhiyun struct ceph_pg_v1 {
61*4882a593Smuzhiyun __le16 preferred; /* preferred primary osd */
62*4882a593Smuzhiyun __le16 ps; /* placement seed */
63*4882a593Smuzhiyun __le32 pool; /* object pool */
64*4882a593Smuzhiyun } __attribute__ ((packed));
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun /*
67*4882a593Smuzhiyun * pg_pool is a set of pgs storing a pool of objects
68*4882a593Smuzhiyun *
69*4882a593Smuzhiyun * pg_num -- base number of pseudorandomly placed pgs
70*4882a593Smuzhiyun *
71*4882a593Smuzhiyun * pgp_num -- effective number when calculating pg placement. this
72*4882a593Smuzhiyun * is used for pg_num increases. new pgs result in data being "split"
73*4882a593Smuzhiyun * into new pgs. for this to proceed smoothly, new pgs are intiially
74*4882a593Smuzhiyun * colocated with their parents; that is, pgp_num doesn't increase
75*4882a593Smuzhiyun * until the new pgs have successfully split. only _then_ are the new
76*4882a593Smuzhiyun * pgs placed independently.
77*4882a593Smuzhiyun *
78*4882a593Smuzhiyun * lpg_num -- localized pg count (per device). replicas are randomly
79*4882a593Smuzhiyun * selected.
80*4882a593Smuzhiyun *
81*4882a593Smuzhiyun * lpgp_num -- as above.
82*4882a593Smuzhiyun */
83*4882a593Smuzhiyun #define CEPH_NOPOOL ((__u64) (-1)) /* pool id not defined */
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun #define CEPH_POOL_TYPE_REP 1
86*4882a593Smuzhiyun #define CEPH_POOL_TYPE_RAID4 2 /* never implemented */
87*4882a593Smuzhiyun #define CEPH_POOL_TYPE_EC 3
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun /*
90*4882a593Smuzhiyun * stable_mod func is used to control number of placement groups.
91*4882a593Smuzhiyun * similar to straight-up modulo, but produces a stable mapping as b
92*4882a593Smuzhiyun * increases over time. b is the number of bins, and bmask is the
93*4882a593Smuzhiyun * containing power of 2 minus 1.
94*4882a593Smuzhiyun *
95*4882a593Smuzhiyun * b <= bmask and bmask=(2**n)-1
96*4882a593Smuzhiyun * e.g., b=12 -> bmask=15, b=123 -> bmask=127
97*4882a593Smuzhiyun */
ceph_stable_mod(int x,int b,int bmask)98*4882a593Smuzhiyun static inline int ceph_stable_mod(int x, int b, int bmask)
99*4882a593Smuzhiyun {
100*4882a593Smuzhiyun if ((x & bmask) < b)
101*4882a593Smuzhiyun return x & bmask;
102*4882a593Smuzhiyun else
103*4882a593Smuzhiyun return x & (bmask >> 1);
104*4882a593Smuzhiyun }
105*4882a593Smuzhiyun
106*4882a593Smuzhiyun /*
107*4882a593Smuzhiyun * object layout - how a given object should be stored.
108*4882a593Smuzhiyun */
109*4882a593Smuzhiyun struct ceph_object_layout {
110*4882a593Smuzhiyun struct ceph_pg_v1 ol_pgid; /* raw pg, with _full_ ps precision. */
111*4882a593Smuzhiyun __le32 ol_stripe_unit; /* for per-object parity, if any */
112*4882a593Smuzhiyun } __attribute__ ((packed));
113*4882a593Smuzhiyun
114*4882a593Smuzhiyun /*
115*4882a593Smuzhiyun * compound epoch+version, used by storage layer to serialize mutations
116*4882a593Smuzhiyun */
117*4882a593Smuzhiyun struct ceph_eversion {
118*4882a593Smuzhiyun __le64 version;
119*4882a593Smuzhiyun __le32 epoch;
120*4882a593Smuzhiyun } __attribute__ ((packed));
121*4882a593Smuzhiyun
122*4882a593Smuzhiyun /*
123*4882a593Smuzhiyun * osd map bits
124*4882a593Smuzhiyun */
125*4882a593Smuzhiyun
126*4882a593Smuzhiyun /* status bits */
127*4882a593Smuzhiyun #define CEPH_OSD_EXISTS (1<<0)
128*4882a593Smuzhiyun #define CEPH_OSD_UP (1<<1)
129*4882a593Smuzhiyun #define CEPH_OSD_AUTOOUT (1<<2) /* osd was automatically marked out */
130*4882a593Smuzhiyun #define CEPH_OSD_NEW (1<<3) /* osd is new, never marked in */
131*4882a593Smuzhiyun
132*4882a593Smuzhiyun extern const char *ceph_osd_state_name(int s);
133*4882a593Smuzhiyun
134*4882a593Smuzhiyun /* osd weights. fixed point value: 0x10000 == 1.0 ("in"), 0 == "out" */
135*4882a593Smuzhiyun #define CEPH_OSD_IN 0x10000
136*4882a593Smuzhiyun #define CEPH_OSD_OUT 0
137*4882a593Smuzhiyun
138*4882a593Smuzhiyun /* osd primary-affinity. fixed point value: 0x10000 == baseline */
139*4882a593Smuzhiyun #define CEPH_OSD_MAX_PRIMARY_AFFINITY 0x10000
140*4882a593Smuzhiyun #define CEPH_OSD_DEFAULT_PRIMARY_AFFINITY 0x10000
141*4882a593Smuzhiyun
142*4882a593Smuzhiyun
143*4882a593Smuzhiyun /*
144*4882a593Smuzhiyun * osd map flag bits
145*4882a593Smuzhiyun */
146*4882a593Smuzhiyun #define CEPH_OSDMAP_NEARFULL (1<<0) /* sync writes (near ENOSPC),
147*4882a593Smuzhiyun not set since ~luminous */
148*4882a593Smuzhiyun #define CEPH_OSDMAP_FULL (1<<1) /* no data writes (ENOSPC),
149*4882a593Smuzhiyun not set since ~luminous */
150*4882a593Smuzhiyun #define CEPH_OSDMAP_PAUSERD (1<<2) /* pause all reads */
151*4882a593Smuzhiyun #define CEPH_OSDMAP_PAUSEWR (1<<3) /* pause all writes */
152*4882a593Smuzhiyun #define CEPH_OSDMAP_PAUSEREC (1<<4) /* pause recovery */
153*4882a593Smuzhiyun #define CEPH_OSDMAP_NOUP (1<<5) /* block osd boot */
154*4882a593Smuzhiyun #define CEPH_OSDMAP_NODOWN (1<<6) /* block osd mark-down/failure */
155*4882a593Smuzhiyun #define CEPH_OSDMAP_NOOUT (1<<7) /* block osd auto mark-out */
156*4882a593Smuzhiyun #define CEPH_OSDMAP_NOIN (1<<8) /* block osd auto mark-in */
157*4882a593Smuzhiyun #define CEPH_OSDMAP_NOBACKFILL (1<<9) /* block osd backfill */
158*4882a593Smuzhiyun #define CEPH_OSDMAP_NORECOVER (1<<10) /* block osd recovery and backfill */
159*4882a593Smuzhiyun #define CEPH_OSDMAP_NOSCRUB (1<<11) /* block periodic scrub */
160*4882a593Smuzhiyun #define CEPH_OSDMAP_NODEEP_SCRUB (1<<12) /* block periodic deep-scrub */
161*4882a593Smuzhiyun #define CEPH_OSDMAP_NOTIERAGENT (1<<13) /* disable tiering agent */
162*4882a593Smuzhiyun #define CEPH_OSDMAP_NOREBALANCE (1<<14) /* block osd backfill unless pg is degraded */
163*4882a593Smuzhiyun #define CEPH_OSDMAP_SORTBITWISE (1<<15) /* use bitwise hobject_t sort */
164*4882a593Smuzhiyun #define CEPH_OSDMAP_REQUIRE_JEWEL (1<<16) /* require jewel for booting osds */
165*4882a593Smuzhiyun #define CEPH_OSDMAP_REQUIRE_KRAKEN (1<<17) /* require kraken for booting osds */
166*4882a593Smuzhiyun #define CEPH_OSDMAP_REQUIRE_LUMINOUS (1<<18) /* require l for booting osds */
167*4882a593Smuzhiyun #define CEPH_OSDMAP_RECOVERY_DELETES (1<<19) /* deletes performed during recovery instead of peering */
168*4882a593Smuzhiyun
169*4882a593Smuzhiyun /*
170*4882a593Smuzhiyun * The error code to return when an OSD can't handle a write
171*4882a593Smuzhiyun * because it is too large.
172*4882a593Smuzhiyun */
173*4882a593Smuzhiyun #define OSD_WRITETOOBIG EMSGSIZE
174*4882a593Smuzhiyun
175*4882a593Smuzhiyun /*
176*4882a593Smuzhiyun * osd ops
177*4882a593Smuzhiyun *
178*4882a593Smuzhiyun * WARNING: do not use these op codes directly. Use the helpers
179*4882a593Smuzhiyun * defined below instead. In certain cases, op code behavior was
180*4882a593Smuzhiyun * redefined, resulting in special-cases in the helpers.
181*4882a593Smuzhiyun */
182*4882a593Smuzhiyun #define CEPH_OSD_OP_MODE 0xf000
183*4882a593Smuzhiyun #define CEPH_OSD_OP_MODE_RD 0x1000
184*4882a593Smuzhiyun #define CEPH_OSD_OP_MODE_WR 0x2000
185*4882a593Smuzhiyun #define CEPH_OSD_OP_MODE_RMW 0x3000
186*4882a593Smuzhiyun #define CEPH_OSD_OP_MODE_SUB 0x4000
187*4882a593Smuzhiyun #define CEPH_OSD_OP_MODE_CACHE 0x8000
188*4882a593Smuzhiyun
189*4882a593Smuzhiyun #define CEPH_OSD_OP_TYPE 0x0f00
190*4882a593Smuzhiyun #define CEPH_OSD_OP_TYPE_LOCK 0x0100
191*4882a593Smuzhiyun #define CEPH_OSD_OP_TYPE_DATA 0x0200
192*4882a593Smuzhiyun #define CEPH_OSD_OP_TYPE_ATTR 0x0300
193*4882a593Smuzhiyun #define CEPH_OSD_OP_TYPE_EXEC 0x0400
194*4882a593Smuzhiyun #define CEPH_OSD_OP_TYPE_PG 0x0500
195*4882a593Smuzhiyun #define CEPH_OSD_OP_TYPE_MULTI 0x0600 /* multiobject */
196*4882a593Smuzhiyun
197*4882a593Smuzhiyun #define __CEPH_OSD_OP1(mode, nr) \
198*4882a593Smuzhiyun (CEPH_OSD_OP_MODE_##mode | (nr))
199*4882a593Smuzhiyun
200*4882a593Smuzhiyun #define __CEPH_OSD_OP(mode, type, nr) \
201*4882a593Smuzhiyun (CEPH_OSD_OP_MODE_##mode | CEPH_OSD_OP_TYPE_##type | (nr))
202*4882a593Smuzhiyun
203*4882a593Smuzhiyun #define __CEPH_FORALL_OSD_OPS(f) \
204*4882a593Smuzhiyun /** data **/ \
205*4882a593Smuzhiyun /* read */ \
206*4882a593Smuzhiyun f(READ, __CEPH_OSD_OP(RD, DATA, 1), "read") \
207*4882a593Smuzhiyun f(STAT, __CEPH_OSD_OP(RD, DATA, 2), "stat") \
208*4882a593Smuzhiyun f(MAPEXT, __CEPH_OSD_OP(RD, DATA, 3), "mapext") \
209*4882a593Smuzhiyun \
210*4882a593Smuzhiyun /* fancy read */ \
211*4882a593Smuzhiyun f(MASKTRUNC, __CEPH_OSD_OP(RD, DATA, 4), "masktrunc") \
212*4882a593Smuzhiyun f(SPARSE_READ, __CEPH_OSD_OP(RD, DATA, 5), "sparse-read") \
213*4882a593Smuzhiyun \
214*4882a593Smuzhiyun f(NOTIFY, __CEPH_OSD_OP(RD, DATA, 6), "notify") \
215*4882a593Smuzhiyun f(NOTIFY_ACK, __CEPH_OSD_OP(RD, DATA, 7), "notify-ack") \
216*4882a593Smuzhiyun \
217*4882a593Smuzhiyun /* versioning */ \
218*4882a593Smuzhiyun f(ASSERT_VER, __CEPH_OSD_OP(RD, DATA, 8), "assert-version") \
219*4882a593Smuzhiyun \
220*4882a593Smuzhiyun f(LIST_WATCHERS, __CEPH_OSD_OP(RD, DATA, 9), "list-watchers") \
221*4882a593Smuzhiyun \
222*4882a593Smuzhiyun f(LIST_SNAPS, __CEPH_OSD_OP(RD, DATA, 10), "list-snaps") \
223*4882a593Smuzhiyun \
224*4882a593Smuzhiyun /* sync */ \
225*4882a593Smuzhiyun f(SYNC_READ, __CEPH_OSD_OP(RD, DATA, 11), "sync_read") \
226*4882a593Smuzhiyun \
227*4882a593Smuzhiyun /* write */ \
228*4882a593Smuzhiyun f(WRITE, __CEPH_OSD_OP(WR, DATA, 1), "write") \
229*4882a593Smuzhiyun f(WRITEFULL, __CEPH_OSD_OP(WR, DATA, 2), "writefull") \
230*4882a593Smuzhiyun f(TRUNCATE, __CEPH_OSD_OP(WR, DATA, 3), "truncate") \
231*4882a593Smuzhiyun f(ZERO, __CEPH_OSD_OP(WR, DATA, 4), "zero") \
232*4882a593Smuzhiyun f(DELETE, __CEPH_OSD_OP(WR, DATA, 5), "delete") \
233*4882a593Smuzhiyun \
234*4882a593Smuzhiyun /* fancy write */ \
235*4882a593Smuzhiyun f(APPEND, __CEPH_OSD_OP(WR, DATA, 6), "append") \
236*4882a593Smuzhiyun f(SETTRUNC, __CEPH_OSD_OP(WR, DATA, 8), "settrunc") \
237*4882a593Smuzhiyun f(TRIMTRUNC, __CEPH_OSD_OP(WR, DATA, 9), "trimtrunc") \
238*4882a593Smuzhiyun \
239*4882a593Smuzhiyun f(TMAPUP, __CEPH_OSD_OP(RMW, DATA, 10), "tmapup") \
240*4882a593Smuzhiyun f(TMAPPUT, __CEPH_OSD_OP(WR, DATA, 11), "tmapput") \
241*4882a593Smuzhiyun f(TMAPGET, __CEPH_OSD_OP(RD, DATA, 12), "tmapget") \
242*4882a593Smuzhiyun \
243*4882a593Smuzhiyun f(CREATE, __CEPH_OSD_OP(WR, DATA, 13), "create") \
244*4882a593Smuzhiyun f(ROLLBACK, __CEPH_OSD_OP(WR, DATA, 14), "rollback") \
245*4882a593Smuzhiyun \
246*4882a593Smuzhiyun f(WATCH, __CEPH_OSD_OP(WR, DATA, 15), "watch") \
247*4882a593Smuzhiyun \
248*4882a593Smuzhiyun /* omap */ \
249*4882a593Smuzhiyun f(OMAPGETKEYS, __CEPH_OSD_OP(RD, DATA, 17), "omap-get-keys") \
250*4882a593Smuzhiyun f(OMAPGETVALS, __CEPH_OSD_OP(RD, DATA, 18), "omap-get-vals") \
251*4882a593Smuzhiyun f(OMAPGETHEADER, __CEPH_OSD_OP(RD, DATA, 19), "omap-get-header") \
252*4882a593Smuzhiyun f(OMAPGETVALSBYKEYS, __CEPH_OSD_OP(RD, DATA, 20), "omap-get-vals-by-keys") \
253*4882a593Smuzhiyun f(OMAPSETVALS, __CEPH_OSD_OP(WR, DATA, 21), "omap-set-vals") \
254*4882a593Smuzhiyun f(OMAPSETHEADER, __CEPH_OSD_OP(WR, DATA, 22), "omap-set-header") \
255*4882a593Smuzhiyun f(OMAPCLEAR, __CEPH_OSD_OP(WR, DATA, 23), "omap-clear") \
256*4882a593Smuzhiyun f(OMAPRMKEYS, __CEPH_OSD_OP(WR, DATA, 24), "omap-rm-keys") \
257*4882a593Smuzhiyun f(OMAP_CMP, __CEPH_OSD_OP(RD, DATA, 25), "omap-cmp") \
258*4882a593Smuzhiyun \
259*4882a593Smuzhiyun /* tiering */ \
260*4882a593Smuzhiyun f(COPY_FROM, __CEPH_OSD_OP(WR, DATA, 26), "copy-from") \
261*4882a593Smuzhiyun f(COPY_FROM2, __CEPH_OSD_OP(WR, DATA, 45), "copy-from2") \
262*4882a593Smuzhiyun f(COPY_GET_CLASSIC, __CEPH_OSD_OP(RD, DATA, 27), "copy-get-classic") \
263*4882a593Smuzhiyun f(UNDIRTY, __CEPH_OSD_OP(WR, DATA, 28), "undirty") \
264*4882a593Smuzhiyun f(ISDIRTY, __CEPH_OSD_OP(RD, DATA, 29), "isdirty") \
265*4882a593Smuzhiyun f(COPY_GET, __CEPH_OSD_OP(RD, DATA, 30), "copy-get") \
266*4882a593Smuzhiyun f(CACHE_FLUSH, __CEPH_OSD_OP(CACHE, DATA, 31), "cache-flush") \
267*4882a593Smuzhiyun f(CACHE_EVICT, __CEPH_OSD_OP(CACHE, DATA, 32), "cache-evict") \
268*4882a593Smuzhiyun f(CACHE_TRY_FLUSH, __CEPH_OSD_OP(CACHE, DATA, 33), "cache-try-flush") \
269*4882a593Smuzhiyun \
270*4882a593Smuzhiyun /* convert tmap to omap */ \
271*4882a593Smuzhiyun f(TMAP2OMAP, __CEPH_OSD_OP(RMW, DATA, 34), "tmap2omap") \
272*4882a593Smuzhiyun \
273*4882a593Smuzhiyun /* hints */ \
274*4882a593Smuzhiyun f(SETALLOCHINT, __CEPH_OSD_OP(WR, DATA, 35), "set-alloc-hint") \
275*4882a593Smuzhiyun \
276*4882a593Smuzhiyun /** multi **/ \
277*4882a593Smuzhiyun f(CLONERANGE, __CEPH_OSD_OP(WR, MULTI, 1), "clonerange") \
278*4882a593Smuzhiyun f(ASSERT_SRC_VERSION, __CEPH_OSD_OP(RD, MULTI, 2), "assert-src-version") \
279*4882a593Smuzhiyun f(SRC_CMPXATTR, __CEPH_OSD_OP(RD, MULTI, 3), "src-cmpxattr") \
280*4882a593Smuzhiyun \
281*4882a593Smuzhiyun /** attrs **/ \
282*4882a593Smuzhiyun /* read */ \
283*4882a593Smuzhiyun f(GETXATTR, __CEPH_OSD_OP(RD, ATTR, 1), "getxattr") \
284*4882a593Smuzhiyun f(GETXATTRS, __CEPH_OSD_OP(RD, ATTR, 2), "getxattrs") \
285*4882a593Smuzhiyun f(CMPXATTR, __CEPH_OSD_OP(RD, ATTR, 3), "cmpxattr") \
286*4882a593Smuzhiyun \
287*4882a593Smuzhiyun /* write */ \
288*4882a593Smuzhiyun f(SETXATTR, __CEPH_OSD_OP(WR, ATTR, 1), "setxattr") \
289*4882a593Smuzhiyun f(SETXATTRS, __CEPH_OSD_OP(WR, ATTR, 2), "setxattrs") \
290*4882a593Smuzhiyun f(RESETXATTRS, __CEPH_OSD_OP(WR, ATTR, 3), "resetxattrs") \
291*4882a593Smuzhiyun f(RMXATTR, __CEPH_OSD_OP(WR, ATTR, 4), "rmxattr") \
292*4882a593Smuzhiyun \
293*4882a593Smuzhiyun /** subop **/ \
294*4882a593Smuzhiyun f(PULL, __CEPH_OSD_OP1(SUB, 1), "pull") \
295*4882a593Smuzhiyun f(PUSH, __CEPH_OSD_OP1(SUB, 2), "push") \
296*4882a593Smuzhiyun f(BALANCEREADS, __CEPH_OSD_OP1(SUB, 3), "balance-reads") \
297*4882a593Smuzhiyun f(UNBALANCEREADS, __CEPH_OSD_OP1(SUB, 4), "unbalance-reads") \
298*4882a593Smuzhiyun f(SCRUB, __CEPH_OSD_OP1(SUB, 5), "scrub") \
299*4882a593Smuzhiyun f(SCRUB_RESERVE, __CEPH_OSD_OP1(SUB, 6), "scrub-reserve") \
300*4882a593Smuzhiyun f(SCRUB_UNRESERVE, __CEPH_OSD_OP1(SUB, 7), "scrub-unreserve") \
301*4882a593Smuzhiyun f(SCRUB_STOP, __CEPH_OSD_OP1(SUB, 8), "scrub-stop") \
302*4882a593Smuzhiyun f(SCRUB_MAP, __CEPH_OSD_OP1(SUB, 9), "scrub-map") \
303*4882a593Smuzhiyun \
304*4882a593Smuzhiyun /** lock **/ \
305*4882a593Smuzhiyun f(WRLOCK, __CEPH_OSD_OP(WR, LOCK, 1), "wrlock") \
306*4882a593Smuzhiyun f(WRUNLOCK, __CEPH_OSD_OP(WR, LOCK, 2), "wrunlock") \
307*4882a593Smuzhiyun f(RDLOCK, __CEPH_OSD_OP(WR, LOCK, 3), "rdlock") \
308*4882a593Smuzhiyun f(RDUNLOCK, __CEPH_OSD_OP(WR, LOCK, 4), "rdunlock") \
309*4882a593Smuzhiyun f(UPLOCK, __CEPH_OSD_OP(WR, LOCK, 5), "uplock") \
310*4882a593Smuzhiyun f(DNLOCK, __CEPH_OSD_OP(WR, LOCK, 6), "dnlock") \
311*4882a593Smuzhiyun \
312*4882a593Smuzhiyun /** exec **/ \
313*4882a593Smuzhiyun /* note: the RD bit here is wrong; see special-case below in helper */ \
314*4882a593Smuzhiyun f(CALL, __CEPH_OSD_OP(RD, EXEC, 1), "call") \
315*4882a593Smuzhiyun \
316*4882a593Smuzhiyun /** pg **/ \
317*4882a593Smuzhiyun f(PGLS, __CEPH_OSD_OP(RD, PG, 1), "pgls") \
318*4882a593Smuzhiyun f(PGLS_FILTER, __CEPH_OSD_OP(RD, PG, 2), "pgls-filter") \
319*4882a593Smuzhiyun f(PG_HITSET_LS, __CEPH_OSD_OP(RD, PG, 3), "pg-hitset-ls") \
320*4882a593Smuzhiyun f(PG_HITSET_GET, __CEPH_OSD_OP(RD, PG, 4), "pg-hitset-get")
321*4882a593Smuzhiyun
322*4882a593Smuzhiyun enum {
323*4882a593Smuzhiyun #define GENERATE_ENUM_ENTRY(op, opcode, str) CEPH_OSD_OP_##op = (opcode),
324*4882a593Smuzhiyun __CEPH_FORALL_OSD_OPS(GENERATE_ENUM_ENTRY)
325*4882a593Smuzhiyun #undef GENERATE_ENUM_ENTRY
326*4882a593Smuzhiyun };
327*4882a593Smuzhiyun
ceph_osd_op_type_lock(int op)328*4882a593Smuzhiyun static inline int ceph_osd_op_type_lock(int op)
329*4882a593Smuzhiyun {
330*4882a593Smuzhiyun return (op & CEPH_OSD_OP_TYPE) == CEPH_OSD_OP_TYPE_LOCK;
331*4882a593Smuzhiyun }
ceph_osd_op_type_data(int op)332*4882a593Smuzhiyun static inline int ceph_osd_op_type_data(int op)
333*4882a593Smuzhiyun {
334*4882a593Smuzhiyun return (op & CEPH_OSD_OP_TYPE) == CEPH_OSD_OP_TYPE_DATA;
335*4882a593Smuzhiyun }
ceph_osd_op_type_attr(int op)336*4882a593Smuzhiyun static inline int ceph_osd_op_type_attr(int op)
337*4882a593Smuzhiyun {
338*4882a593Smuzhiyun return (op & CEPH_OSD_OP_TYPE) == CEPH_OSD_OP_TYPE_ATTR;
339*4882a593Smuzhiyun }
ceph_osd_op_type_exec(int op)340*4882a593Smuzhiyun static inline int ceph_osd_op_type_exec(int op)
341*4882a593Smuzhiyun {
342*4882a593Smuzhiyun return (op & CEPH_OSD_OP_TYPE) == CEPH_OSD_OP_TYPE_EXEC;
343*4882a593Smuzhiyun }
ceph_osd_op_type_pg(int op)344*4882a593Smuzhiyun static inline int ceph_osd_op_type_pg(int op)
345*4882a593Smuzhiyun {
346*4882a593Smuzhiyun return (op & CEPH_OSD_OP_TYPE) == CEPH_OSD_OP_TYPE_PG;
347*4882a593Smuzhiyun }
ceph_osd_op_type_multi(int op)348*4882a593Smuzhiyun static inline int ceph_osd_op_type_multi(int op)
349*4882a593Smuzhiyun {
350*4882a593Smuzhiyun return (op & CEPH_OSD_OP_TYPE) == CEPH_OSD_OP_TYPE_MULTI;
351*4882a593Smuzhiyun }
352*4882a593Smuzhiyun
ceph_osd_op_mode_subop(int op)353*4882a593Smuzhiyun static inline int ceph_osd_op_mode_subop(int op)
354*4882a593Smuzhiyun {
355*4882a593Smuzhiyun return (op & CEPH_OSD_OP_MODE) == CEPH_OSD_OP_MODE_SUB;
356*4882a593Smuzhiyun }
ceph_osd_op_mode_read(int op)357*4882a593Smuzhiyun static inline int ceph_osd_op_mode_read(int op)
358*4882a593Smuzhiyun {
359*4882a593Smuzhiyun return (op & CEPH_OSD_OP_MODE_RD) &&
360*4882a593Smuzhiyun op != CEPH_OSD_OP_CALL;
361*4882a593Smuzhiyun }
ceph_osd_op_mode_modify(int op)362*4882a593Smuzhiyun static inline int ceph_osd_op_mode_modify(int op)
363*4882a593Smuzhiyun {
364*4882a593Smuzhiyun return op & CEPH_OSD_OP_MODE_WR;
365*4882a593Smuzhiyun }
366*4882a593Smuzhiyun
367*4882a593Smuzhiyun /*
368*4882a593Smuzhiyun * note that the following tmap stuff is also defined in the ceph librados.h
369*4882a593Smuzhiyun * any modification here needs to be updated there
370*4882a593Smuzhiyun */
371*4882a593Smuzhiyun #define CEPH_OSD_TMAP_HDR 'h'
372*4882a593Smuzhiyun #define CEPH_OSD_TMAP_SET 's'
373*4882a593Smuzhiyun #define CEPH_OSD_TMAP_CREATE 'c' /* create key */
374*4882a593Smuzhiyun #define CEPH_OSD_TMAP_RM 'r'
375*4882a593Smuzhiyun #define CEPH_OSD_TMAP_RMSLOPPY 'R'
376*4882a593Smuzhiyun
377*4882a593Smuzhiyun extern const char *ceph_osd_op_name(int op);
378*4882a593Smuzhiyun
379*4882a593Smuzhiyun /*
380*4882a593Smuzhiyun * osd op flags
381*4882a593Smuzhiyun *
382*4882a593Smuzhiyun * An op may be READ, WRITE, or READ|WRITE.
383*4882a593Smuzhiyun */
384*4882a593Smuzhiyun enum {
385*4882a593Smuzhiyun CEPH_OSD_FLAG_ACK = 0x0001, /* want (or is) "ack" ack */
386*4882a593Smuzhiyun CEPH_OSD_FLAG_ONNVRAM = 0x0002, /* want (or is) "onnvram" ack */
387*4882a593Smuzhiyun CEPH_OSD_FLAG_ONDISK = 0x0004, /* want (or is) "ondisk" ack */
388*4882a593Smuzhiyun CEPH_OSD_FLAG_RETRY = 0x0008, /* resend attempt */
389*4882a593Smuzhiyun CEPH_OSD_FLAG_READ = 0x0010, /* op may read */
390*4882a593Smuzhiyun CEPH_OSD_FLAG_WRITE = 0x0020, /* op may write */
391*4882a593Smuzhiyun CEPH_OSD_FLAG_ORDERSNAP = 0x0040, /* EOLDSNAP if snapc is out of order */
392*4882a593Smuzhiyun CEPH_OSD_FLAG_PEERSTAT_OLD = 0x0080, /* DEPRECATED msg includes osd_peer_stat */
393*4882a593Smuzhiyun CEPH_OSD_FLAG_BALANCE_READS = 0x0100,
394*4882a593Smuzhiyun CEPH_OSD_FLAG_PARALLELEXEC = 0x0200, /* execute op in parallel */
395*4882a593Smuzhiyun CEPH_OSD_FLAG_PGOP = 0x0400, /* pg op, no object */
396*4882a593Smuzhiyun CEPH_OSD_FLAG_EXEC = 0x0800, /* op may exec */
397*4882a593Smuzhiyun CEPH_OSD_FLAG_EXEC_PUBLIC = 0x1000, /* DEPRECATED op may exec (public) */
398*4882a593Smuzhiyun CEPH_OSD_FLAG_LOCALIZE_READS = 0x2000, /* read from nearby replica, if any */
399*4882a593Smuzhiyun CEPH_OSD_FLAG_RWORDERED = 0x4000, /* order wrt concurrent reads */
400*4882a593Smuzhiyun CEPH_OSD_FLAG_IGNORE_CACHE = 0x8000, /* ignore cache logic */
401*4882a593Smuzhiyun CEPH_OSD_FLAG_SKIPRWLOCKS = 0x10000, /* skip rw locks */
402*4882a593Smuzhiyun CEPH_OSD_FLAG_IGNORE_OVERLAY = 0x20000, /* ignore pool overlay */
403*4882a593Smuzhiyun CEPH_OSD_FLAG_FLUSH = 0x40000, /* this is part of flush */
404*4882a593Smuzhiyun CEPH_OSD_FLAG_MAP_SNAP_CLONE = 0x80000, /* map snap direct to clone id */
405*4882a593Smuzhiyun CEPH_OSD_FLAG_ENFORCE_SNAPC = 0x100000, /* use snapc provided even if
406*4882a593Smuzhiyun pool uses pool snaps */
407*4882a593Smuzhiyun CEPH_OSD_FLAG_REDIRECTED = 0x200000, /* op has been redirected */
408*4882a593Smuzhiyun CEPH_OSD_FLAG_KNOWN_REDIR = 0x400000, /* redirect bit is authoritative */
409*4882a593Smuzhiyun CEPH_OSD_FLAG_FULL_TRY = 0x800000, /* try op despite full flag */
410*4882a593Smuzhiyun CEPH_OSD_FLAG_FULL_FORCE = 0x1000000, /* force op despite full flag */
411*4882a593Smuzhiyun };
412*4882a593Smuzhiyun
413*4882a593Smuzhiyun enum {
414*4882a593Smuzhiyun CEPH_OSD_OP_FLAG_EXCL = 1, /* EXCL object create */
415*4882a593Smuzhiyun CEPH_OSD_OP_FLAG_FAILOK = 2, /* continue despite failure */
416*4882a593Smuzhiyun CEPH_OSD_OP_FLAG_FADVISE_RANDOM = 0x4, /* the op is random */
417*4882a593Smuzhiyun CEPH_OSD_OP_FLAG_FADVISE_SEQUENTIAL = 0x8, /* the op is sequential */
418*4882a593Smuzhiyun CEPH_OSD_OP_FLAG_FADVISE_WILLNEED = 0x10,/* data will be accessed in
419*4882a593Smuzhiyun the near future */
420*4882a593Smuzhiyun CEPH_OSD_OP_FLAG_FADVISE_DONTNEED = 0x20,/* data will not be accessed
421*4882a593Smuzhiyun in the near future */
422*4882a593Smuzhiyun CEPH_OSD_OP_FLAG_FADVISE_NOCACHE = 0x40,/* data will be accessed only
423*4882a593Smuzhiyun once by this client */
424*4882a593Smuzhiyun };
425*4882a593Smuzhiyun
426*4882a593Smuzhiyun #define EOLDSNAPC ERESTART /* ORDERSNAP flag set; writer has old snapc*/
427*4882a593Smuzhiyun #define EBLOCKLISTED ESHUTDOWN /* blocklisted */
428*4882a593Smuzhiyun
429*4882a593Smuzhiyun /* xattr comparison */
430*4882a593Smuzhiyun enum {
431*4882a593Smuzhiyun CEPH_OSD_CMPXATTR_OP_NOP = 0,
432*4882a593Smuzhiyun CEPH_OSD_CMPXATTR_OP_EQ = 1,
433*4882a593Smuzhiyun CEPH_OSD_CMPXATTR_OP_NE = 2,
434*4882a593Smuzhiyun CEPH_OSD_CMPXATTR_OP_GT = 3,
435*4882a593Smuzhiyun CEPH_OSD_CMPXATTR_OP_GTE = 4,
436*4882a593Smuzhiyun CEPH_OSD_CMPXATTR_OP_LT = 5,
437*4882a593Smuzhiyun CEPH_OSD_CMPXATTR_OP_LTE = 6
438*4882a593Smuzhiyun };
439*4882a593Smuzhiyun
440*4882a593Smuzhiyun enum {
441*4882a593Smuzhiyun CEPH_OSD_CMPXATTR_MODE_STRING = 1,
442*4882a593Smuzhiyun CEPH_OSD_CMPXATTR_MODE_U64 = 2
443*4882a593Smuzhiyun };
444*4882a593Smuzhiyun
445*4882a593Smuzhiyun enum {
446*4882a593Smuzhiyun CEPH_OSD_COPY_FROM_FLAG_FLUSH = 1, /* part of a flush operation */
447*4882a593Smuzhiyun CEPH_OSD_COPY_FROM_FLAG_IGNORE_OVERLAY = 2, /* ignore pool overlay */
448*4882a593Smuzhiyun CEPH_OSD_COPY_FROM_FLAG_IGNORE_CACHE = 4, /* ignore osd cache logic */
449*4882a593Smuzhiyun CEPH_OSD_COPY_FROM_FLAG_MAP_SNAP_CLONE = 8, /* map snap direct to
450*4882a593Smuzhiyun * cloneid */
451*4882a593Smuzhiyun CEPH_OSD_COPY_FROM_FLAG_RWORDERED = 16, /* order with write */
452*4882a593Smuzhiyun CEPH_OSD_COPY_FROM_FLAG_TRUNCATE_SEQ = 32, /* send truncate_{seq,size} */
453*4882a593Smuzhiyun };
454*4882a593Smuzhiyun
455*4882a593Smuzhiyun enum {
456*4882a593Smuzhiyun CEPH_OSD_WATCH_OP_UNWATCH = 0,
457*4882a593Smuzhiyun CEPH_OSD_WATCH_OP_LEGACY_WATCH = 1,
458*4882a593Smuzhiyun /* note: use only ODD ids to prevent pre-giant code from
459*4882a593Smuzhiyun interpreting the op as UNWATCH */
460*4882a593Smuzhiyun CEPH_OSD_WATCH_OP_WATCH = 3,
461*4882a593Smuzhiyun CEPH_OSD_WATCH_OP_RECONNECT = 5,
462*4882a593Smuzhiyun CEPH_OSD_WATCH_OP_PING = 7,
463*4882a593Smuzhiyun };
464*4882a593Smuzhiyun
465*4882a593Smuzhiyun const char *ceph_osd_watch_op_name(int o);
466*4882a593Smuzhiyun
467*4882a593Smuzhiyun enum {
468*4882a593Smuzhiyun CEPH_OSD_ALLOC_HINT_FLAG_SEQUENTIAL_WRITE = 1,
469*4882a593Smuzhiyun CEPH_OSD_ALLOC_HINT_FLAG_RANDOM_WRITE = 2,
470*4882a593Smuzhiyun CEPH_OSD_ALLOC_HINT_FLAG_SEQUENTIAL_READ = 4,
471*4882a593Smuzhiyun CEPH_OSD_ALLOC_HINT_FLAG_RANDOM_READ = 8,
472*4882a593Smuzhiyun CEPH_OSD_ALLOC_HINT_FLAG_APPEND_ONLY = 16,
473*4882a593Smuzhiyun CEPH_OSD_ALLOC_HINT_FLAG_IMMUTABLE = 32,
474*4882a593Smuzhiyun CEPH_OSD_ALLOC_HINT_FLAG_SHORTLIVED = 64,
475*4882a593Smuzhiyun CEPH_OSD_ALLOC_HINT_FLAG_LONGLIVED = 128,
476*4882a593Smuzhiyun CEPH_OSD_ALLOC_HINT_FLAG_COMPRESSIBLE = 256,
477*4882a593Smuzhiyun CEPH_OSD_ALLOC_HINT_FLAG_INCOMPRESSIBLE = 512,
478*4882a593Smuzhiyun };
479*4882a593Smuzhiyun
480*4882a593Smuzhiyun enum {
481*4882a593Smuzhiyun CEPH_OSD_BACKOFF_OP_BLOCK = 1,
482*4882a593Smuzhiyun CEPH_OSD_BACKOFF_OP_ACK_BLOCK = 2,
483*4882a593Smuzhiyun CEPH_OSD_BACKOFF_OP_UNBLOCK = 3,
484*4882a593Smuzhiyun };
485*4882a593Smuzhiyun
486*4882a593Smuzhiyun /*
487*4882a593Smuzhiyun * an individual object operation. each may be accompanied by some data
488*4882a593Smuzhiyun * payload
489*4882a593Smuzhiyun */
490*4882a593Smuzhiyun struct ceph_osd_op {
491*4882a593Smuzhiyun __le16 op; /* CEPH_OSD_OP_* */
492*4882a593Smuzhiyun __le32 flags; /* CEPH_OSD_OP_FLAG_* */
493*4882a593Smuzhiyun union {
494*4882a593Smuzhiyun struct {
495*4882a593Smuzhiyun __le64 offset, length;
496*4882a593Smuzhiyun __le64 truncate_size;
497*4882a593Smuzhiyun __le32 truncate_seq;
498*4882a593Smuzhiyun } __attribute__ ((packed)) extent;
499*4882a593Smuzhiyun struct {
500*4882a593Smuzhiyun __le32 name_len;
501*4882a593Smuzhiyun __le32 value_len;
502*4882a593Smuzhiyun __u8 cmp_op; /* CEPH_OSD_CMPXATTR_OP_* */
503*4882a593Smuzhiyun __u8 cmp_mode; /* CEPH_OSD_CMPXATTR_MODE_* */
504*4882a593Smuzhiyun } __attribute__ ((packed)) xattr;
505*4882a593Smuzhiyun struct {
506*4882a593Smuzhiyun __u8 class_len;
507*4882a593Smuzhiyun __u8 method_len;
508*4882a593Smuzhiyun __u8 argc;
509*4882a593Smuzhiyun __le32 indata_len;
510*4882a593Smuzhiyun } __attribute__ ((packed)) cls;
511*4882a593Smuzhiyun struct {
512*4882a593Smuzhiyun __le64 cookie, count;
513*4882a593Smuzhiyun } __attribute__ ((packed)) pgls;
514*4882a593Smuzhiyun struct {
515*4882a593Smuzhiyun __le64 snapid;
516*4882a593Smuzhiyun } __attribute__ ((packed)) snap;
517*4882a593Smuzhiyun struct {
518*4882a593Smuzhiyun __le64 cookie;
519*4882a593Smuzhiyun __le64 ver; /* no longer used */
520*4882a593Smuzhiyun __u8 op; /* CEPH_OSD_WATCH_OP_* */
521*4882a593Smuzhiyun __le32 gen; /* registration generation */
522*4882a593Smuzhiyun } __attribute__ ((packed)) watch;
523*4882a593Smuzhiyun struct {
524*4882a593Smuzhiyun __le64 cookie;
525*4882a593Smuzhiyun } __attribute__ ((packed)) notify;
526*4882a593Smuzhiyun struct {
527*4882a593Smuzhiyun __le64 offset, length;
528*4882a593Smuzhiyun __le64 src_offset;
529*4882a593Smuzhiyun } __attribute__ ((packed)) clonerange;
530*4882a593Smuzhiyun struct {
531*4882a593Smuzhiyun __le64 expected_object_size;
532*4882a593Smuzhiyun __le64 expected_write_size;
533*4882a593Smuzhiyun __le32 flags; /* CEPH_OSD_OP_ALLOC_HINT_FLAG_* */
534*4882a593Smuzhiyun } __attribute__ ((packed)) alloc_hint;
535*4882a593Smuzhiyun struct {
536*4882a593Smuzhiyun __le64 snapid;
537*4882a593Smuzhiyun __le64 src_version;
538*4882a593Smuzhiyun __u8 flags; /* CEPH_OSD_COPY_FROM_FLAG_* */
539*4882a593Smuzhiyun /*
540*4882a593Smuzhiyun * CEPH_OSD_OP_FLAG_FADVISE_*: fadvise flags
541*4882a593Smuzhiyun * for src object, flags for dest object are in
542*4882a593Smuzhiyun * ceph_osd_op::flags.
543*4882a593Smuzhiyun */
544*4882a593Smuzhiyun __le32 src_fadvise_flags;
545*4882a593Smuzhiyun } __attribute__ ((packed)) copy_from;
546*4882a593Smuzhiyun };
547*4882a593Smuzhiyun __le32 payload_len;
548*4882a593Smuzhiyun } __attribute__ ((packed));
549*4882a593Smuzhiyun
550*4882a593Smuzhiyun
551*4882a593Smuzhiyun #endif
552