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_NEVENTS    1024
  50 #define LDLM_NBUFS      10
  51 #define LDLM_BUFSIZE    (64 * 1024)
  52 #define LDLM_MAXREQSIZE 1024
  53
  54 #define MDS_NEVENTS     1024
  55 #define MDS_NBUFS       10
  56 #define MDS_BUFSIZE     (64 * 1024)
  57 #define MDS_MAXREQSIZE  1024
  58
  59 #define OST_NEVENTS     min(num_physpages / 16, 32768UL)
  60 #define OST_NBUFS       min(OST_NEVENTS / 128, 256UL)
  61 #define OST_BUFSIZE     ((OST_NEVENTS > 4096UL ? 128 : 64) * 1024)
  62 #define OST_MAXREQSIZE  (8 * 1024)
  63
  64 #define CONN_INVALID 1
  65
  66 struct ptlrpc_connection {
  67         struct list_head        c_link;
  68         struct lustre_peer      c_peer;
  69         __u8                    c_local_uuid[37];  /* XXX do we need this? */
  70         __u8                    c_remote_uuid[37];
  71
  72         int                     c_level;
  73         __u32                   c_generation;  /* changes upon new connection */
  74         __u32                   c_epoch;       /* changes when peer changes */
  75         __u32                   c_bootcount;   /* peer's boot count */
  76
  77         spinlock_t              c_lock;        /* also protects req->rq_list */
  78         __u32                   c_xid_in;
  79         __u32                   c_xid_out;
  80
  81         atomic_t                c_refcount;
  82         __u64                   c_token;
  83         __u64                   c_remote_conn;
  84         __u64                   c_remote_token;
  85
  86         __u64                   c_last_xid;    /* protected by c_lock */
  87         __u64                   c_last_committed;/* protected by c_lock */
  88         struct list_head        c_delayed_head;/* delayed until post-recovery */
  89         struct list_head        c_sending_head;/* protected by c_lock */
  90         struct list_head        c_dying_head;  /* protected by c_lock */
  91         struct recovd_data      c_recovd_data;
  92
  93         struct list_head        c_imports;
  94         struct list_head        c_exports;
  95         struct list_head        c_sb_chain;
  96         __u32                   c_flags; /* can we indicate INVALID elsewhere? */
  97 };
  98
  99 struct ptlrpc_client {
 100         __u32                     cli_request_portal;
 101         __u32                     cli_reply_portal;
 102
 103         __u32                     cli_target_devno;
 104
 105         void                     *cli_data;
 106         // struct semaphore          cli_rpc_sem; /* limits outstanding requests */
 107
 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_RECOVERY  (1 << 8)  /* retransmission for recovery */
 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_reqlen;
 135         struct lustre_msg *rq_reqmsg;
 136
 137         int rq_replen;
 138         struct lustre_msg *rq_repmsg;
 139         __u64 rq_transno;
 140         __u64 rq_xid;
 141
 142         int rq_level;
 143         time_t rq_timeout;
 144         //        void * rq_reply_handle;
 145         wait_queue_head_t rq_wait_for_rep;
 146
 147         /* incoming reply */
 148         ptl_md_t rq_reply_md;
 149         ptl_handle_md_t rq_reply_md_h; /* we can lose this: set, never read */
 150         ptl_handle_me_t rq_reply_me_h;
 151
 152         /* outgoing req/rep */
 153         ptl_md_t rq_req_md;
 154
 155         struct lustre_peer rq_peer; /* XXX see service.c can this be factored away? */
 156         struct obd_export *rq_export;
 157         struct ptlrpc_connection *rq_connection;
 158         struct obd_import *rq_import;
 159         struct ptlrpc_service *rq_svc;
 160
 161         void (*rq_replay_cb)(struct ptlrpc_request *, void *);
 162         void *rq_replay_cb_data;
 163 };
 164
 165 struct ptlrpc_bulk_page {
 166         struct ptlrpc_bulk_desc *bp_desc;
 167         struct list_head bp_link;
 168         void *bp_buf;
 169         int bp_buflen;
 170         struct page *bp_page;
 171         __u32 bp_xid;
 172         __u32 bp_flags;
 173         struct dentry *bp_dentry;
 174         int (*bp_cb)(struct ptlrpc_bulk_page *);
 175 };
 176
 177
 178 struct ptlrpc_bulk_desc {
 179         int bd_flags;
 180         struct ptlrpc_connection *bd_connection;
 181         struct ptlrpc_client *bd_client;
 182         __u32 bd_portal;
 183         struct lustre_handle bd_conn;
 184         void (*bd_cb)(struct ptlrpc_bulk_desc *, void *);
 185         void *bd_cb_data;
 186
 187         wait_queue_head_t bd_waitq;
 188         struct list_head bd_page_list;
 189         __u32 bd_page_count;
 190         atomic_t bd_refcount;
 191         void *bd_desc_private;
 192
 193 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
 194         struct work_struct bd_queue;
 195 #else
 196         struct tq_struct bd_queue;
 197 #endif
 198
 199         ptl_md_t bd_md;
 200         ptl_handle_md_t bd_md_h;
 201         ptl_handle_me_t bd_me_h;
 202
 203         atomic_t        bd_source_callback_count;
 204
 205         struct iovec bd_iov[16];    /* self-sized pre-allocated iov */
 206 };
 207
 208 struct ptlrpc_thread {
 209         struct list_head t_link;
 210
 211         __u32 t_flags;
 212         wait_queue_head_t t_ctl_waitq;
 213 };
 214
 215 struct ptlrpc_request_buffer_desc {
 216         struct list_head       rqbd_list;
 217         struct ptlrpc_service *rqbd_service;
 218         ptl_handle_me_t        rqbd_me_h;
 219         atomic_t               rqbd_refcount;
 220         char                  *rqbd_buffer;
 221 };
 222
 223 struct ptlrpc_service {
 224         time_t srv_time;
 225         time_t srv_timeout;
 226
 227         /* incoming request buffers */
 228         /* FIXME: perhaps a list of EQs, if multiple NIs are used? */
 229
 230         __u32            srv_max_req_size;      /* biggest request to receive */
 231         __u32            srv_buf_size;          /* # bytes in a request buffer */
 232         struct list_head srv_rqbds;             /* all the request buffer descriptors */
 233         __u32            srv_nrqbds;            /* # request buffers */
 234         atomic_t         srv_nrqbds_receiving;  /* # request buffers posted for input */
 235
 236         __u32 srv_req_portal;
 237         __u32 srv_rep_portal;
 238
 239         __u32 srv_xid;
 240
 241         /* event queue */
 242         ptl_handle_eq_t srv_eq_h;
 243
 244         struct lustre_peer srv_self;
 245
 246         wait_queue_head_t srv_waitq; /* all threads sleep on this */
 247
 248         spinlock_t srv_lock;
 249         struct list_head srv_threads;
 250         int (*srv_handler)(struct ptlrpc_request *req);
 251         char *srv_name;  /* only statically allocated strings here; we don't clean them */
 252 };
 253
 254 static inline void ptlrpc_hdl2req(struct ptlrpc_request *req, struct lustre_handle *h)
 255 {
 256         req->rq_reqmsg->addr = h->addr;
 257         req->rq_reqmsg->cookie = h->cookie;
 258 }
 259
 260 typedef void (*bulk_callback_t)(struct ptlrpc_bulk_desc *, void *);
 261
 262 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
 263
 264 /* rpc/connection.c */
 265 void ptlrpc_readdress_connection(struct ptlrpc_connection *conn, obd_uuid_t uuid);
 266 struct ptlrpc_connection *ptlrpc_get_connection(struct lustre_peer *peer,
 267                                                 obd_uuid_t uuid);
 268 int ptlrpc_put_connection(struct ptlrpc_connection *c);
 269 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
 270 void ptlrpc_init_connection(void);
 271 void ptlrpc_cleanup_connection(void);
 272
 273 /* rpc/niobuf.c */
 274 int ptlrpc_check_bulk_sent(struct ptlrpc_bulk_desc *bulk);
 275 int ptlrpc_check_bulk_received(struct ptlrpc_bulk_desc *bulk);
 276 int ptlrpc_send_bulk(struct ptlrpc_bulk_desc *);
 277 int ptlrpc_register_bulk(struct ptlrpc_bulk_desc *);
 278 int ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *bulk);
 279 int ptlrpc_reply(struct ptlrpc_service *svc, struct ptlrpc_request *req);
 280 int ptlrpc_error(struct ptlrpc_service *svc, struct ptlrpc_request *req);
 281 void ptlrpc_resend_req(struct ptlrpc_request *request);
 282 int ptl_send_rpc(struct ptlrpc_request *request);
 283 void ptlrpc_link_svc_me(struct ptlrpc_request_buffer_desc *rqbd);
 284
 285 /* rpc/client.c */
 286 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
 287                         struct ptlrpc_client *);
 288 void ptlrpc_cleanup_client(struct obd_import *imp);
 289 __u8 *ptlrpc_req_to_uuid(struct ptlrpc_request *req);
 290 struct ptlrpc_connection *ptlrpc_uuid_to_connection(obd_uuid_t uuid);
 291
 292 int ptlrpc_queue_wait(struct ptlrpc_request *req);
 293 void ptlrpc_continue_req(struct ptlrpc_request *req);
 294 int ptlrpc_replay_req(struct ptlrpc_request *req);
 295 void ptlrpc_restart_req(struct ptlrpc_request *req);
 296
 297 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, int opcode,
 298                                        int count, int *lengths, char **bufs);
 299 void ptlrpc_free_req(struct ptlrpc_request *request);
 300 void ptlrpc_req_finished(struct ptlrpc_request *request);
 301 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk(struct ptlrpc_connection *);
 302 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
 303 struct ptlrpc_bulk_page *ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc);
 304 void ptlrpc_free_bulk_page(struct ptlrpc_bulk_page *page);
 305 int ptlrpc_check_status(struct ptlrpc_request *req, int err);
 306
 307 /* rpc/service.c */
 308 struct ptlrpc_service *
 309 ptlrpc_init_svc(__u32 nevents, __u32 nbufs, __u32 bufsize, __u32 max_req_size,
 310                 int req_portal, int rep_portal,
 311                 obd_uuid_t uuid, svc_handler_t, char *name);
 312 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
 313 int ptlrpc_start_thread(struct obd_device *dev, struct ptlrpc_service *svc,
 314                         char *name);
 315 int ptlrpc_unregister_service(struct ptlrpc_service *service);
 316
 317 struct ptlrpc_svc_data {
 318         char *name;
 319         struct ptlrpc_service *svc;
 320         struct ptlrpc_thread *thread;
 321         struct obd_device *dev;
 322 };
 323
 324 /* rpc/pack_generic.c */
 325 int lustre_pack_msg(int count, int *lens, char **bufs, int *len,
 326                     struct lustre_msg **msg);
 327 int lustre_msg_size(int count, int *lengths);
 328 int lustre_unpack_msg(struct lustre_msg *m, int len);
 329 void *lustre_msg_buf(struct lustre_msg *m, int n);
 330
 331 static inline void ptlrpc_bulk_decref(struct ptlrpc_bulk_desc *desc)
 332 {
 333         if (atomic_dec_and_test(&desc->bd_refcount)) {
 334                 CDEBUG(D_PAGE, "Released last ref on %p, freeing\n", desc);
 335                 ptlrpc_free_bulk(desc);
 336         } else {
 337                 CDEBUG(D_PAGE, "%p -> %d\n", desc,
 338                        atomic_read(&desc->bd_refcount));
 339         }
 340 }
 341
 342 static inline void ptlrpc_bulk_addref(struct ptlrpc_bulk_desc *desc)
 343 {
 344         atomic_inc(&desc->bd_refcount);
 345         CDEBUG(D_PAGE, "Set refcount of %p to %d\n", desc,
 346                atomic_read(&desc->bd_refcount));
 347 }
 348
 349 #endif