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 typedef void (*ceph_osdc_unsafe_callback_t)(struct ceph_osd_request *, bool);
  25
  26 #define CEPH_HOMELESS_OSD       -1
  27
  28 /* a given osd we're communicating with */
  29 struct ceph_osd {
  30         atomic_t o_ref;
  31         struct ceph_osd_client *o_osdc;
  32         int o_osd;
  33         int o_incarnation;
  34         struct rb_node o_node;
  35         struct ceph_connection o_con;
  36         struct rb_root o_requests;
  37         struct rb_root o_linger_requests;
  38         struct list_head o_osd_lru;
  39         struct ceph_auth_handshake o_auth;
  40         unsigned long lru_ttl;
  41         struct list_head o_keepalive_item;
  42         struct mutex lock;
  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                         u32 indata_len;
 108                 } cls;
 109                 struct {
 110                         u64 cookie;
 111                         __u8 op;           /* CEPH_OSD_WATCH_OP_ */
 112                         u32 gen;
 113                 } watch;
 114                 struct {
 115                         struct ceph_osd_data request_data;
 116                 } notify_ack;
 117                 struct {
 118                         u64 cookie;
 119                         struct ceph_osd_data request_data;
 120                         struct ceph_osd_data response_data;
 121                 } notify;
 122                 struct {
 123                         u64 expected_object_size;
 124                         u64 expected_write_size;
 125                 } alloc_hint;
 126         };
 127 };
 128
 129 struct ceph_osd_request_target {
 130         struct ceph_object_id base_oid;
 131         struct ceph_object_locator base_oloc;
 132         struct ceph_object_id target_oid;
 133         struct ceph_object_locator target_oloc;
 134
 135         struct ceph_pg pgid;
 136         u32 pg_num;
 137         u32 pg_num_mask;
 138         struct ceph_osds acting;
 139         struct ceph_osds up;
 140         int size;
 141         int min_size;
 142         bool sort_bitwise;
 143
 144         unsigned int flags;                /* CEPH_OSD_FLAG_* */
 145         bool paused;
 146
 147         int osd;
 148 };
 149
 150 /* an in-flight request */
 151 struct ceph_osd_request {
 152         u64             r_tid;              /* unique for this client */
 153         struct rb_node  r_node;
 154         struct ceph_osd *r_osd;
 155
 156         struct ceph_osd_request_target r_t;
 157 #define r_base_oid      r_t.base_oid
 158 #define r_base_oloc     r_t.base_oloc
 159 #define r_flags         r_t.flags
 160
 161         struct ceph_msg  *r_request, *r_reply;
 162         u32               r_sent;      /* >0 if r_request is sending/sent */
 163
 164         /* request osd ops array  */
 165         unsigned int            r_num_ops;
 166
 167         int               r_result;
 168         bool              r_got_reply;
 169
 170         struct ceph_osd_client *r_osdc;
 171         struct kref       r_kref;
 172         bool              r_mempool;
 173         struct completion r_completion;
 174         struct completion r_safe_completion;  /* fsync waiter */
 175         ceph_osdc_callback_t r_callback;
 176         ceph_osdc_unsafe_callback_t r_unsafe_callback;
 177         struct list_head  r_unsafe_item;
 178
 179         struct inode *r_inode;                /* for use by callbacks */
 180         void *r_priv;                         /* ditto */
 181
 182         /* set by submitter */
 183         u64 r_snapid;                         /* for reads, CEPH_NOSNAP o/w */
 184         struct ceph_snap_context *r_snapc;    /* for writes */
 185         struct timespec r_mtime;              /* ditto */
 186         u64 r_data_offset;                    /* ditto */
 187         bool r_linger;                        /* don't resend on failure */
 188
 189         /* internal */
 190         unsigned long r_stamp;                /* jiffies, send or check time */
 191         int r_attempts;
 192         struct ceph_eversion r_replay_version; /* aka reassert_version */
 193         u32 r_last_force_resend;
 194
 195         struct ceph_osd_req_op r_ops[];
 196 };
 197
 198 struct ceph_request_redirect {
 199         struct ceph_object_locator oloc;
 200 };
 201
 202 typedef void (*rados_watchcb2_t)(void *arg, u64 notify_id, u64 cookie,
 203                                  u64 notifier_id, void *data, size_t data_len);
 204 typedef void (*rados_watcherrcb_t)(void *arg, u64 cookie, int err);
 205
 206 struct ceph_osd_linger_request {
 207         struct ceph_osd_client *osdc;
 208         u64 linger_id;
 209         bool committed;
 210         bool is_watch;                  /* watch or notify */
 211
 212         struct ceph_osd *osd;
 213         struct ceph_osd_request *reg_req;
 214         struct ceph_osd_request *ping_req;
 215         unsigned long ping_sent;
 216         unsigned long watch_valid_thru;
 217         struct list_head pending_lworks;
 218
 219         struct ceph_osd_request_target t;
 220         u32 last_force_resend;
 221
 222         struct timespec mtime;
 223
 224         struct kref kref;
 225         struct mutex lock;
 226         struct rb_node node;            /* osd */
 227         struct rb_node osdc_node;       /* osdc */
 228         struct list_head scan_item;
 229
 230         struct completion reg_commit_wait;
 231         struct completion notify_finish_wait;
 232         int reg_commit_error;
 233         int notify_finish_error;
 234         int last_error;
 235
 236         u32 register_gen;
 237         u64 notify_id;
 238
 239         rados_watchcb2_t wcb;
 240         rados_watcherrcb_t errcb;
 241         void *data;
 242
 243         struct page ***preply_pages;
 244         size_t *preply_len;
 245 };
 246
 247 struct ceph_osd_client {
 248         struct ceph_client     *client;
 249
 250         struct ceph_osdmap     *osdmap;       /* current map */
 251         struct rw_semaphore    lock;
 252
 253         struct rb_root         osds;          /* osds */
 254         struct list_head       osd_lru;       /* idle osds */
 255         spinlock_t             osd_lru_lock;
 256         struct ceph_osd        homeless_osd;
 257         atomic64_t             last_tid;      /* tid of last request */
 258         u64                    last_linger_id;
 259         struct rb_root         linger_requests; /* lingering requests */
 260         atomic_t               num_requests;
 261         atomic_t               num_homeless;
 262         struct delayed_work    timeout_work;
 263         struct delayed_work    osds_timeout_work;
 264 #ifdef CONFIG_DEBUG_FS
 265         struct dentry          *debugfs_file;
 266 #endif
 267
 268         mempool_t              *req_mempool;
 269
 270         struct ceph_msgpool     msgpool_op;
 271         struct ceph_msgpool     msgpool_op_reply;
 272
 273         struct workqueue_struct *notify_wq;
 274 };
 275
 276 extern int ceph_osdc_setup(void);
 277 extern void ceph_osdc_cleanup(void);
 278
 279 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
 280                           struct ceph_client *client);
 281 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
 282
 283 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
 284                                    struct ceph_msg *msg);
 285 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
 286                                  struct ceph_msg *msg);
 287
 288 extern void osd_req_op_init(struct ceph_osd_request *osd_req,
 289                             unsigned int which, u16 opcode, u32 flags);
 290
 291 extern void osd_req_op_raw_data_in_pages(struct ceph_osd_request *,
 292                                         unsigned int which,
 293                                         struct page **pages, u64 length,
 294                                         u32 alignment, bool pages_from_pool,
 295                                         bool own_pages);
 296
 297 extern void osd_req_op_extent_init(struct ceph_osd_request *osd_req,
 298                                         unsigned int which, u16 opcode,
 299                                         u64 offset, u64 length,
 300                                         u64 truncate_size, u32 truncate_seq);
 301 extern void osd_req_op_extent_update(struct ceph_osd_request *osd_req,
 302                                         unsigned int which, u64 length);
 303 extern void osd_req_op_extent_dup_last(struct ceph_osd_request *osd_req,
 304                                        unsigned int which, u64 offset_inc);
 305
 306 extern struct ceph_osd_data *osd_req_op_extent_osd_data(
 307                                         struct ceph_osd_request *osd_req,
 308                                         unsigned int which);
 309
 310 extern void osd_req_op_extent_osd_data_pages(struct ceph_osd_request *,
 311                                         unsigned int which,
 312                                         struct page **pages, u64 length,
 313                                         u32 alignment, bool pages_from_pool,
 314                                         bool own_pages);
 315 extern void osd_req_op_extent_osd_data_pagelist(struct ceph_osd_request *,
 316                                         unsigned int which,
 317                                         struct ceph_pagelist *pagelist);
 318 #ifdef CONFIG_BLOCK
 319 extern void osd_req_op_extent_osd_data_bio(struct ceph_osd_request *,
 320                                         unsigned int which,
 321                                         struct bio *bio, size_t bio_length);
 322 #endif /* CONFIG_BLOCK */
 323
 324 extern void osd_req_op_cls_request_data_pagelist(struct ceph_osd_request *,
 325                                         unsigned int which,
 326                                         struct ceph_pagelist *pagelist);
 327 extern void osd_req_op_cls_request_data_pages(struct ceph_osd_request *,
 328                                         unsigned int which,
 329                                         struct page **pages, u64 length,
 330                                         u32 alignment, bool pages_from_pool,
 331                                         bool own_pages);
 332 extern void osd_req_op_cls_response_data_pages(struct ceph_osd_request *,
 333                                         unsigned int which,
 334                                         struct page **pages, u64 length,
 335                                         u32 alignment, bool pages_from_pool,
 336                                         bool own_pages);
 337
 338 extern void osd_req_op_cls_init(struct ceph_osd_request *osd_req,
 339                                         unsigned int which, u16 opcode,
 340                                         const char *class, const char *method);
 341 extern int osd_req_op_xattr_init(struct ceph_osd_request *osd_req, unsigned int which,
 342                                  u16 opcode, const char *name, const void *value,
 343                                  size_t size, u8 cmp_op, u8 cmp_mode);
 344 extern void osd_req_op_alloc_hint_init(struct ceph_osd_request *osd_req,
 345                                        unsigned int which,
 346                                        u64 expected_object_size,
 347                                        u64 expected_write_size);
 348
 349 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
 350                                                struct ceph_snap_context *snapc,
 351                                                unsigned int num_ops,
 352                                                bool use_mempool,
 353                                                gfp_t gfp_flags);
 354 int ceph_osdc_alloc_messages(struct ceph_osd_request *req, gfp_t gfp);
 355
 356 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
 357                                       struct ceph_file_layout *layout,
 358                                       struct ceph_vino vino,
 359                                       u64 offset, u64 *len,
 360                                       unsigned int which, int num_ops,
 361                                       int opcode, int flags,
 362                                       struct ceph_snap_context *snapc,
 363                                       u32 truncate_seq, u64 truncate_size,
 364                                       bool use_mempool);
 365
 366 extern void ceph_osdc_get_request(struct ceph_osd_request *req);
 367 extern void ceph_osdc_put_request(struct ceph_osd_request *req);
 368
 369 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
 370                                    struct ceph_osd_request *req,
 371                                    bool nofail);
 372 extern void ceph_osdc_cancel_request(struct ceph_osd_request *req);
 373 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
 374                                   struct ceph_osd_request *req);
 375 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
 376
 377 extern void ceph_osdc_flush_notifies(struct ceph_osd_client *osdc);
 378
 379 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
 380                                struct ceph_vino vino,
 381                                struct ceph_file_layout *layout,
 382                                u64 off, u64 *plen,
 383                                u32 truncate_seq, u64 truncate_size,
 384                                struct page **pages, int nr_pages,
 385                                int page_align);
 386
 387 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
 388                                 struct ceph_vino vino,
 389                                 struct ceph_file_layout *layout,
 390                                 struct ceph_snap_context *sc,
 391                                 u64 off, u64 len,
 392                                 u32 truncate_seq, u64 truncate_size,
 393                                 struct timespec *mtime,
 394                                 struct page **pages, int nr_pages);
 395
 396 /* watch/notify */
 397 struct ceph_osd_linger_request *
 398 ceph_osdc_watch(struct ceph_osd_client *osdc,
 399                 struct ceph_object_id *oid,
 400                 struct ceph_object_locator *oloc,
 401                 rados_watchcb2_t wcb,
 402                 rados_watcherrcb_t errcb,
 403                 void *data);
 404 int ceph_osdc_unwatch(struct ceph_osd_client *osdc,
 405                       struct ceph_osd_linger_request *lreq);
 406
 407 int ceph_osdc_notify_ack(struct ceph_osd_client *osdc,
 408                          struct ceph_object_id *oid,
 409                          struct ceph_object_locator *oloc,
 410                          u64 notify_id,
 411                          u64 cookie,
 412                          void *payload,
 413                          size_t payload_len);
 414 int ceph_osdc_notify(struct ceph_osd_client *osdc,
 415                      struct ceph_object_id *oid,
 416                      struct ceph_object_locator *oloc,
 417                      void *payload,
 418                      size_t payload_len,
 419                      u32 timeout,
 420                      struct page ***preply_pages,
 421                      size_t *preply_len);
 422 int ceph_osdc_watch_check(struct ceph_osd_client *osdc,
 423                           struct ceph_osd_linger_request *lreq);
 424 #endif
 425