lustre/include/linux/lustre_net.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2002 Cluster File Systems, Inc.
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  */
  22
  23 #ifndef _LUSTRE_NET_H
  24 #define _LUSTRE_NET_H
  25
  26 #include <linux/tqueue.h>
  27 #include <linux/kp30.h>
  28 // #include <linux/obd.h>
  29 #include <portals/p30.h>
  30 #include <linux/lustre_idl.h>
  31 #include <linux/lustre_ha.h>
  32 #include <linux/lustre_import.h>
  33
  34 /* The following constants determine how much memory is devoted to
  35  * buffering in the lustre services.
  36  *
  37  * ?_NEVENTS            # event queue entries
  38  *
  39  * ?_NBUFS              # request buffers
  40  * ?_BUFSIZE            # bytes in a single request buffer
  41  * total memory = ?_NBUFS * ?_BUFSIZE
  42  *
  43  * ?_MAXREQSIZE         # maximum request service will receive
  44  * larger messages will get dropped.
  45  * request buffers are auto-unlinked when less than ?_MAXREQSIZE
  46  * is left in them.
  47  */
  48
  49 #define LDLM_NUM_THREADS        4
  50 #define LDLM_NEVENTS    1024
  51 #define LDLM_NBUFS      10
  52 #define LDLM_BUFSIZE    (64 * 1024)
  53 #define LDLM_MAXREQSIZE 1024
  54
  55 #define MDT_NUM_THREADS 8
  56 #define MDS_NEVENTS     1024
  57 #define MDS_NBUFS       10
  58 #define MDS_BUFSIZE     (64 * 1024)
  59 #define MDS_MAXREQSIZE  1024
  60
  61 #define OST_NUM_THREADS 6
  62 #define OST_NEVENTS     min(num_physpages / 16, 32768UL)
  63 #define OST_NBUFS       min(OST_NEVENTS / 128, 256UL)
  64 #define OST_BUFSIZE     ((OST_NEVENTS > 4096UL ? 128 : 64) * 1024)
  65 #define OST_MAXREQSIZE  (8 * 1024)
  66
  67 #define CONN_INVALID 1
  68
  69 struct ptlrpc_connection {
  70         struct list_head        c_link;
  71         struct lustre_peer      c_peer;
  72         __u8                    c_local_uuid[37];  /* XXX do we need this? */
  73         __u8                    c_remote_uuid[37];
  74
  75         __u32                   c_generation;  /* changes upon new connection */
  76         __u32                   c_epoch;       /* changes when peer changes */
  77         __u32                   c_bootcount;   /* peer's boot count */
  78
  79         spinlock_t              c_lock;        /* also protects req->rq_list */
  80
  81         atomic_t                c_refcount;
  82         __u64                   c_token;
  83         __u64                   c_remote_conn;
  84         __u64                   c_remote_token;
  85
  86         struct list_head        c_delayed_head;/* delayed until post-recovery XXX imp? */
  87         struct recovd_data      c_recovd_data;
  88
  89         struct list_head        c_imports;
  90         struct list_head        c_exports;
  91         struct list_head        c_sb_chain;
  92         __u32                   c_flags; // can we indicate INVALID elsewhere?
  93 };
  94
  95 struct ptlrpc_client {
  96         __u32                     cli_request_portal;
  97         __u32                     cli_reply_portal;
  98
  99         __u32                     cli_target_devno;
 100
 101         void                     *cli_data;
 102         char                     *cli_name;
 103 };
 104
 105 /* state flags of requests */
 106 #define PTL_RPC_FL_INTR      (1 << 0)
 107 #define PTL_RPC_FL_REPLIED   (1 << 1)  /* reply was received */
 108 #define PTL_RPC_FL_SENT      (1 << 2)
 109 #define PTL_BULK_FL_SENT     (1 << 3)
 110 #define PTL_BULK_FL_RCVD     (1 << 4)
 111 #define PTL_RPC_FL_ERR       (1 << 5)
 112 #define PTL_RPC_FL_TIMEOUT   (1 << 6)
 113 #define PTL_RPC_FL_RESEND    (1 << 7)
 114 #define PTL_RPC_FL_RESTART   (1 << 8)  /* operation must be restarted */
 115 #define PTL_RPC_FL_FINISHED  (1 << 9)
 116 #define PTL_RPC_FL_RETAIN    (1 << 10) /* retain for replay after reply */
 117 #define PTL_RPC_FL_REPLAY    (1 << 11) /* replay upon recovery */
 118 #define PTL_RPC_FL_ALLOCREP  (1 << 12) /* reply buffer allocated */
 119
 120 struct ptlrpc_request {
 121         int rq_type; /* one of PTL_RPC_MSG_* */
 122         struct list_head rq_list;
 123         struct obd_device *rq_obd;
 124         int rq_status;
 125         int rq_flags;
 126         atomic_t rq_refcount;
 127
 128         int rq_request_portal; /* XXX FIXME bug 249 */
 129         int rq_reply_portal; /* XXX FIXME bug 249 */
 130
 131         int rq_reqlen;
 132         struct lustre_msg *rq_reqmsg;
 133
 134         int rq_replen;
 135         struct lustre_msg *rq_repmsg;
 136         __u64 rq_transno;
 137         __u64 rq_xid;
 138
 139         int rq_level;
 140         time_t rq_timeout;
 141         //        void * rq_reply_handle;
 142         wait_queue_head_t rq_wait_for_rep;
 143
 144         /* incoming reply */
 145         ptl_md_t rq_reply_md;
 146         ptl_handle_me_t rq_reply_me_h;
 147
 148         /* outgoing req/rep */
 149         ptl_md_t rq_req_md;
 150
 151         struct lustre_peer rq_peer; /* XXX see service.c can this be factored away? */
 152         struct obd_export *rq_export;
 153         struct ptlrpc_connection *rq_connection;
 154         struct obd_import *rq_import;
 155         struct ptlrpc_service *rq_svc;
 156
 157         void (*rq_replay_cb)(struct ptlrpc_request *);
 158 };
 159
 160 #define DEBUG_REQ(level, req, fmt, args...)                                    \
 161 do {                                                                           \
 162 CDEBUG(level,                                                                  \
 163        "@@@ " fmt " req x"LPD64"/t"LPD64" o%d->%s:%d lens %d/%d ref %d fl "    \
 164        "%x\n" ,  ## args, req->rq_xid, req->rq_transno,                        \
 165        req->rq_reqmsg ? req->rq_reqmsg->opc : -1,                              \
 166        req->rq_connection ? (char *)req->rq_connection->c_remote_uuid : "<?>", \
 167        (req->rq_import && req->rq_import->imp_client) ?                        \
 168            req->rq_import->imp_client->cli_request_portal : -1,                \
 169        req->rq_reqlen, req->rq_replen, req->rq_refcount, req->rq_flags);       \
 170 } while (0)
 171
 172 struct ptlrpc_bulk_page {
 173         struct ptlrpc_bulk_desc *bp_desc;
 174         struct list_head bp_link;
 175         void *bp_buf;
 176         int bp_buflen;
 177         struct page *bp_page;
 178         __u32 bp_xid;
 179         __u32 bp_flags;
 180         struct dentry *bp_dentry;
 181         int (*bp_cb)(struct ptlrpc_bulk_page *);
 182 };
 183
 184
 185 struct ptlrpc_bulk_desc {
 186         struct list_head bd_set_chain; /* entry in obd_brw_set */
 187         struct obd_brw_set *bd_brw_set;
 188         int bd_flags;
 189         struct ptlrpc_connection *bd_connection;
 190         struct ptlrpc_client *bd_client;
 191         __u32 bd_portal;
 192         struct lustre_handle bd_conn;
 193         void (*bd_ptl_ev_hdlr)(struct ptlrpc_bulk_desc *);
 194
 195         wait_queue_head_t bd_waitq;
 196         struct list_head bd_page_list;
 197         __u32 bd_page_count;
 198         atomic_t bd_refcount;
 199         void *bd_desc_private;
 200
 201 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
 202         struct work_struct bd_queue;
 203 #else
 204         struct tq_struct bd_queue;
 205 #endif
 206
 207         ptl_md_t bd_md;
 208         ptl_handle_md_t bd_md_h;
 209         ptl_handle_me_t bd_me_h;
 210
 211         atomic_t bd_source_callback_count;
 212
 213         struct iovec bd_iov[16];    /* self-sized pre-allocated iov */
 214 };
 215
 216 struct ptlrpc_thread {
 217         struct list_head t_link;
 218
 219         __u32 t_flags;
 220         wait_queue_head_t t_ctl_waitq;
 221 };
 222
 223 struct ptlrpc_request_buffer_desc {
 224         struct list_head       rqbd_list;
 225         struct ptlrpc_service *rqbd_service;
 226         ptl_handle_me_t        rqbd_me_h;
 227         atomic_t               rqbd_refcount;
 228         char                  *rqbd_buffer;
 229 };
 230
 231 struct ptlrpc_service {
 232         time_t srv_time;
 233         time_t srv_timeout;
 234
 235         /* incoming request buffers */
 236         /* FIXME: perhaps a list of EQs, if multiple NIs are used? */
 237
 238         __u32            srv_max_req_size;     /* biggest request to receive */
 239         __u32            srv_buf_size;         /* # bytes in a request buffer */
 240         struct list_head srv_rqbds;            /* all the request buffer descriptors */
 241         __u32            srv_nrqbds;           /* # request buffers */
 242         atomic_t         srv_nrqbds_receiving; /* # request buffers posted for input */
 243
 244         __u32 srv_req_portal;
 245         __u32 srv_rep_portal;
 246
 247         __u32 srv_xid;
 248
 249         /* event queue */
 250         ptl_handle_eq_t srv_eq_h;
 251
 252         struct lustre_peer srv_self;
 253
 254         wait_queue_head_t srv_waitq; /* all threads sleep on this */
 255
 256         spinlock_t srv_lock;
 257         struct list_head srv_threads;
 258         int (*srv_handler)(struct ptlrpc_request *req);
 259         char *srv_name;  /* only statically allocated strings here; we don't clean them */
 260 };
 261
 262 static inline void ptlrpc_hdl2req(struct ptlrpc_request *req,
 263                                   struct lustre_handle *h)
 264 {
 265         req->rq_reqmsg->addr = h->addr;
 266         req->rq_reqmsg->cookie = h->cookie;
 267 }
 268
 269 typedef void (*bulk_callback_t)(struct ptlrpc_bulk_desc *, void *);
 270
 271 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
 272
 273 /* rpc/connection.c */
 274 void ptlrpc_readdress_connection(struct ptlrpc_connection *, obd_uuid_t uuid);
 275 struct ptlrpc_connection *ptlrpc_get_connection(struct lustre_peer *peer,
 276                                                 obd_uuid_t uuid);
 277 int ptlrpc_put_connection(struct ptlrpc_connection *c);
 278 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
 279 void ptlrpc_init_connection(void);
 280 void ptlrpc_cleanup_connection(void);
 281
 282 /* rpc/niobuf.c */
 283 int ptlrpc_check_bulk_sent(struct ptlrpc_bulk_desc *bulk);
 284 int ptlrpc_check_bulk_received(struct ptlrpc_bulk_desc *bulk);
 285 int ptlrpc_send_bulk(struct ptlrpc_bulk_desc *);
 286 int ptlrpc_register_bulk(struct ptlrpc_bulk_desc *);
 287 int ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *bulk);
 288 struct obd_brw_set *obd_brw_set_new(void);
 289 void obd_brw_set_add(struct obd_brw_set *, struct ptlrpc_bulk_desc *);
 290 void obd_brw_set_free(struct obd_brw_set *);
 291
 292 int ptlrpc_reply(struct ptlrpc_service *svc, struct ptlrpc_request *req);
 293 int ptlrpc_error(struct ptlrpc_service *svc, struct ptlrpc_request *req);
 294 void ptlrpc_resend_req(struct ptlrpc_request *request);
 295 int ptl_send_rpc(struct ptlrpc_request *request);
 296 void ptlrpc_link_svc_me(struct ptlrpc_request_buffer_desc *rqbd);
 297
 298 /* rpc/client.c */
 299 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
 300                         struct ptlrpc_client *);
 301 void ptlrpc_cleanup_client(struct obd_import *imp);
 302 __u8 *ptlrpc_req_to_uuid(struct ptlrpc_request *req);
 303 struct ptlrpc_connection *ptlrpc_uuid_to_connection(obd_uuid_t uuid);
 304
 305 int ll_brw_sync_wait(struct obd_brw_set *, int phase);
 306
 307 int ptlrpc_queue_wait(struct ptlrpc_request *req);
 308 void ptlrpc_continue_req(struct ptlrpc_request *req);
 309 int ptlrpc_replay_req(struct ptlrpc_request *req);
 310 void ptlrpc_restart_req(struct ptlrpc_request *req);
 311
 312 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, int opcode,
 313                                        int count, int *lengths, char **bufs);
 314 void ptlrpc_free_req(struct ptlrpc_request *request);
 315 void ptlrpc_req_finished(struct ptlrpc_request *request);
 316 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk(struct ptlrpc_connection *);
 317 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
 318 struct ptlrpc_bulk_page *ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc);
 319 void ptlrpc_free_bulk_page(struct ptlrpc_bulk_page *page);
 320
 321 /* rpc/service.c */
 322 struct ptlrpc_service *
 323 ptlrpc_init_svc(__u32 nevents, __u32 nbufs, __u32 bufsize, __u32 max_req_size,
 324                 int req_portal, int rep_portal,
 325                 obd_uuid_t uuid, svc_handler_t, char *name);
 326 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
 327 int ptlrpc_start_thread(struct obd_device *dev, struct ptlrpc_service *svc,
 328                         char *name);
 329 int ptlrpc_unregister_service(struct ptlrpc_service *service);
 330
 331 struct ptlrpc_svc_data {
 332         char *name;
 333         struct ptlrpc_service *svc;
 334         struct ptlrpc_thread *thread;
 335         struct obd_device *dev;
 336 };
 337
 338 /* rpc/pack_generic.c */
 339 int lustre_pack_msg(int count, int *lens, char **bufs, int *len,
 340                     struct lustre_msg **msg);
 341 int lustre_msg_size(int count, int *lengths);
 342 int lustre_unpack_msg(struct lustre_msg *m, int len);
 343 void *lustre_msg_buf(struct lustre_msg *m, int n);
 344
 345 static inline void ptlrpc_bulk_decref(struct ptlrpc_bulk_desc *desc)
 346 {
 347         if (atomic_dec_and_test(&desc->bd_refcount)) {
 348                 CDEBUG(D_PAGE, "Released last ref on %p, freeing\n", desc);
 349                 ptlrpc_free_bulk(desc);
 350         } else {
 351                 CDEBUG(D_PAGE, "%p -> %d\n", desc,
 352                        atomic_read(&desc->bd_refcount));
 353         }
 354 }
 355
 356 static inline void ptlrpc_bulk_addref(struct ptlrpc_bulk_desc *desc)
 357 {
 358         atomic_inc(&desc->bd_refcount);
 359         CDEBUG(D_PAGE, "Set refcount of %p to %d\n", desc,
 360                atomic_read(&desc->bd_refcount));
 361 }
 362
 363 #endif