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