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