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 2
  52
  53 enum ceph_osd_data_type {
  54         CEPH_OSD_DATA_TYPE_NONE = 0,
  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 struct ceph_osd_req_op {
  83         u16 op;           /* CEPH_OSD_OP_* */
  84         u32 payload_len;
  85         union {
  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                         const char *class_name;
  94                         const char *method_name;
  95                         struct ceph_osd_data request_info;
  96                         struct ceph_osd_data request_data;
  97                         struct ceph_osd_data response_data;
  98                         __u8 class_len;
  99                         __u8 method_len;
 100                         __u8 argc;
 101                 } cls;
 102                 struct {
 103                         u64 cookie;
 104                         u64 ver;
 105                         u32 prot_ver;
 106                         u32 timeout;
 107                         __u8 flag;
 108                 } watch;
 109         };
 110 };
 111
 112 /* an in-flight request */
 113 struct ceph_osd_request {
 114         u64             r_tid;              /* unique for this client */
 115         struct rb_node  r_node;
 116         struct list_head r_req_lru_item;
 117         struct list_head r_osd_item;
 118         struct list_head r_linger_item;
 119         struct list_head r_linger_osd;
 120         struct ceph_osd *r_osd;
 121         struct ceph_pg   r_pgid;
 122         int              r_pg_osds[CEPH_PG_MAX_SIZE];
 123         int              r_num_pg_osds;
 124
 125         struct ceph_msg  *r_request, *r_reply;
 126         int               r_flags;     /* any additional flags for the osd */
 127         u32               r_sent;      /* >0 if r_request is sending/sent */
 128
 129         /* request osd ops array  */
 130         unsigned int            r_num_ops;
 131         struct ceph_osd_req_op  r_ops[CEPH_OSD_MAX_OP];
 132
 133         /* these are updated on each send */
 134         __le32           *r_request_osdmap_epoch;
 135         __le32           *r_request_flags;
 136         __le64           *r_request_pool;
 137         void             *r_request_pgid;
 138         __le32           *r_request_attempts;
 139         struct ceph_eversion *r_request_reassert_version;
 140
 141         int               r_result;
 142         int               r_reply_op_len[CEPH_OSD_MAX_OP];
 143         s32               r_reply_op_result[CEPH_OSD_MAX_OP];
 144         int               r_got_reply;
 145         int               r_linger;
 146         int               r_completed;
 147
 148         struct ceph_osd_client *r_osdc;
 149         struct kref       r_kref;
 150         bool              r_mempool;
 151         struct completion r_completion, r_safe_completion;
 152         ceph_osdc_callback_t r_callback, r_safe_callback;
 153         struct ceph_eversion r_reassert_version;
 154         struct list_head  r_unsafe_item;
 155
 156         struct inode *r_inode;                /* for use by callbacks */
 157         void *r_priv;                         /* ditto */
 158
 159         char              r_oid[MAX_OBJ_NAME_SIZE];          /* object name */
 160         int               r_oid_len;
 161         u64               r_snapid;
 162         unsigned long     r_stamp;            /* send OR check time */
 163
 164         struct ceph_file_layout r_file_layout;
 165         struct ceph_snap_context *r_snapc;    /* snap context for writes */
 166 };
 167
 168 struct ceph_osd_event {
 169         u64 cookie;
 170         int one_shot;
 171         struct ceph_osd_client *osdc;
 172         void (*cb)(u64, u64, u8, void *);
 173         void *data;
 174         struct rb_node node;
 175         struct list_head osd_node;
 176         struct kref kref;
 177 };
 178
 179 struct ceph_osd_event_work {
 180         struct work_struct work;
 181         struct ceph_osd_event *event;
 182         u64 ver;
 183         u64 notify_id;
 184         u8 opcode;
 185 };
 186
 187 struct ceph_osd_client {
 188         struct ceph_client     *client;
 189
 190         struct ceph_osdmap     *osdmap;       /* current map */
 191         struct rw_semaphore    map_sem;
 192         struct completion      map_waiters;
 193         u64                    last_requested_map;
 194
 195         struct mutex           request_mutex;
 196         struct rb_root         osds;          /* osds */
 197         struct list_head       osd_lru;       /* idle osds */
 198         u64                    timeout_tid;   /* tid of timeout triggering rq */
 199         u64                    last_tid;      /* tid of last request */
 200         struct rb_root         requests;      /* pending requests */
 201         struct list_head       req_lru;       /* in-flight lru */
 202         struct list_head       req_unsent;    /* unsent/need-resend queue */
 203         struct list_head       req_notarget;  /* map to no osd */
 204         struct list_head       req_linger;    /* lingering requests */
 205         int                    num_requests;
 206         struct delayed_work    timeout_work;
 207         struct delayed_work    osds_timeout_work;
 208 #ifdef CONFIG_DEBUG_FS
 209         struct dentry          *debugfs_file;
 210 #endif
 211
 212         mempool_t              *req_mempool;
 213
 214         struct ceph_msgpool     msgpool_op;
 215         struct ceph_msgpool     msgpool_op_reply;
 216
 217         spinlock_t              event_lock;
 218         struct rb_root          event_tree;
 219         u64                     event_count;
 220
 221         struct workqueue_struct *notify_wq;
 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_extent_init(struct ceph_osd_request *osd_req,
 234                                         unsigned int which, u16 opcode,
 235                                         u64 offset, u64 length,
 236                                         u64 truncate_size, u32 truncate_seq);
 237 extern void osd_req_op_extent_update(struct ceph_osd_request *osd_req,
 238                                         unsigned int which, u64 length);
 239
 240 extern struct ceph_osd_data *osd_req_op_extent_osd_data(
 241                                         struct ceph_osd_request *osd_req,
 242                                         unsigned int which, bool write_request);
 243 extern struct ceph_osd_data *osd_req_op_cls_response_data(
 244                                         struct ceph_osd_request *osd_req,
 245                                         unsigned int which);
 246
 247 extern void osd_req_op_extent_osd_data_pages(struct ceph_osd_request *,
 248                                         unsigned int which, bool write_request,
 249                                         struct page **pages, u64 length,
 250                                         u32 alignment, bool pages_from_pool,
 251                                         bool own_pages);
 252 extern void osd_req_op_extent_osd_data_pagelist(struct ceph_osd_request *,
 253                                         unsigned int which, bool write_request,
 254                                         struct ceph_pagelist *pagelist);
 255 #ifdef CONFIG_BLOCK
 256 extern void osd_req_op_extent_osd_data_bio(struct ceph_osd_request *,
 257                                         unsigned int which, bool write_request,
 258                                         struct bio *bio, size_t bio_length);
 259 #endif /* CONFIG_BLOCK */
 260
 261 extern void osd_req_op_cls_request_data_pagelist(struct ceph_osd_request *,
 262                                         unsigned int which,
 263                                         struct ceph_pagelist *pagelist);
 264 extern void osd_req_op_cls_response_data_pages(struct ceph_osd_request *,
 265                                         unsigned int which,
 266                                         struct page **pages, u64 length,
 267                                         u32 alignment, bool pages_from_pool,
 268                                         bool own_pages);
 269
 270 extern void osd_req_op_cls_init(struct ceph_osd_request *osd_req,
 271                                         unsigned int which, u16 opcode,
 272                                         const char *class, const char *method);
 273 extern void osd_req_op_watch_init(struct ceph_osd_request *osd_req,
 274                                         unsigned int which, u16 opcode,
 275                                         u64 cookie, u64 version, int flag);
 276
 277 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
 278                                                struct ceph_snap_context *snapc,
 279                                                unsigned int num_ops,
 280                                                bool use_mempool,
 281                                                gfp_t gfp_flags);
 282
 283 extern void ceph_osdc_build_request(struct ceph_osd_request *req, u64 off,
 284                                     struct ceph_snap_context *snapc,
 285                                     u64 snap_id,
 286                                     struct timespec *mtime);
 287
 288 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
 289                                       struct ceph_file_layout *layout,
 290                                       struct ceph_vino vino,
 291                                       u64 offset, u64 *len,
 292                                       int num_ops, int opcode, int flags,
 293                                       struct ceph_snap_context *snapc,
 294                                       u32 truncate_seq, u64 truncate_size,
 295                                       bool use_mempool);
 296
 297 extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
 298                                          struct ceph_osd_request *req);
 299 extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
 300                                                 struct ceph_osd_request *req);
 301
 302 static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
 303 {
 304         kref_get(&req->r_kref);
 305 }
 306 extern void ceph_osdc_release_request(struct kref *kref);
 307 static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
 308 {
 309         kref_put(&req->r_kref, ceph_osdc_release_request);
 310 }
 311
 312 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
 313                                    struct ceph_osd_request *req,
 314                                    bool nofail);
 315 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
 316                                   struct ceph_osd_request *req);
 317 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
 318
 319 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
 320                                struct ceph_vino vino,
 321                                struct ceph_file_layout *layout,
 322                                u64 off, u64 *plen,
 323                                u32 truncate_seq, u64 truncate_size,
 324                                struct page **pages, int nr_pages,
 325                                int page_align);
 326
 327 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
 328                                 struct ceph_vino vino,
 329                                 struct ceph_file_layout *layout,
 330                                 struct ceph_snap_context *sc,
 331                                 u64 off, u64 len,
 332                                 u32 truncate_seq, u64 truncate_size,
 333                                 struct timespec *mtime,
 334                                 struct page **pages, int nr_pages);
 335
 336 /* watch/notify events */
 337 extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
 338                                   void (*event_cb)(u64, u64, u8, void *),
 339                                   void *data, struct ceph_osd_event **pevent);
 340 extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
 341 extern void ceph_osdc_put_event(struct ceph_osd_event *event);
 342 #endif
 343