include/linux/ceph/osd_client.h

   1 #ifndef _FS_CEPH_OSD_CLIENT_H
   2 #define _FS_CEPH_OSD_CLIENT_H
   3
   4 #include <linux/completion.h>
   5 #include <linux/kref.h>
   6 #include <linux/mempool.h>
   7 #include <linux/rbtree.h>
   8
   9 #include <linux/ceph/types.h>
  10 #include <linux/ceph/osdmap.h>
  11 #include <linux/ceph/messenger.h>
  12 #include <linux/ceph/auth.h>
  13 #include <linux/ceph/pagelist.h>
  14
  15 struct ceph_msg;
  16 struct ceph_snap_context;
  17 struct ceph_osd_request;
  18 struct ceph_osd_client;
  19
  20 /*
  21  * completion callback for async writepages
  22  */
  23 typedef void (*ceph_osdc_callback_t)(struct ceph_osd_request *,
  24                                      struct ceph_msg *);
  25 typedef void (*ceph_osdc_unsafe_callback_t)(struct ceph_osd_request *, bool);
  26
  27 /* a given osd we're communicating with */
  28 struct ceph_osd {
  29         atomic_t o_ref;
  30         struct ceph_osd_client *o_osdc;
  31         int o_osd;
  32         int o_incarnation;
  33         struct rb_node o_node;
  34         struct ceph_connection o_con;
  35         struct list_head o_requests;
  36         struct list_head o_linger_requests;
  37         struct list_head o_osd_lru;
  38         struct ceph_auth_handshake o_auth;
  39         unsigned long lru_ttl;
  40         int o_marked_for_keepalive;
  41         struct list_head o_keepalive_item;
  42 };
  43
  44
  45 #define CEPH_OSD_SLAB_OPS       2
  46 #define CEPH_OSD_MAX_OPS        16
  47
  48 enum ceph_osd_data_type {
  49         CEPH_OSD_DATA_TYPE_NONE = 0,
  50         CEPH_OSD_DATA_TYPE_PAGES,
  51         CEPH_OSD_DATA_TYPE_PAGELIST,
  52 #ifdef CONFIG_BLOCK
  53         CEPH_OSD_DATA_TYPE_BIO,
  54 #endif /* CONFIG_BLOCK */
  55 };
  56
  57 struct ceph_osd_data {
  58         enum ceph_osd_data_type type;
  59         union {
  60                 struct {
  61                         struct page     **pages;
  62                         u64             length;
  63                         u32             alignment;
  64                         bool            pages_from_pool;
  65                         bool            own_pages;
  66                 };
  67                 struct ceph_pagelist    *pagelist;
  68 #ifdef CONFIG_BLOCK
  69                 struct {
  70                         struct bio      *bio;           /* list of bios */
  71                         size_t          bio_length;     /* total in list */
  72                 };
  73 #endif /* CONFIG_BLOCK */
  74         };
  75 };
  76
  77 struct ceph_osd_req_op {
  78         u16 op;           /* CEPH_OSD_OP_* */
  79         u32 flags;        /* CEPH_OSD_OP_FLAG_* */
  80         u32 indata_len;   /* request */
  81         u32 outdata_len;  /* reply */
  82         s32 rval;
  83
  84         union {
  85                 struct ceph_osd_data raw_data_in;
  86                 struct {
  87                         u64 offset, length;
  88                         u64 truncate_size;
  89                         u32 truncate_seq;
  90                         struct ceph_osd_data osd_data;
  91                 } extent;
  92                 struct {
  93                         u32 name_len;
  94                         u32 value_len;
  95                         __u8 cmp_op;       /* CEPH_OSD_CMPXATTR_OP_* */
  96                         __u8 cmp_mode;     /* CEPH_OSD_CMPXATTR_MODE_* */
  97                         struct ceph_osd_data osd_data;
  98                 } xattr;
  99                 struct {
 100                         const char *class_name;
 101                         const char *method_name;
 102                         struct ceph_osd_data request_info;
 103                         struct ceph_osd_data request_data;
 104                         struct ceph_osd_data response_data;
 105                         __u8 class_len;
 106                         __u8 method_len;
 107                         __u8 argc;
 108                 } cls;
 109                 struct {
 110                         u64 cookie;
 111                         u64 ver;
 112                         u32 prot_ver;
 113                         u32 timeout;
 114                         __u8 flag;
 115                 } watch;
 116                 struct {
 117                         u64 expected_object_size;
 118                         u64 expected_write_size;
 119                 } alloc_hint;
 120         };
 121 };
 122
 123 /* an in-flight request */
 124 struct ceph_osd_request {
 125         u64             r_tid;              /* unique for this client */
 126         struct rb_node  r_node;
 127         struct list_head r_req_lru_item;
 128         struct list_head r_osd_item;
 129         struct list_head r_linger_item;
 130         struct list_head r_linger_osd_item;
 131         struct ceph_osd *r_osd;
 132         struct ceph_pg   r_pgid;
 133         int              r_pg_osds[CEPH_PG_MAX_SIZE];
 134         int              r_num_pg_osds;
 135
 136         struct ceph_msg  *r_request, *r_reply;
 137         int               r_flags;     /* any additional flags for the osd */
 138         u32               r_sent;      /* >0 if r_request is sending/sent */
 139
 140         /* request osd ops array  */
 141         unsigned int            r_num_ops;
 142
 143         /* these are updated on each send */
 144         __le32           *r_request_osdmap_epoch;
 145         __le32           *r_request_flags;
 146         __le64           *r_request_pool;
 147         void             *r_request_pgid;
 148         __le32           *r_request_attempts;
 149         bool              r_paused;
 150         struct ceph_eversion *r_request_reassert_version;
 151
 152         int               r_result;
 153         int               r_got_reply;
 154         int               r_linger;
 155
 156         struct ceph_osd_client *r_osdc;
 157         struct kref       r_kref;
 158         bool              r_mempool;
 159         struct completion r_completion, r_safe_completion;
 160         ceph_osdc_callback_t r_callback;
 161         ceph_osdc_unsafe_callback_t r_unsafe_callback;
 162         struct ceph_eversion r_reassert_version;
 163         struct list_head  r_unsafe_item;
 164
 165         struct inode *r_inode;                /* for use by callbacks */
 166         void *r_priv;                         /* ditto */
 167
 168         struct ceph_object_locator r_base_oloc;
 169         struct ceph_object_id r_base_oid;
 170         struct ceph_object_locator r_target_oloc;
 171         struct ceph_object_id r_target_oid;
 172
 173         u64               r_snapid;
 174         unsigned long     r_stamp;            /* send OR check time */
 175
 176         struct ceph_snap_context *r_snapc;    /* snap context for writes */
 177
 178         struct ceph_osd_req_op r_ops[];
 179 };
 180
 181 struct ceph_request_redirect {
 182         struct ceph_object_locator oloc;
 183 };
 184
 185 struct ceph_osd_event {
 186         u64 cookie;
 187         int one_shot;
 188         struct ceph_osd_client *osdc;
 189         void (*cb)(u64, u64, u8, void *);
 190         void *data;
 191         struct rb_node node;
 192         struct list_head osd_node;
 193         struct kref kref;
 194 };
 195
 196 struct ceph_osd_event_work {
 197         struct work_struct work;
 198         struct ceph_osd_event *event;
 199         u64 ver;
 200         u64 notify_id;
 201         u8 opcode;
 202 };
 203
 204 struct ceph_osd_client {
 205         struct ceph_client     *client;
 206
 207         struct ceph_osdmap     *osdmap;       /* current map */
 208         struct rw_semaphore    map_sem;
 209         struct completion      map_waiters;
 210         u64                    last_requested_map;
 211
 212         struct mutex           request_mutex;
 213         struct rb_root         osds;          /* osds */
 214         struct list_head       osd_lru;       /* idle osds */
 215         u64                    timeout_tid;   /* tid of timeout triggering rq */
 216         u64                    last_tid;      /* tid of last request */
 217         struct rb_root         requests;      /* pending requests */
 218         struct list_head       req_lru;       /* in-flight lru */
 219         struct list_head       req_unsent;    /* unsent/need-resend queue */
 220         struct list_head       req_notarget;  /* map to no osd */
 221         struct list_head       req_linger;    /* lingering requests */
 222         int                    num_requests;
 223         struct delayed_work    timeout_work;
 224         struct delayed_work    osds_timeout_work;
 225 #ifdef CONFIG_DEBUG_FS
 226         struct dentry          *debugfs_file;
 227 #endif
 228
 229         mempool_t              *req_mempool;
 230
 231         struct ceph_msgpool     msgpool_op;
 232         struct ceph_msgpool     msgpool_op_reply;
 233
 234         spinlock_t              event_lock;
 235         struct rb_root          event_tree;
 236         u64                     event_count;
 237
 238         struct workqueue_struct *notify_wq;
 239 };
 240
 241 extern int ceph_osdc_setup(void);
 242 extern void ceph_osdc_cleanup(void);
 243
 244 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
 245                           struct ceph_client *client);
 246 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
 247
 248 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
 249                                    struct ceph_msg *msg);
 250 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
 251                                  struct ceph_msg *msg);
 252
 253 extern void osd_req_op_init(struct ceph_osd_request *osd_req,
 254                             unsigned int which, u16 opcode, u32 flags);
 255
 256 extern void osd_req_op_raw_data_in_pages(struct ceph_osd_request *,
 257                                         unsigned int which,
 258                                         struct page **pages, u64 length,
 259                                         u32 alignment, bool pages_from_pool,
 260                                         bool own_pages);
 261
 262 extern void osd_req_op_extent_init(struct ceph_osd_request *osd_req,
 263                                         unsigned int which, u16 opcode,
 264                                         u64 offset, u64 length,
 265                                         u64 truncate_size, u32 truncate_seq);
 266 extern void osd_req_op_extent_update(struct ceph_osd_request *osd_req,
 267                                         unsigned int which, u64 length);
 268 extern void osd_req_op_extent_dup_last(struct ceph_osd_request *osd_req,
 269                                        unsigned int which, u64 offset_inc);
 270
 271 extern struct ceph_osd_data *osd_req_op_extent_osd_data(
 272                                         struct ceph_osd_request *osd_req,
 273                                         unsigned int which);
 274 extern struct ceph_osd_data *osd_req_op_cls_response_data(
 275                                         struct ceph_osd_request *osd_req,
 276                                         unsigned int which);
 277
 278 extern void osd_req_op_extent_osd_data_pages(struct ceph_osd_request *,
 279                                         unsigned int which,
 280                                         struct page **pages, u64 length,
 281                                         u32 alignment, bool pages_from_pool,
 282                                         bool own_pages);
 283 extern void osd_req_op_extent_osd_data_pagelist(struct ceph_osd_request *,
 284                                         unsigned int which,
 285                                         struct ceph_pagelist *pagelist);
 286 #ifdef CONFIG_BLOCK
 287 extern void osd_req_op_extent_osd_data_bio(struct ceph_osd_request *,
 288                                         unsigned int which,
 289                                         struct bio *bio, size_t bio_length);
 290 #endif /* CONFIG_BLOCK */
 291
 292 extern void osd_req_op_cls_request_data_pagelist(struct ceph_osd_request *,
 293                                         unsigned int which,
 294                                         struct ceph_pagelist *pagelist);
 295 extern void osd_req_op_cls_request_data_pages(struct ceph_osd_request *,
 296                                         unsigned int which,
 297                                         struct page **pages, u64 length,
 298                                         u32 alignment, bool pages_from_pool,
 299                                         bool own_pages);
 300 extern void osd_req_op_cls_response_data_pages(struct ceph_osd_request *,
 301                                         unsigned int which,
 302                                         struct page **pages, u64 length,
 303                                         u32 alignment, bool pages_from_pool,
 304                                         bool own_pages);
 305
 306 extern void osd_req_op_cls_init(struct ceph_osd_request *osd_req,
 307                                         unsigned int which, u16 opcode,
 308                                         const char *class, const char *method);
 309 extern int osd_req_op_xattr_init(struct ceph_osd_request *osd_req, unsigned int which,
 310                                  u16 opcode, const char *name, const void *value,
 311                                  size_t size, u8 cmp_op, u8 cmp_mode);
 312 extern void osd_req_op_watch_init(struct ceph_osd_request *osd_req,
 313                                         unsigned int which, u16 opcode,
 314                                         u64 cookie, u64 version, int flag);
 315 extern void osd_req_op_alloc_hint_init(struct ceph_osd_request *osd_req,
 316                                        unsigned int which,
 317                                        u64 expected_object_size,
 318                                        u64 expected_write_size);
 319
 320 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
 321                                                struct ceph_snap_context *snapc,
 322                                                unsigned int num_ops,
 323                                                bool use_mempool,
 324                                                gfp_t gfp_flags);
 325
 326 extern void ceph_osdc_build_request(struct ceph_osd_request *req, u64 off,
 327                                     struct ceph_snap_context *snapc,
 328                                     u64 snap_id,
 329                                     struct timespec *mtime);
 330
 331 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
 332                                       struct ceph_file_layout *layout,
 333                                       struct ceph_vino vino,
 334                                       u64 offset, u64 *len,
 335                                       unsigned int which, int num_ops,
 336                                       int opcode, int flags,
 337                                       struct ceph_snap_context *snapc,
 338                                       u32 truncate_seq, u64 truncate_size,
 339                                       bool use_mempool);
 340
 341 extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
 342                                          struct ceph_osd_request *req);
 343
 344 extern void ceph_osdc_get_request(struct ceph_osd_request *req);
 345 extern void ceph_osdc_put_request(struct ceph_osd_request *req);
 346
 347 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
 348                                    struct ceph_osd_request *req,
 349                                    bool nofail);
 350 extern void ceph_osdc_cancel_request(struct ceph_osd_request *req);
 351 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
 352                                   struct ceph_osd_request *req);
 353 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
 354
 355 extern void ceph_osdc_flush_notifies(struct ceph_osd_client *osdc);
 356
 357 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
 358                                struct ceph_vino vino,
 359                                struct ceph_file_layout *layout,
 360                                u64 off, u64 *plen,
 361                                u32 truncate_seq, u64 truncate_size,
 362                                struct page **pages, int nr_pages,
 363                                int page_align);
 364
 365 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
 366                                 struct ceph_vino vino,
 367                                 struct ceph_file_layout *layout,
 368                                 struct ceph_snap_context *sc,
 369                                 u64 off, u64 len,
 370                                 u32 truncate_seq, u64 truncate_size,
 371                                 struct timespec *mtime,
 372                                 struct page **pages, int nr_pages);
 373
 374 /* watch/notify events */
 375 extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
 376                                   void (*event_cb)(u64, u64, u8, void *),
 377                                   void *data, struct ceph_osd_event **pevent);
 378 extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
 379 extern void ceph_osdc_put_event(struct ceph_osd_event *event);
 380 #endif
 381