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
  33 /* default rpc ring length */
  34 #define RPC_RING_LENGTH    10
  35
  36 struct ptlrpc_connection {
  37         struct list_head        c_link;
  38         struct lustre_peer      c_peer;
  39         __u8                    c_local_uuid[37];  /* XXX do we need this? */
  40         __u8                    c_remote_uuid[37];
  41
  42         int                     c_level;
  43         __u32                   c_generation;  /* changes upon new connection */
  44         __u32                   c_epoch;       /* changes when peer changes */
  45         __u32                   c_bootcount;   /* peer's boot count */
  46
  47         spinlock_t              c_lock;
  48         __u32                   c_xid_in;
  49         __u32                   c_xid_out;
  50
  51         atomic_t                c_refcount;
  52         __u64                   c_token;
  53         __u64                   c_remote_conn;
  54         __u64                   c_remote_token;
  55
  56         __u64                   c_last_xid;
  57         __u64                   c_last_committed;
  58         struct list_head        c_delayed_head; /* delayed until post-recovery */
  59         struct list_head        c_sending_head;
  60         struct list_head        c_dying_head;
  61         struct recovd_data      c_recovd_data;
  62
  63         struct list_head        c_clients; /* XXXshaver will be c_imports */
  64         struct list_head        c_exports;
  65
  66         /* should this be in recovd_data? */
  67         struct recovd_obd      *c_recovd;
  68 };
  69
  70 struct ptlrpc_client {
  71         struct obd_device        *cli_obd;
  72         __u32                     cli_request_portal;
  73         __u32                     cli_reply_portal;
  74
  75         __u32                     cli_target_devno;
  76
  77         struct ptlrpc_connection *cli_connection;
  78
  79         void                     *cli_data;
  80         struct semaphore          cli_rpc_sem; /* limits outstanding requests */
  81
  82         struct list_head          cli_client_chain;
  83         char                     *cli_name;
  84 };
  85
  86 /* state flags of requests */
  87 #define PTL_RPC_FL_INTR      (1 << 0)
  88 #define PTL_RPC_FL_REPLIED   (1 << 1)  /* reply was received */
  89 #define PTL_RPC_FL_SENT      (1 << 2)
  90 #define PTL_BULK_FL_SENT     (1 << 3)
  91 #define PTL_BULK_FL_RCVD     (1 << 4)
  92 #define PTL_RPC_FL_ERR       (1 << 5)
  93 #define PTL_RPC_FL_TIMEOUT   (1 << 6)
  94 #define PTL_RPC_FL_RESEND    (1 << 7)
  95 #define PTL_RPC_FL_RECOVERY  (1 << 8)  /* retransmission for recovery */
  96 #define PTL_RPC_FL_FINISHED  (1 << 9)
  97 #define PTL_RPC_FL_RETAIN    (1 << 10) /* retain for replay after reply */
  98 #define PTL_RPC_FL_REPLAY    (1 << 11) /* replay upon recovery */
  99 #define PTL_RPC_FL_ALLOCREP  (1 << 12) /* reply buffer allocated */
 100
 101 struct ptlrpc_request {
 102         int rq_type; /* one of PTL_RPC_REQUEST, PTL_RPC_REPLY, PTL_RPC_BULK */
 103         struct list_head rq_list;
 104         struct list_head rq_multi;
 105         struct obd_device *rq_obd;
 106         int rq_status;
 107         int rq_flags;
 108         __u32 rq_connid;
 109         atomic_t rq_refcount;
 110
 111         int rq_reqlen;
 112         struct lustre_msg *rq_reqmsg;
 113
 114         int rq_replen;
 115         struct lustre_msg *rq_repmsg;
 116         __u64 rq_transno;
 117         __u64 rq_xid;
 118
 119         char *rq_bulkbuf;
 120         int rq_bulklen;
 121
 122         int rq_level;
 123         time_t rq_time;
 124         time_t rq_timeout;
 125         //        void * rq_reply_handle;
 126         wait_queue_head_t rq_wait_for_rep;
 127
 128         /* incoming reply */
 129         ptl_md_t rq_reply_md;
 130         ptl_handle_md_t rq_reply_md_h;
 131         ptl_handle_me_t rq_reply_me_h;
 132
 133         /* outgoing req/rep */
 134         ptl_md_t rq_req_md;
 135         ptl_handle_md_t rq_req_md_h;
 136
 137         struct lustre_peer rq_peer; /* XXX see service.c can this be factored away? */
 138         struct obd_export *rq_export;
 139         struct ptlrpc_connection *rq_connection;
 140         struct ptlrpc_client *rq_client;
 141         struct ptlrpc_service *rq_svc;
 142 };
 143
 144 struct ptlrpc_bulk_page {
 145         struct ptlrpc_bulk_desc *b_desc;
 146         struct list_head b_link;
 147         char *b_buf;
 148         int b_buflen;
 149         struct page *b_page;
 150         __u32 b_xid;
 151         __u32 b_flags;
 152         struct dentry *b_dentry;
 153         int (*b_cb)(struct ptlrpc_bulk_page *);
 154 };
 155
 156 struct ptlrpc_bulk_desc {
 157         int b_flags;
 158         struct ptlrpc_connection *b_connection;
 159         struct ptlrpc_client *b_client;
 160         __u32 b_portal;
 161         struct lustre_handle b_conn;
 162         void (*b_cb)(struct ptlrpc_bulk_desc *, void *);
 163         void *b_cb_data;
 164
 165         wait_queue_head_t b_waitq;
 166         struct list_head b_page_list;
 167         __u32 b_page_count;
 168         atomic_t b_refcount;
 169         void *b_desc_private;
 170         struct tq_struct b_queue;
 171
 172         ptl_md_t b_md;
 173         ptl_handle_md_t b_md_h;
 174         ptl_handle_me_t b_me_h;
 175
 176         struct iovec b_iov[16];    /* self-sized pre-allocated iov */
 177 };
 178
 179 struct ptlrpc_thread {
 180         struct list_head t_link;
 181
 182         __u32 t_flags;
 183         wait_queue_head_t t_ctl_waitq;
 184 };
 185
 186 struct ptlrpc_service {
 187         time_t srv_time;
 188         time_t srv_timeout;
 189
 190         /* incoming request buffers */
 191         /* FIXME: perhaps a list of EQs, if multiple NIs are used? */
 192         char *srv_buf[RPC_RING_LENGTH];
 193         __u32 srv_ref_count[RPC_RING_LENGTH];
 194         ptl_handle_me_t srv_me_h[RPC_RING_LENGTH];
 195         __u32 srv_buf_size;
 196         __u32 srv_ring_length;
 197         __u32 srv_req_portal;
 198         __u32 srv_rep_portal;
 199
 200         __u32 srv_xid;
 201
 202         /* event queue */
 203         ptl_handle_eq_t srv_eq_h;
 204
 205         struct lustre_peer srv_self;
 206
 207         wait_queue_head_t srv_waitq; /* all threads sleep on this */
 208
 209         spinlock_t srv_lock;
 210         struct list_head srv_reqs;
 211         struct list_head srv_threads;
 212         int (*srv_handler)(struct ptlrpc_request *req);
 213         char *srv_name;  /* only statically allocated strings here; we don't clean them */
 214 };
 215
 216 static inline void ptlrpc_hdl2req(struct ptlrpc_request *req, struct lustre_handle *h)
 217 {
 218         req->rq_reqmsg->addr = h->addr;
 219         req->rq_reqmsg->cookie = h->cookie;
 220 }
 221 struct ptlrpc_request *ptlrpc_prep_req2(struct lustre_handle *conn,
 222                                         int opcode, int count, int *lengths,
 223                                         char **bufs);
 224
 225 typedef void (*bulk_callback_t)(struct ptlrpc_bulk_desc *, void *);
 226
 227 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
 228
 229 /* rpc/connection.c */
 230 void ptlrpc_readdress_connection(struct ptlrpc_connection *conn, char *uuid);
 231 struct ptlrpc_connection *ptlrpc_get_connection(struct lustre_peer *peer);
 232 int ptlrpc_put_connection(struct ptlrpc_connection *c);
 233 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
 234 void ptlrpc_init_connection(void);
 235 void ptlrpc_cleanup_connection(void);
 236
 237 /* rpc/niobuf.c */
 238 int ptlrpc_check_bulk_sent(struct ptlrpc_bulk_desc *bulk);
 239 int ptlrpc_check_bulk_received(struct ptlrpc_bulk_desc *bulk);
 240 int ptlrpc_send_bulk(struct ptlrpc_bulk_desc *);
 241 int ptlrpc_register_bulk(struct ptlrpc_bulk_desc *);
 242 int ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *bulk);
 243 int ptlrpc_reply(struct ptlrpc_service *svc, struct ptlrpc_request *req);
 244 int ptlrpc_error(struct ptlrpc_service *svc, struct ptlrpc_request *req);
 245 void ptlrpc_resend_req(struct ptlrpc_request *request);
 246 int ptl_send_rpc(struct ptlrpc_request *request);
 247 void ptlrpc_link_svc_me(struct ptlrpc_service *service, int i);
 248
 249 /* rpc/client.c */
 250 void ptlrpc_init_client(int req_portal, int rep_portal, struct ptlrpc_client *,
 251                         struct ptlrpc_connection *);
 252 void ptlrpc_cleanup_client(struct ptlrpc_client *cli);
 253 __u8 *ptlrpc_req_to_uuid(struct ptlrpc_request *req);
 254 struct ptlrpc_connection *ptlrpc_uuid_to_connection(char *uuid);
 255
 256 int ptlrpc_queue_wait(struct ptlrpc_request *req);
 257 void ptlrpc_continue_req(struct ptlrpc_request *req);
 258 int ptlrpc_replay_req(struct ptlrpc_request *req);
 259 void ptlrpc_restart_req(struct ptlrpc_request *req);
 260
 261 struct ptlrpc_request *ptlrpc_prep_req(struct ptlrpc_client *cl, int opcode,
 262                                        int count, int *lengths, char **bufs);
 263 void ptlrpc_free_req(struct ptlrpc_request *request);
 264 void ptlrpc_req_finished(struct ptlrpc_request *request);
 265 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk(struct ptlrpc_connection *);
 266 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
 267 struct ptlrpc_bulk_page *ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc);
 268 void ptlrpc_free_bulk_page(struct ptlrpc_bulk_page *page);
 269 int ptlrpc_check_status(struct ptlrpc_request *req, int err);
 270
 271 /* rpc/service.c */
 272 struct ptlrpc_service *
 273 ptlrpc_init_svc(__u32 bufsize, int req_portal, int rep_portal, char *uuid,
 274                 svc_handler_t, char *name);
 275 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
 276 int ptlrpc_start_thread(struct obd_device *dev, struct ptlrpc_service *svc,
 277                         char *name);
 278 int ptlrpc_unregister_service(struct ptlrpc_service *service);
 279
 280 struct ptlrpc_svc_data {
 281         char *name;
 282         struct ptlrpc_service *svc;
 283         struct ptlrpc_thread *thread;
 284         struct obd_device *dev;
 285 };
 286
 287 /* rpc/pack_generic.c */
 288 int lustre_pack_msg(int count, int *lens, char **bufs, int *len,
 289                     struct lustre_msg **msg);
 290 int lustre_msg_size(int count, int *lengths);
 291 int lustre_unpack_msg(struct lustre_msg *m, int len);
 292 void *lustre_msg_buf(struct lustre_msg *m, int n);
 293
 294 static inline void ptlrpc_bulk_decref(struct ptlrpc_bulk_desc *desc)
 295 {
 296         if (atomic_dec_and_test(&desc->b_refcount)) {
 297                 CDEBUG(D_PAGE, "Released last ref on %p, freeing\n", desc);
 298                 ptlrpc_free_bulk(desc);
 299         } else {
 300                 CDEBUG(D_PAGE, "%p -> %d\n", desc,
 301                        atomic_read(&desc->b_refcount));
 302         }
 303 }
 304
 305 static inline void ptlrpc_bulk_addref(struct ptlrpc_bulk_desc *desc)
 306 {
 307         atomic_inc(&desc->b_refcount);
 308         CDEBUG(D_PAGE, "Set refcount of %p to %d\n", desc,
 309                atomic_read(&desc->b_refcount));
 310 }
 311
 312 #endif