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 /* an in-flight request */
  51 struct ceph_osd_request {
  52         u64             r_tid;              /* unique for this client */
  53         struct rb_node  r_node;
  54         struct list_head r_req_lru_item;
  55         struct list_head r_osd_item;
  56         struct list_head r_linger_item;
  57         struct list_head r_linger_osd;
  58         struct ceph_osd *r_osd;
  59         struct ceph_pg   r_pgid;
  60         int              r_pg_osds[CEPH_PG_MAX_SIZE];
  61         int              r_num_pg_osds;
  62
  63         struct ceph_connection *r_con_filling_msg;
  64
  65         struct ceph_msg  *r_request, *r_reply;
  66         int               r_result;
  67         int               r_flags;     /* any additional flags for the osd */
  68         u32               r_sent;      /* >0 if r_request is sending/sent */
  69         int               r_got_reply;
  70         int               r_linger;
  71
  72         struct ceph_osd_client *r_osdc;
  73         struct kref       r_kref;
  74         bool              r_mempool;
  75         struct completion r_completion, r_safe_completion;
  76         ceph_osdc_callback_t r_callback, r_safe_callback;
  77         struct ceph_eversion r_reassert_version;
  78         struct list_head  r_unsafe_item;
  79
  80         struct inode *r_inode;                /* for use by callbacks */
  81         void *r_priv;                         /* ditto */
  82
  83         char              r_oid[MAX_OBJ_NAME_SIZE];          /* object name */
  84         int               r_oid_len;
  85         unsigned long     r_stamp;            /* send OR check time */
  86
  87         struct ceph_file_layout r_file_layout;
  88         struct ceph_snap_context *r_snapc;    /* snap context for writes */
  89         unsigned          r_num_pages;        /* size of page array (follows) */
  90         unsigned          r_page_alignment;   /* io offset in first page */
  91         struct page     **r_pages;            /* pages for data payload */
  92         int               r_pages_from_pool;
  93         int               r_own_pages;        /* if true, i own page list */
  94 #ifdef CONFIG_BLOCK
  95         struct bio       *r_bio;              /* instead of pages */
  96 #endif
  97
  98         struct ceph_pagelist r_trail;         /* trailing part of the data */
  99 };
 100
 101 struct ceph_osd_event {
 102         u64 cookie;
 103         int one_shot;
 104         struct ceph_osd_client *osdc;
 105         void (*cb)(u64, u64, u8, void *);
 106         void *data;
 107         struct rb_node node;
 108         struct list_head osd_node;
 109         struct kref kref;
 110         struct completion completion;
 111 };
 112
 113 struct ceph_osd_event_work {
 114         struct work_struct work;
 115         struct ceph_osd_event *event;
 116         u64 ver;
 117         u64 notify_id;
 118         u8 opcode;
 119 };
 120
 121 struct ceph_osd_client {
 122         struct ceph_client     *client;
 123
 124         struct ceph_osdmap     *osdmap;       /* current map */
 125         struct rw_semaphore    map_sem;
 126         struct completion      map_waiters;
 127         u64                    last_requested_map;
 128
 129         struct mutex           request_mutex;
 130         struct rb_root         osds;          /* osds */
 131         struct list_head       osd_lru;       /* idle osds */
 132         u64                    timeout_tid;   /* tid of timeout triggering rq */
 133         u64                    last_tid;      /* tid of last request */
 134         struct rb_root         requests;      /* pending requests */
 135         struct list_head       req_lru;       /* in-flight lru */
 136         struct list_head       req_unsent;    /* unsent/need-resend queue */
 137         struct list_head       req_notarget;  /* map to no osd */
 138         struct list_head       req_linger;    /* lingering requests */
 139         int                    num_requests;
 140         struct delayed_work    timeout_work;
 141         struct delayed_work    osds_timeout_work;
 142 #ifdef CONFIG_DEBUG_FS
 143         struct dentry          *debugfs_file;
 144 #endif
 145
 146         mempool_t              *req_mempool;
 147
 148         struct ceph_msgpool     msgpool_op;
 149         struct ceph_msgpool     msgpool_op_reply;
 150
 151         spinlock_t              event_lock;
 152         struct rb_root          event_tree;
 153         u64                     event_count;
 154
 155         struct workqueue_struct *notify_wq;
 156 };
 157
 158 struct ceph_osd_req_op {
 159         u16 op;           /* CEPH_OSD_OP_* */
 160         u32 flags;        /* CEPH_OSD_FLAG_* */
 161         union {
 162                 struct {
 163                         u64 offset, length;
 164                         u64 truncate_size;
 165                         u32 truncate_seq;
 166                 } extent;
 167                 struct {
 168                         const char *name;
 169                         u32 name_len;
 170                         const char  *val;
 171                         u32 value_len;
 172                         __u8 cmp_op;       /* CEPH_OSD_CMPXATTR_OP_* */
 173                         __u8 cmp_mode;     /* CEPH_OSD_CMPXATTR_MODE_* */
 174                 } xattr;
 175                 struct {
 176                         const char *class_name;
 177                         __u8 class_len;
 178                         const char *method_name;
 179                         __u8 method_len;
 180                         __u8 argc;
 181                         const char *indata;
 182                         u32 indata_len;
 183                 } cls;
 184                 struct {
 185                         u64 cookie, count;
 186                 } pgls;
 187                 struct {
 188                         u64 snapid;
 189                 } snap;
 190                 struct {
 191                         u64 cookie;
 192                         u64 ver;
 193                         __u8 flag;
 194                         u32 prot_ver;
 195                         u32 timeout;
 196                 } watch;
 197         };
 198         u32 payload_len;
 199 };
 200
 201 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
 202                           struct ceph_client *client);
 203 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
 204
 205 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
 206                                    struct ceph_msg *msg);
 207 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
 208                                  struct ceph_msg *msg);
 209
 210 extern int ceph_calc_raw_layout(struct ceph_file_layout *layout,
 211                         u64 off, u64 *plen, u64 *bno,
 212                         struct ceph_osd_request *req,
 213                         struct ceph_osd_req_op *op);
 214
 215 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
 216                                                struct ceph_snap_context *snapc,
 217                                                struct ceph_osd_req_op *ops,
 218                                                bool use_mempool,
 219                                                gfp_t gfp_flags,
 220                                                struct page **pages,
 221                                                struct bio *bio);
 222
 223 extern void ceph_osdc_build_request(struct ceph_osd_request *req,
 224                                     u64 off, u64 len,
 225                                     struct ceph_osd_req_op *src_ops,
 226                                     struct ceph_snap_context *snapc,
 227                                     u64 snap_id,
 228                                     struct timespec *mtime);
 229
 230 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
 231                                       struct ceph_file_layout *layout,
 232                                       struct ceph_vino vino,
 233                                       u64 offset, u64 *len, int op, int flags,
 234                                       struct ceph_snap_context *snapc,
 235                                       int do_sync, u32 truncate_seq,
 236                                       u64 truncate_size,
 237                                       struct timespec *mtime,
 238                                       bool use_mempool, int num_reply,
 239                                       int page_align);
 240
 241 extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
 242                                          struct ceph_osd_request *req);
 243 extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
 244                                                 struct ceph_osd_request *req);
 245
 246 static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
 247 {
 248         kref_get(&req->r_kref);
 249 }
 250 extern void ceph_osdc_release_request(struct kref *kref);
 251 static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
 252 {
 253         kref_put(&req->r_kref, ceph_osdc_release_request);
 254 }
 255
 256 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
 257                                    struct ceph_osd_request *req,
 258                                    bool nofail);
 259 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
 260                                   struct ceph_osd_request *req);
 261 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
 262
 263 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
 264                                struct ceph_vino vino,
 265                                struct ceph_file_layout *layout,
 266                                u64 off, u64 *plen,
 267                                u32 truncate_seq, u64 truncate_size,
 268                                struct page **pages, int nr_pages,
 269                                int page_align);
 270
 271 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
 272                                 struct ceph_vino vino,
 273                                 struct ceph_file_layout *layout,
 274                                 struct ceph_snap_context *sc,
 275                                 u64 off, u64 len,
 276                                 u32 truncate_seq, u64 truncate_size,
 277                                 struct timespec *mtime,
 278                                 struct page **pages, int nr_pages,
 279                                 int flags, int do_sync, bool nofail);
 280
 281 /* watch/notify events */
 282 extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
 283                                   void (*event_cb)(u64, u64, u8, void *),
 284                                   int one_shot, void *data,
 285                                   struct ceph_osd_event **pevent);
 286 extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
 287 extern int ceph_osdc_wait_event(struct ceph_osd_event *event,
 288                                 unsigned long timeout);
 289 extern void ceph_osdc_put_event(struct ceph_osd_event *event);
 290 #endif
 291