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