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 /*
  16  * Maximum object name size
  17  * (must be at least as big as RBD_MAX_MD_NAME_LEN -- currently 100)
  18  */
  19 #define MAX_OBJ_NAME_SIZE 100
  20
  21 struct ceph_msg;
  22 struct ceph_snap_context;
  23 struct ceph_osd_request;
  24 struct ceph_osd_client;
  25 struct ceph_authorizer;
  26
  27 /*
  28  * completion callback for async writepages
  29  */
  30 typedef void (*ceph_osdc_callback_t)(struct ceph_osd_request *,
  31                                      struct ceph_msg *);
  32
  33 /* a given osd we're communicating with */
  34 struct ceph_osd {
  35         atomic_t o_ref;
  36         struct ceph_osd_client *o_osdc;
  37         int o_osd;
  38         int o_incarnation;
  39         struct rb_node o_node;
  40         struct ceph_connection o_con;
  41         struct list_head o_requests;
  42         struct list_head o_linger_requests;
  43         struct list_head o_osd_lru;
  44         struct ceph_auth_handshake o_auth;
  45         unsigned long lru_ttl;
  46         int o_marked_for_keepalive;
  47         struct list_head o_keepalive_item;
  48 };
  49
  50
  51 #define CEPH_OSD_MAX_OP 10
  52
  53 enum ceph_osd_data_type {
  54         CEPH_OSD_DATA_TYPE_NONE,
  55         CEPH_OSD_DATA_TYPE_PAGES,
  56         CEPH_OSD_DATA_TYPE_PAGELIST,
  57 #ifdef CONFIG_BLOCK
  58         CEPH_OSD_DATA_TYPE_BIO,
  59 #endif /* CONFIG_BLOCK */
  60 };
  61
  62 struct ceph_osd_data {
  63         enum ceph_osd_data_type type;
  64         union {
  65                 struct {
  66                         struct page     **pages;
  67                         u64             length;
  68                         u32             alignment;
  69                         bool            pages_from_pool;
  70                         bool            own_pages;
  71                 };
  72                 struct ceph_pagelist    *pagelist;
  73 #ifdef CONFIG_BLOCK
  74                 struct {
  75                         struct bio      *bio;           /* list of bios */
  76                         size_t          bio_length;     /* total in list */
  77                 };
  78 #endif /* CONFIG_BLOCK */
  79         };
  80 };
  81
  82 /* an in-flight request */
  83 struct ceph_osd_request {
  84         u64             r_tid;              /* unique for this client */
  85         struct rb_node  r_node;
  86         struct list_head r_req_lru_item;
  87         struct list_head r_osd_item;
  88         struct list_head r_linger_item;
  89         struct list_head r_linger_osd;
  90         struct ceph_osd *r_osd;
  91         struct ceph_pg   r_pgid;
  92         int              r_pg_osds[CEPH_PG_MAX_SIZE];
  93         int              r_num_pg_osds;
  94
  95         struct ceph_msg  *r_request, *r_reply;
  96         int               r_flags;     /* any additional flags for the osd */
  97         u32               r_sent;      /* >0 if r_request is sending/sent */
  98         int               r_num_ops;
  99
 100         /* encoded message content */
 101         struct ceph_osd_op *r_request_ops;
 102         /* these are updated on each send */
 103         __le32           *r_request_osdmap_epoch;
 104         __le32           *r_request_flags;
 105         __le64           *r_request_pool;
 106         void             *r_request_pgid;
 107         __le32           *r_request_attempts;
 108         struct ceph_eversion *r_request_reassert_version;
 109
 110         int               r_result;
 111         int               r_reply_op_len[CEPH_OSD_MAX_OP];
 112         s32               r_reply_op_result[CEPH_OSD_MAX_OP];
 113         int               r_got_reply;
 114         int               r_linger;
 115         int               r_completed;
 116
 117         struct ceph_osd_client *r_osdc;
 118         struct kref       r_kref;
 119         bool              r_mempool;
 120         struct completion r_completion, r_safe_completion;
 121         ceph_osdc_callback_t r_callback, r_safe_callback;
 122         struct ceph_eversion r_reassert_version;
 123         struct list_head  r_unsafe_item;
 124
 125         struct inode *r_inode;                /* for use by callbacks */
 126         void *r_priv;                         /* ditto */
 127
 128         char              r_oid[MAX_OBJ_NAME_SIZE];          /* object name */
 129         int               r_oid_len;
 130         u64               r_snapid;
 131         unsigned long     r_stamp;            /* send OR check time */
 132
 133         struct ceph_file_layout r_file_layout;
 134         struct ceph_snap_context *r_snapc;    /* snap context for writes */
 135
 136         struct ceph_osd_data r_data_in;
 137         struct ceph_osd_data r_data_out;
 138 };
 139
 140 struct ceph_osd_event {
 141         u64 cookie;
 142         int one_shot;
 143         struct ceph_osd_client *osdc;
 144         void (*cb)(u64, u64, u8, void *);
 145         void *data;
 146         struct rb_node node;
 147         struct list_head osd_node;
 148         struct kref kref;
 149 };
 150
 151 struct ceph_osd_event_work {
 152         struct work_struct work;
 153         struct ceph_osd_event *event;
 154         u64 ver;
 155         u64 notify_id;
 156         u8 opcode;
 157 };
 158
 159 struct ceph_osd_client {
 160         struct ceph_client     *client;
 161
 162         struct ceph_osdmap     *osdmap;       /* current map */
 163         struct rw_semaphore    map_sem;
 164         struct completion      map_waiters;
 165         u64                    last_requested_map;
 166
 167         struct mutex           request_mutex;
 168         struct rb_root         osds;          /* osds */
 169         struct list_head       osd_lru;       /* idle osds */
 170         u64                    timeout_tid;   /* tid of timeout triggering rq */
 171         u64                    last_tid;      /* tid of last request */
 172         struct rb_root         requests;      /* pending requests */
 173         struct list_head       req_lru;       /* in-flight lru */
 174         struct list_head       req_unsent;    /* unsent/need-resend queue */
 175         struct list_head       req_notarget;  /* map to no osd */
 176         struct list_head       req_linger;    /* lingering requests */
 177         int                    num_requests;
 178         struct delayed_work    timeout_work;
 179         struct delayed_work    osds_timeout_work;
 180 #ifdef CONFIG_DEBUG_FS
 181         struct dentry          *debugfs_file;
 182 #endif
 183
 184         mempool_t              *req_mempool;
 185
 186         struct ceph_msgpool     msgpool_op;
 187         struct ceph_msgpool     msgpool_op_reply;
 188
 189         spinlock_t              event_lock;
 190         struct rb_root          event_tree;
 191         u64                     event_count;
 192
 193         struct workqueue_struct *notify_wq;
 194 };
 195
 196 struct ceph_osd_req_op {
 197         u16 op;           /* CEPH_OSD_OP_* */
 198         u32 payload_len;
 199         union {
 200                 struct {
 201                         u64 offset, length;
 202                         u64 truncate_size;
 203                         u32 truncate_seq;
 204                 } extent;
 205                 struct {
 206                         const char *class_name;
 207                         const char *method_name;
 208                         const void *indata;
 209                         u32 indata_len;
 210                         __u8 class_len;
 211                         __u8 method_len;
 212                         __u8 argc;
 213                 } cls;
 214                 struct {
 215                         u64 cookie;
 216                         u64 ver;
 217                         u32 prot_ver;
 218                         u32 timeout;
 219                         __u8 flag;
 220                 } watch;
 221         };
 222 };
 223
 224 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
 225                           struct ceph_client *client);
 226 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
 227
 228 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
 229                                    struct ceph_msg *msg);
 230 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
 231                                  struct ceph_msg *msg);
 232
 233 extern void osd_req_op_init(struct ceph_osd_req_op *op, u16 opcode);
 234 extern void osd_req_op_extent_init(struct ceph_osd_req_op *op, u16 opcode,
 235                                         u64 offset, u64 length,
 236                                         u64 truncate_size, u32 truncate_seq);
 237 extern void osd_req_op_cls_init(struct ceph_osd_req_op *op, u16 opcode,
 238                                         const char *class, const char *method,
 239                                         const void *request_data,
 240                                         size_t request_data_size);
 241 extern void osd_req_op_watch_init(struct ceph_osd_req_op *op, u16 opcode,
 242                                         u64 cookie, u64 version, int flag);
 243
 244 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
 245                                                struct ceph_snap_context *snapc,
 246                                                unsigned int num_op,
 247                                                bool use_mempool,
 248                                                gfp_t gfp_flags);
 249
 250 extern void ceph_osdc_build_request(struct ceph_osd_request *req, u64 off,
 251                                     unsigned int num_op,
 252                                     struct ceph_osd_req_op *src_ops,
 253                                     struct ceph_snap_context *snapc,
 254                                     u64 snap_id,
 255                                     struct timespec *mtime);
 256
 257 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
 258                                       struct ceph_file_layout *layout,
 259                                       struct ceph_vino vino,
 260                                       u64 offset, u64 *len, int op, int flags,
 261                                       struct ceph_snap_context *snapc,
 262                                       int do_sync, u32 truncate_seq,
 263                                       u64 truncate_size,
 264                                       struct timespec *mtime,
 265                                       bool use_mempool);
 266
 267 extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
 268                                          struct ceph_osd_request *req);
 269 extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
 270                                                 struct ceph_osd_request *req);
 271
 272 static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
 273 {
 274         kref_get(&req->r_kref);
 275 }
 276 extern void ceph_osdc_release_request(struct kref *kref);
 277 static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
 278 {
 279         kref_put(&req->r_kref, ceph_osdc_release_request);
 280 }
 281
 282 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
 283                                    struct ceph_osd_request *req,
 284                                    bool nofail);
 285 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
 286                                   struct ceph_osd_request *req);
 287 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
 288
 289 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
 290                                struct ceph_vino vino,
 291                                struct ceph_file_layout *layout,
 292                                u64 off, u64 *plen,
 293                                u32 truncate_seq, u64 truncate_size,
 294                                struct page **pages, int nr_pages,
 295                                int page_align);
 296
 297 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
 298                                 struct ceph_vino vino,
 299                                 struct ceph_file_layout *layout,
 300                                 struct ceph_snap_context *sc,
 301                                 u64 off, u64 len,
 302                                 u32 truncate_seq, u64 truncate_size,
 303                                 struct timespec *mtime,
 304                                 struct page **pages, int nr_pages);
 305
 306 /* watch/notify events */
 307 extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
 308                                   void (*event_cb)(u64, u64, u8, void *),
 309                                   void *data, struct ceph_osd_event **pevent);
 310 extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
 311 extern void ceph_osdc_put_event(struct ceph_osd_event *event);
 312 #endif
 313