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