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