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/kp30.h>
  27 #include <linux/obd_support.h>
  28 #include <linux/obd_class.h>
  29 #include <portals/p30.h>
  30 #include <linux/lustre_idl.h>
  31
  32 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
  33  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
  34  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
  35  */
  36
  37 #define CONNMGR_REQUEST_PORTAL    1
  38 #define CONNMGR_REPLY_PORTAL      2
  39 #define OSC_REQUEST_PORTAL      3
  40 #define OSC_REPLY_PORTAL        4
  41 #define OSC_BULK_PORTAL         5
  42 #define OST_REQUEST_PORTAL      6
  43 #define OST_REPLY_PORTAL        7
  44 #define OST_BULK_PORTAL         8
  45 #define MDC_REQUEST_PORTAL      9
  46 #define MDC_REPLY_PORTAL        10
  47 #define MDC_BULK_PORTAL         11
  48 #define MDS_REQUEST_PORTAL      12
  49 #define MDS_REPLY_PORTAL        13
  50 #define MDS_BULK_PORTAL         14
  51 #define LDLM_REQUEST_PORTAL     15
  52 #define LDLM_REPLY_PORTAL       16
  53 #define LDLM_CLI_REQUEST_PORTAL 17
  54 #define LDLM_CLI_REPLY_PORTAL   18
  55
  56 /* default rpc ring length */
  57 #define RPC_RING_LENGTH    2
  58
  59 #define SVC_KILLED 1
  60 #define SVC_EVENT  2
  61 #define SVC_SIGNAL 4
  62 #define SVC_RUNNING 8
  63 #define SVC_STOPPING 16
  64 #define SVC_STOPPED  32
  65
  66 #define RECOVD_STOPPING      1     /* how cleanup tells recovd to quit */
  67 #define RECOVD_IDLE          2     /* normal state */
  68 #define RECOVD_STOPPED       4     /* after recovd has stopped */
  69 #define RECOVD_FAIL          8     /* RPC timeout: wakeup recovd, sets flag */
  70 #define RECOVD_TIMEOUT       16    /* set when recovd detects a timeout */
  71 #define RECOVD_UPCALL_WAIT   32    /* an upcall has been placed */
  72 #define RECOVD_UPCALL_ANSWER 64    /* an upcall has been answered */
  73
  74 #define LUSTRE_CONN_NEW    1
  75 #define LUSTRE_CONN_CON    2
  76 #define LUSTRE_CONN_RECOVD 3
  77 #define LUSTRE_CONN_FULL   4
  78
  79 struct ptlrpc_connection {
  80         struct list_head c_link;
  81         struct lustre_peer c_peer;
  82         __u8 c_local_uuid[37];  /* XXX do we need this? */
  83         __u8 c_remote_uuid[37];
  84
  85         int c_level;
  86         __u32 c_generation;  /* changes upon new connection */
  87         __u32 c_epoch;       /* changes when peer changes */
  88         __u32 c_bootcount;   /* peer's boot count */
  89
  90         spinlock_t c_lock;
  91         __u32 c_xid_in;
  92         __u32 c_xid_out;
  93
  94         atomic_t c_refcount;
  95         __u64 c_token;
  96         __u64 c_remote_conn;
  97         __u64 c_remote_token;
  98 };
  99
 100 struct ptlrpc_client {
 101         struct obd_device *cli_obd;
 102         __u32 cli_request_portal;
 103         __u32 cli_reply_portal;
 104         __u64 cli_last_rcvd;
 105         __u64 cli_last_committed;
 106
 107         void *cli_data;
 108         struct semaphore cli_rpc_sem; /* limits outstanding requests */
 109
 110         spinlock_t cli_lock; /* protects lists */
 111         struct list_head cli_delayed_head; /* delayed until after recovery */
 112         struct list_head cli_sending_head;
 113         struct list_head cli_dying_head;
 114         struct list_head cli_ha_item;
 115         int (*cli_recover)(struct ptlrpc_client *);
 116
 117         struct recovd_obd *cli_recovd;
 118         char *cli_name;
 119 };
 120
 121 /* packet types */
 122 #define PTL_RPC_TYPE_REQUEST 2
 123 #define PTL_RPC_TYPE_REPLY   3
 124
 125 /* state flags of requests */
 126 #define PTL_RPC_FL_INTR      (1 << 0)
 127 #define PTL_RPC_FL_REPLIED   (1 << 1)  /* reply was received */
 128 #define PTL_RPC_FL_SENT      (1 << 2)
 129 #define PTL_BULK_FL_SENT     (1 << 3)
 130 #define PTL_BULK_FL_RCVD     (1 << 4)
 131 #define PTL_RPC_FL_ERR       (1 << 5)
 132 #define PTL_RPC_FL_TIMEOUT   (1 << 6)
 133 #define PTL_RPC_FL_RESEND    (1 << 7)
 134 #define PTL_RPC_FL_RECOVERY  (1 << 8)  /* retransmission for recovery */
 135 #define PTL_RPC_FL_FINISHED  (1 << 9)
 136 #define PTL_RPC_FL_RETAIN    (1 << 10) /* retain for replay after reply */
 137 #define PTL_RPC_FL_REPLAY    (1 << 11) /* replay upon recovery */
 138 #define PTL_RPC_FL_ALLOCREP  (1 << 12) /* reply buffer allocated */
 139
 140 struct ptlrpc_request {
 141         int rq_type; /* one of PTL_RPC_REQUEST, PTL_RPC_REPLY, PTL_RPC_BULK */
 142         struct list_head rq_list;
 143         struct obd_device *rq_obd;
 144         int rq_status;
 145         int rq_flags;
 146         __u32 rq_connid;
 147         atomic_t rq_refcount;
 148
 149         int rq_reqlen;
 150         struct lustre_msg *rq_reqmsg;
 151
 152         int rq_replen;
 153         struct lustre_msg *rq_repmsg;
 154         __u64 rq_transno;
 155         __u64 rq_xid;
 156
 157         char *rq_bulkbuf;
 158         int rq_bulklen;
 159
 160         int rq_level;
 161         time_t rq_time;
 162         time_t rq_timeout;
 163         //        void * rq_reply_handle;
 164         wait_queue_head_t rq_wait_for_rep;
 165
 166         /* incoming reply */
 167         ptl_md_t rq_reply_md;
 168         ptl_handle_md_t rq_reply_md_h;
 169         ptl_handle_me_t rq_reply_me_h;
 170
 171         /* outgoing req/rep */
 172         ptl_md_t rq_req_md;
 173         ptl_handle_md_t rq_req_md_h;
 174
 175         struct ptlrpc_connection *rq_connection;
 176         struct ptlrpc_client *rq_client;
 177 };
 178
 179 struct ptlrpc_bulk_page {
 180         struct ptlrpc_bulk_desc *b_desc;
 181         struct list_head b_link;
 182         char *b_buf;
 183         int b_buflen;
 184         struct page *b_page;
 185         __u32 b_xid;
 186         __u32 b_flags;
 187         struct dentry *b_dentry;
 188         int (*b_cb)(struct ptlrpc_bulk_page *);
 189
 190         ptl_md_t b_md;
 191         ptl_handle_md_t b_md_h;
 192         ptl_handle_me_t b_me_h;
 193 };
 194
 195 struct ptlrpc_bulk_desc {
 196         int b_flags;
 197         struct ptlrpc_connection *b_connection;
 198         struct ptlrpc_client *b_client;
 199         __u32 b_portal;
 200         int (*b_cb)(struct ptlrpc_bulk_desc *);
 201         struct obd_conn b_conn;
 202
 203         wait_queue_head_t b_waitq;
 204         struct list_head b_page_list;
 205         __u32 b_page_count;
 206         __u32 b_finished_count;
 207         void *b_desc_private;
 208 };
 209
 210 struct ptlrpc_thread {
 211         struct list_head t_link;
 212
 213         __u32 t_flags;
 214         wait_queue_head_t t_ctl_waitq;
 215 };
 216
 217 struct ptlrpc_service {
 218         time_t srv_time;
 219         time_t srv_timeout;
 220
 221         /* incoming request buffers */
 222         /* FIXME: perhaps a list of EQs, if multiple NIs are used? */
 223         char *srv_buf[RPC_RING_LENGTH];
 224         __u32 srv_ref_count[RPC_RING_LENGTH];
 225         ptl_handle_me_t srv_me_h[RPC_RING_LENGTH];
 226         __u32 srv_buf_size;
 227         __u32 srv_ring_length;
 228         __u32 srv_req_portal;
 229         __u32 srv_rep_portal;
 230
 231         __u32 srv_xid;
 232
 233         /* event queue */
 234         ptl_handle_eq_t srv_eq_h;
 235
 236         struct lustre_peer srv_self;
 237
 238         wait_queue_head_t srv_waitq; /* all threads sleep on this */
 239
 240         spinlock_t srv_lock;
 241         struct list_head srv_reqs;
 242         struct list_head srv_threads;
 243         int (*srv_handler)(struct obd_device *obddev,
 244                            struct ptlrpc_service *svc,
 245                            struct ptlrpc_request *req);
 246 };
 247
 248 typedef int (*svc_handler_t)(struct obd_device *obddev,
 249                              struct ptlrpc_service *svc,
 250                              struct ptlrpc_request *req);
 251
 252 /* rpc/connection.c */
 253 void ptlrpc_readdress_connection(struct ptlrpc_connection *conn, char *uuid);
 254 struct ptlrpc_connection *ptlrpc_get_connection(struct lustre_peer *peer);
 255 int ptlrpc_put_connection(struct ptlrpc_connection *c);
 256 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
 257 void ptlrpc_init_connection(void);
 258 void ptlrpc_cleanup_connection(void);
 259
 260 /* rpc/niobuf.c */
 261 int ptlrpc_send_bulk(struct ptlrpc_bulk_desc *);
 262 int ptlrpc_register_bulk(struct ptlrpc_bulk_desc *);
 263 int ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *bulk);
 264 int ptlrpc_reply(struct ptlrpc_service *svc, struct ptlrpc_request *req);
 265 int ptlrpc_error(struct ptlrpc_service *svc, struct ptlrpc_request *req);
 266 void ptlrpc_resend_req(struct ptlrpc_request *request);
 267 int ptl_send_rpc(struct ptlrpc_request *request);
 268 void ptlrpc_link_svc_me(struct ptlrpc_service *service, int i);
 269
 270 /* rpc/client.c */
 271 void ptlrpc_init_client(struct recovd_obd *,
 272                         int (*recover)(struct ptlrpc_client *),
 273                         int req_portal, int rep_portal,
 274                         struct ptlrpc_client *);
 275 void ptlrpc_cleanup_client(struct ptlrpc_client *cli);
 276 __u8 *ptlrpc_req_to_uuid(struct ptlrpc_request *req);
 277 struct ptlrpc_connection *ptlrpc_uuid_to_connection(char *uuid);
 278
 279 int ptlrpc_queue_wait(struct ptlrpc_request *req);
 280 void ptlrpc_continue_req(struct ptlrpc_request *req);
 281 int ptlrpc_replay_req(struct ptlrpc_request *req);
 282 void ptlrpc_restart_req(struct ptlrpc_request *req);
 283
 284 struct ptlrpc_request *ptlrpc_prep_req(struct ptlrpc_client *cl,
 285                                        struct ptlrpc_connection *u, int opcode,
 286                                        int count, int *lengths, char **bufs);
 287 void ptlrpc_free_req(struct ptlrpc_request *request);
 288 void ptlrpc_req_finished(struct ptlrpc_request *request);
 289 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk(struct ptlrpc_connection *);
 290 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
 291 struct ptlrpc_bulk_page *ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc);
 292 void ptlrpc_free_bulk_page(struct ptlrpc_bulk_page *page);
 293 int ptlrpc_check_status(struct ptlrpc_request *req, int err);
 294
 295 /* rpc/service.c */
 296 struct ptlrpc_service *
 297 ptlrpc_init_svc(__u32 bufsize, int req_portal, int rep_portal, char *uuid,
 298                 svc_handler_t);
 299 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
 300 int ptlrpc_start_thread(struct obd_device *dev, struct ptlrpc_service *svc,
 301                         char *name);
 302 int rpc_unregister_service(struct ptlrpc_service *service);
 303
 304 struct ptlrpc_svc_data {
 305         char *name;
 306         struct ptlrpc_service *svc;
 307         struct ptlrpc_thread *thread;
 308         struct obd_device *dev;
 309 };
 310
 311 /* rpc/pack_generic.c */
 312 int lustre_pack_msg(int count, int *lens, char **bufs, int *len,
 313                     struct lustre_msg **msg);
 314 int lustre_msg_size(int count, int *lengths);
 315 int lustre_unpack_msg(struct lustre_msg *m, int len);
 316 void *lustre_msg_buf(struct lustre_msg *m, int n);
 317 #endif