include/linux/ceph/osdmap.h

   1 #ifndef _FS_CEPH_OSDMAP_H
   2 #define _FS_CEPH_OSDMAP_H
   3
   4 #include <linux/rbtree.h>
   5 #include <linux/ceph/types.h>
   6 #include <linux/ceph/decode.h>
   7 #include <linux/ceph/ceph_fs.h>
   8 #include <linux/crush/crush.h>
   9
  10 /*
  11  * The osd map describes the current membership of the osd cluster and
  12  * specifies the mapping of objects to placement groups and placement
  13  * groups to (sets of) osds.  That is, it completely specifies the
  14  * (desired) distribution of all data objects in the system at some
  15  * point in time.
  16  *
  17  * Each map version is identified by an epoch, which increases monotonically.
  18  *
  19  * The map can be updated either via an incremental map (diff) describing
  20  * the change between two successive epochs, or as a fully encoded map.
  21  */
  22 struct ceph_pg {
  23         uint64_t pool;
  24         uint32_t seed;
  25 };
  26
  27 int ceph_pg_compare(const struct ceph_pg *lhs, const struct ceph_pg *rhs);
  28
  29 #define CEPH_POOL_FLAG_HASHPSPOOL       (1ULL << 0) /* hash pg seed and pool id
  30                                                        together */
  31
  32 struct ceph_pg_pool_info {
  33         struct rb_node node;
  34         s64 id;
  35         u8 type; /* CEPH_POOL_TYPE_* */
  36         u8 size;
  37         u8 min_size;
  38         u8 crush_ruleset;
  39         u8 object_hash;
  40         u32 last_force_request_resend;
  41         u32 pg_num, pgp_num;
  42         int pg_num_mask, pgp_num_mask;
  43         s64 read_tier;
  44         s64 write_tier; /* wins for read+write ops */
  45         u64 flags; /* CEPH_POOL_FLAG_* */
  46         char *name;
  47 };
  48
  49 static inline bool ceph_can_shift_osds(struct ceph_pg_pool_info *pool)
  50 {
  51         switch (pool->type) {
  52         case CEPH_POOL_TYPE_REP:
  53                 return true;
  54         case CEPH_POOL_TYPE_EC:
  55                 return false;
  56         default:
  57                 BUG_ON(1);
  58         }
  59 }
  60
  61 struct ceph_object_locator {
  62         s64 pool;
  63 };
  64
  65 /*
  66  * Maximum supported by kernel client object name length
  67  *
  68  * (probably outdated: must be >= RBD_MAX_MD_NAME_LEN -- currently 100)
  69  */
  70 #define CEPH_MAX_OID_NAME_LEN 100
  71
  72 /*
  73  * 51-char inline_name is long enough for all cephfs and all but one
  74  * rbd requests: <imgname> in "<imgname>.rbd"/"rbd_id.<imgname>" can be
  75  * arbitrarily long (~PAGE_SIZE).  It's done once during rbd map; all
  76  * other rbd requests fit into inline_name.
  77  *
  78  * Makes ceph_object_id 64 bytes on 64-bit.
  79  */
  80 #define CEPH_OID_INLINE_LEN 52
  81
  82 /*
  83  * Both inline and external buffers have space for a NUL-terminator,
  84  * which is carried around.  It's not required though - RADOS object
  85  * names don't have to be NUL-terminated and may contain NULs.
  86  */
  87 struct ceph_object_id {
  88         char *name;
  89         char inline_name[CEPH_OID_INLINE_LEN];
  90         int name_len;
  91 };
  92
  93 static inline void ceph_oid_init(struct ceph_object_id *oid)
  94 {
  95         oid->name = oid->inline_name;
  96         oid->name_len = 0;
  97 }
  98
  99 static inline bool ceph_oid_empty(const struct ceph_object_id *oid)
 100 {
 101         return oid->name == oid->inline_name && !oid->name_len;
 102 }
 103
 104 void ceph_oid_copy(struct ceph_object_id *dest,
 105                    const struct ceph_object_id *src);
 106 __printf(2, 3)
 107 void ceph_oid_printf(struct ceph_object_id *oid, const char *fmt, ...);
 108 __printf(3, 4)
 109 int ceph_oid_aprintf(struct ceph_object_id *oid, gfp_t gfp,
 110                      const char *fmt, ...);
 111 void ceph_oid_destroy(struct ceph_object_id *oid);
 112
 113 struct ceph_pg_mapping {
 114         struct rb_node node;
 115         struct ceph_pg pgid;
 116
 117         union {
 118                 struct {
 119                         int len;
 120                         int osds[];
 121                 } pg_temp;
 122                 struct {
 123                         int osd;
 124                 } primary_temp;
 125         };
 126 };
 127
 128 struct ceph_osdmap {
 129         struct ceph_fsid fsid;
 130         u32 epoch;
 131         struct ceph_timespec created, modified;
 132
 133         u32 flags;         /* CEPH_OSDMAP_* */
 134
 135         u32 max_osd;       /* size of osd_state, _offload, _addr arrays */
 136         u8 *osd_state;     /* CEPH_OSD_* */
 137         u32 *osd_weight;   /* 0 = failed, 0x10000 = 100% normal */
 138         struct ceph_entity_addr *osd_addr;
 139
 140         struct rb_root pg_temp;
 141         struct rb_root primary_temp;
 142
 143         u32 *osd_primary_affinity;
 144
 145         struct rb_root pg_pools;
 146         u32 pool_max;
 147
 148         /* the CRUSH map specifies the mapping of placement groups to
 149          * the list of osds that store+replicate them. */
 150         struct crush_map *crush;
 151
 152         struct mutex crush_scratch_mutex;
 153         int crush_scratch_ary[CEPH_PG_MAX_SIZE * 3];
 154 };
 155
 156 static inline int ceph_osd_exists(struct ceph_osdmap *map, int osd)
 157 {
 158         return osd >= 0 && osd < map->max_osd &&
 159                (map->osd_state[osd] & CEPH_OSD_EXISTS);
 160 }
 161
 162 static inline int ceph_osd_is_up(struct ceph_osdmap *map, int osd)
 163 {
 164         return ceph_osd_exists(map, osd) &&
 165                (map->osd_state[osd] & CEPH_OSD_UP);
 166 }
 167
 168 static inline int ceph_osd_is_down(struct ceph_osdmap *map, int osd)
 169 {
 170         return !ceph_osd_is_up(map, osd);
 171 }
 172
 173 static inline bool ceph_osdmap_flag(struct ceph_osdmap *map, int flag)
 174 {
 175         return map && (map->flags & flag);
 176 }
 177
 178 extern char *ceph_osdmap_state_str(char *str, int len, int state);
 179 extern u32 ceph_get_primary_affinity(struct ceph_osdmap *map, int osd);
 180
 181 static inline struct ceph_entity_addr *ceph_osd_addr(struct ceph_osdmap *map,
 182                                                      int osd)
 183 {
 184         if (osd >= map->max_osd)
 185                 return NULL;
 186         return &map->osd_addr[osd];
 187 }
 188
 189 static inline int ceph_decode_pgid(void **p, void *end, struct ceph_pg *pgid)
 190 {
 191         __u8 version;
 192
 193         if (!ceph_has_room(p, end, 1 + 8 + 4 + 4)) {
 194                 pr_warn("incomplete pg encoding\n");
 195                 return -EINVAL;
 196         }
 197         version = ceph_decode_8(p);
 198         if (version > 1) {
 199                 pr_warn("do not understand pg encoding %d > 1\n",
 200                         (int)version);
 201                 return -EINVAL;
 202         }
 203
 204         pgid->pool = ceph_decode_64(p);
 205         pgid->seed = ceph_decode_32(p);
 206         *p += 4;        /* skip deprecated preferred value */
 207
 208         return 0;
 209 }
 210
 211 extern struct ceph_osdmap *ceph_osdmap_decode(void **p, void *end);
 212 struct ceph_osdmap *osdmap_apply_incremental(void **p, void *end,
 213                                              struct ceph_osdmap *map);
 214 extern void ceph_osdmap_destroy(struct ceph_osdmap *map);
 215
 216 struct ceph_osds {
 217         int osds[CEPH_PG_MAX_SIZE];
 218         int size;
 219         int primary; /* id, NOT index */
 220 };
 221
 222 static inline void ceph_osds_init(struct ceph_osds *set)
 223 {
 224         set->size = 0;
 225         set->primary = -1;
 226 }
 227
 228 void ceph_osds_copy(struct ceph_osds *dest, const struct ceph_osds *src);
 229
 230 /* calculate mapping of a file extent to an object */
 231 extern int ceph_calc_file_object_mapping(struct ceph_file_layout *layout,
 232                                          u64 off, u64 len,
 233                                          u64 *bno, u64 *oxoff, u64 *oxlen);
 234
 235 int ceph_object_locator_to_pg(struct ceph_osdmap *osdmap,
 236                               struct ceph_object_id *oid,
 237                               struct ceph_object_locator *oloc,
 238                               struct ceph_pg *raw_pgid);
 239
 240 void ceph_pg_to_up_acting_osds(struct ceph_osdmap *osdmap,
 241                                const struct ceph_pg *raw_pgid,
 242                                struct ceph_osds *up,
 243                                struct ceph_osds *acting);
 244 int ceph_pg_to_acting_primary(struct ceph_osdmap *osdmap,
 245                               const struct ceph_pg *raw_pgid);
 246
 247 extern struct ceph_pg_pool_info *ceph_pg_pool_by_id(struct ceph_osdmap *map,
 248                                                     u64 id);
 249
 250 extern const char *ceph_pg_pool_name_by_id(struct ceph_osdmap *map, u64 id);
 251 extern int ceph_pg_poolid_by_name(struct ceph_osdmap *map, const char *name);
 252
 253 #endif