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      100
  52 #define LDLM_BUFSIZE    (8 * 1024)
  53 #define LDLM_MAXREQSIZE 1024
  54
  55 #define MDT_NUM_THREADS 8
  56 #define MDS_NEVENTS     1024
  57 #define MDS_NBUFS       100
  58 #define MDS_BUFSIZE     (8 * 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, 1280UL)
  64 #define OST_BUFSIZE     ((OST_NEVENTS > 4096UL ? 32 : 8) * 1024)
  65 #define OST_MAXREQSIZE  (8 * 1024)
  66
  67 #define PTLBD_NUM_THREADS        4
  68 #define PTLBD_NEVENTS    1024
  69 #define PTLBD_NBUFS      20
  70 #define PTLBD_BUFSIZE    (32 * 1024)
  71 #define PTLBD_MAXREQSIZE 1024
  72
  73 #define CONN_INVALID 1
  74
  75 struct ptlrpc_connection {
  76         struct list_head        c_link;
  77         struct lustre_peer      c_peer;
  78         __u8                    c_local_uuid[37];  /* XXX do we need this? */
  79         __u8                    c_remote_uuid[37];
  80
  81         __u32                   c_generation;  /* changes upon new connection */
  82         __u32                   c_epoch;       /* changes when peer changes */
  83         __u32                   c_bootcount;   /* peer's boot count */
  84
  85         spinlock_t              c_lock;        /* also protects req->rq_list */
  86
  87         atomic_t                c_refcount;
  88         __u64                   c_token;
  89         __u64                   c_remote_conn;
  90         __u64                   c_remote_token;
  91
  92         struct list_head        c_delayed_head;/* delayed until post-recovery XXX imp? */
  93         struct recovd_data      c_recovd_data;
  94
  95         struct list_head        c_imports;
  96         struct list_head        c_exports;
  97         struct list_head        c_sb_chain;
  98         __u32                   c_flags; // can we indicate INVALID elsewhere?
  99 };
 100
 101 struct ptlrpc_client {
 102         __u32                     cli_request_portal;
 103         __u32                     cli_reply_portal;
 104
 105         __u32                     cli_target_devno;
 106
 107         void                     *cli_data;
 108         char                     *cli_name;
 109 };
 110
 111 /* state flags of requests */
 112 #define PTL_RPC_FL_INTR      (1 << 0)
 113 #define PTL_RPC_FL_REPLIED   (1 << 1)  /* reply was received */
 114 #define PTL_RPC_FL_SENT      (1 << 2)
 115 #define PTL_BULK_FL_SENT     (1 << 3)
 116 #define PTL_BULK_FL_RCVD     (1 << 4)
 117 #define PTL_RPC_FL_ERR       (1 << 5)
 118 #define PTL_RPC_FL_TIMEOUT   (1 << 6)
 119 #define PTL_RPC_FL_RESEND    (1 << 7)
 120 #define PTL_RPC_FL_RESTART   (1 << 8)  /* operation must be restarted */
 121 #define PTL_RPC_FL_FINISHED  (1 << 9)
 122 #define PTL_RPC_FL_RETAIN    (1 << 10) /* retain for replay after reply */
 123 #define PTL_RPC_FL_REPLAY    (1 << 11) /* replay upon recovery */
 124 #define PTL_RPC_FL_ALLOCREP  (1 << 12) /* reply buffer allocated */
 125
 126 struct ptlrpc_request {
 127         int rq_type; /* one of PTL_RPC_MSG_* */
 128         struct list_head rq_list;
 129         struct obd_device *rq_obd;
 130         int rq_status;
 131         int rq_flags;
 132         atomic_t rq_refcount;
 133
 134         int rq_request_portal; /* XXX FIXME bug 249 */
 135         int rq_reply_portal; /* XXX FIXME bug 249 */
 136
 137         int rq_reqlen;
 138         struct lustre_msg *rq_reqmsg;
 139
 140         int rq_replen;
 141         struct lustre_msg *rq_repmsg;
 142         __u64 rq_transno;
 143         __u64 rq_xid;
 144
 145         int rq_level;
 146         //        void * rq_reply_handle;
 147         wait_queue_head_t rq_wait_for_rep;
 148
 149         /* incoming reply */
 150         ptl_md_t rq_reply_md;
 151         ptl_handle_me_t rq_reply_me_h;
 152
 153         /* outgoing req/rep */
 154         ptl_md_t rq_req_md;
 155
 156         struct lustre_peer rq_peer; /* XXX see service.c can this be factored away? */
 157         struct obd_export *rq_export;
 158         struct ptlrpc_connection *rq_connection;
 159         struct obd_import *rq_import;
 160         struct ptlrpc_service *rq_svc;
 161
 162         void (*rq_replay_cb)(struct ptlrpc_request *);
 163 };
 164
 165 #define DEBUG_REQ(level, req, fmt, args...)                                    \
 166 do {                                                                           \
 167 CDEBUG(level,                                                                  \
 168        "@@@ " fmt " req@%p x"LPD64"/t"LPD64" o%d->%s:%d lens %d/%d ref %d fl " \
 169        "%x\n" ,  ## args, req, req->rq_xid, req->rq_reqmsg->transno,           \
 170        req->rq_reqmsg ? req->rq_reqmsg->opc : -1,                              \
 171        req->rq_connection ? (char *)req->rq_connection->c_remote_uuid : "<?>", \
 172        (req->rq_import && req->rq_import->imp_client) ?                        \
 173            req->rq_import->imp_client->cli_request_portal : -1,                \
 174        req->rq_reqlen, req->rq_replen,                                         \
 175        atomic_read (&req->rq_refcount), req->rq_flags);                        \
 176 } while (0)
 177
 178 struct ptlrpc_bulk_page {
 179         struct ptlrpc_bulk_desc *bp_desc;
 180         struct list_head bp_link;
 181         void *bp_buf;
 182         int bp_buflen;
 183         struct page *bp_page;
 184         __u32 bp_xid;
 185         __u32 bp_flags;
 186         struct dentry *bp_dentry;
 187         int (*bp_cb)(struct ptlrpc_bulk_page *);
 188 };
 189
 190
 191 struct ptlrpc_bulk_desc {
 192         struct list_head bd_set_chain; /* entry in obd_brw_set */
 193         struct obd_brw_set *bd_brw_set;
 194         int bd_flags;
 195         struct ptlrpc_connection *bd_connection;
 196         struct ptlrpc_client *bd_client;
 197         __u32 bd_portal;
 198         struct lustre_handle bd_conn;
 199         void (*bd_ptl_ev_hdlr)(struct ptlrpc_bulk_desc *);
 200
 201         wait_queue_head_t bd_waitq;
 202         struct list_head bd_page_list;
 203         __u32 bd_page_count;
 204         atomic_t bd_refcount;
 205         void *bd_desc_private;
 206
 207 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
 208         struct work_struct bd_queue;
 209 #else
 210         struct tq_struct bd_queue;
 211 #endif
 212
 213         ptl_md_t bd_md;
 214         ptl_handle_md_t bd_md_h;
 215         ptl_handle_me_t bd_me_h;
 216
 217         atomic_t bd_source_callback_count;
 218
 219         struct iovec bd_iov[16];    /* self-sized pre-allocated iov */
 220 };
 221
 222 struct ptlrpc_thread {
 223         struct list_head t_link;
 224
 225         __u32 t_flags;
 226         wait_queue_head_t t_ctl_waitq;
 227 };
 228
 229 struct ptlrpc_request_buffer_desc {
 230         struct list_head       rqbd_list;
 231         struct ptlrpc_service *rqbd_service;
 232         ptl_handle_me_t        rqbd_me_h;
 233         atomic_t               rqbd_refcount;
 234         char                  *rqbd_buffer;
 235 };
 236
 237 struct ptlrpc_service {
 238         time_t srv_time;
 239         time_t srv_timeout;
 240
 241         /* incoming request buffers */
 242         /* FIXME: perhaps a list of EQs, if multiple NIs are used? */
 243
 244         __u32            srv_max_req_size;     /* biggest request to receive */
 245         __u32            srv_buf_size;         /* # bytes in a request buffer */
 246         struct list_head srv_rqbds;            /* all the request buffer descriptors */
 247         __u32            srv_nrqbds;           /* # request buffers */
 248         atomic_t         srv_nrqbds_receiving; /* # request buffers posted for input */
 249
 250         __u32 srv_req_portal;
 251         __u32 srv_rep_portal;
 252
 253         __u32 srv_xid;
 254
 255         /* event queue */
 256         ptl_handle_eq_t srv_eq_h;
 257
 258         struct lustre_peer srv_self;
 259
 260         wait_queue_head_t srv_waitq; /* all threads sleep on this */
 261
 262         spinlock_t srv_lock;
 263         struct list_head srv_threads;
 264         int (*srv_handler)(struct ptlrpc_request *req);
 265         char *srv_name;  /* only statically allocated strings here; we don't clean them */
 266 };
 267
 268 static inline void ptlrpc_hdl2req(struct ptlrpc_request *req,
 269                                   struct lustre_handle *h)
 270 {
 271         req->rq_reqmsg->addr = h->addr;
 272         req->rq_reqmsg->cookie = h->cookie;
 273 }
 274
 275 typedef void (*bulk_callback_t)(struct ptlrpc_bulk_desc *, void *);
 276
 277 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
 278
 279 /* rpc/connection.c */
 280 void ptlrpc_readdress_connection(struct ptlrpc_connection *, obd_uuid_t uuid);
 281 struct ptlrpc_connection *ptlrpc_get_connection(struct lustre_peer *peer,
 282                                                 obd_uuid_t uuid);
 283 int ptlrpc_put_connection(struct ptlrpc_connection *c);
 284 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
 285 void ptlrpc_init_connection(void);
 286 void ptlrpc_cleanup_connection(void);
 287
 288 /* rpc/niobuf.c */
 289 int ptlrpc_check_bulk_sent(struct ptlrpc_bulk_desc *bulk);
 290 int ptlrpc_check_bulk_received(struct ptlrpc_bulk_desc *bulk);
 291 int ptlrpc_send_bulk(struct ptlrpc_bulk_desc *);
 292 int ptlrpc_register_bulk(struct ptlrpc_bulk_desc *);
 293 int ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *bulk);
 294 struct obd_brw_set *obd_brw_set_new(void);
 295 void obd_brw_set_add(struct obd_brw_set *, struct ptlrpc_bulk_desc *);
 296 void obd_brw_set_free(struct obd_brw_set *);
 297
 298 int ptlrpc_reply(struct ptlrpc_service *svc, struct ptlrpc_request *req);
 299 int ptlrpc_error(struct ptlrpc_service *svc, struct ptlrpc_request *req);
 300 void ptlrpc_resend_req(struct ptlrpc_request *request);
 301 int ptl_send_rpc(struct ptlrpc_request *request);
 302 void ptlrpc_link_svc_me(struct ptlrpc_request_buffer_desc *rqbd);
 303
 304 /* rpc/client.c */
 305 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
 306                         struct ptlrpc_client *);
 307 void ptlrpc_cleanup_client(struct obd_import *imp);
 308 __u8 *ptlrpc_req_to_uuid(struct ptlrpc_request *req);
 309 struct ptlrpc_connection *ptlrpc_uuid_to_connection(obd_uuid_t uuid);
 310
 311 int ll_brw_sync_wait(struct obd_brw_set *, int phase);
 312
 313 int ptlrpc_queue_wait(struct ptlrpc_request *req);
 314 void ptlrpc_continue_req(struct ptlrpc_request *req);
 315 int ptlrpc_replay_req(struct ptlrpc_request *req);
 316 void ptlrpc_restart_req(struct ptlrpc_request *req);
 317 void ptlrpc_abort_inflight(struct obd_import *imp);
 318
 319 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, int opcode,
 320                                        int count, int *lengths, char **bufs);
 321 void ptlrpc_free_req(struct ptlrpc_request *request);
 322 void ptlrpc_req_finished(struct ptlrpc_request *request);
 323 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk(struct ptlrpc_connection *);
 324 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
 325 struct ptlrpc_bulk_page *ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc);
 326 void ptlrpc_free_bulk_page(struct ptlrpc_bulk_page *page);
 327
 328 /* rpc/service.c */
 329 struct ptlrpc_service *
 330 ptlrpc_init_svc(__u32 nevents, __u32 nbufs, __u32 bufsize, __u32 max_req_size,
 331                 int req_portal, int rep_portal,
 332                 obd_uuid_t uuid, svc_handler_t, char *name);
 333 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
 334 int ptlrpc_start_thread(struct obd_device *dev, struct ptlrpc_service *svc,
 335                         char *name);
 336 int ptlrpc_unregister_service(struct ptlrpc_service *service);
 337
 338 struct ptlrpc_svc_data {
 339         char *name;
 340         struct ptlrpc_service *svc;
 341         struct ptlrpc_thread *thread;
 342         struct obd_device *dev;
 343 };
 344
 345 /* rpc/pack_generic.c */
 346 int lustre_pack_msg(int count, int *lens, char **bufs, int *len,
 347                     struct lustre_msg **msg);
 348 int lustre_msg_size(int count, int *lengths);
 349 int lustre_unpack_msg(struct lustre_msg *m, int len);
 350 void *lustre_msg_buf(struct lustre_msg *m, int n);
 351
 352 static inline void ptlrpc_bulk_decref(struct ptlrpc_bulk_desc *desc)
 353 {
 354         CDEBUG(D_PAGE, "%p -> %d\n", desc, atomic_read(&desc->bd_refcount) - 1);
 355
 356         if (atomic_dec_and_test(&desc->bd_refcount)) {
 357                 CDEBUG(D_PAGE, "Released last ref on %p, freeing\n", desc);
 358                 ptlrpc_free_bulk(desc);
 359         }
 360 }
 361
 362 static inline void ptlrpc_bulk_addref(struct ptlrpc_bulk_desc *desc)
 363 {
 364         atomic_inc(&desc->bd_refcount);
 365         CDEBUG(D_PAGE, "Set refcount of %p to %d\n", desc,
 366                atomic_read(&desc->bd_refcount));
 367 }
 368
 369 #endif