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