lnet/selftest/rpc.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef __SELFTEST_RPC_H__
  38 #define __SELFTEST_RPC_H__
  39
  40 #include <lnet/lnetst.h>
  41
  42 /*
  43  * LST wired structures
  44  *
  45  * XXX: *REPLY == *REQST + 1
  46  */
  47 typedef enum {
  48         SRPC_MSG_MKSN_REQST     = 0,
  49         SRPC_MSG_MKSN_REPLY     = 1,
  50         SRPC_MSG_RMSN_REQST     = 2,
  51         SRPC_MSG_RMSN_REPLY     = 3,
  52         SRPC_MSG_BATCH_REQST    = 4,
  53         SRPC_MSG_BATCH_REPLY    = 5,
  54         SRPC_MSG_STAT_REQST     = 6,
  55         SRPC_MSG_STAT_REPLY     = 7,
  56         SRPC_MSG_TEST_REQST     = 8,
  57         SRPC_MSG_TEST_REPLY     = 9,
  58         SRPC_MSG_DEBUG_REQST    = 10,
  59         SRPC_MSG_DEBUG_REPLY    = 11,
  60         SRPC_MSG_BRW_REQST      = 12,
  61         SRPC_MSG_BRW_REPLY      = 13,
  62         SRPC_MSG_PING_REQST     = 14,
  63         SRPC_MSG_PING_REPLY     = 15,
  64         SRPC_MSG_JOIN_REQST     = 16,
  65         SRPC_MSG_JOIN_REPLY     = 17,
  66 } srpc_msg_type_t;
  67
  68 /* CAVEAT EMPTOR:
  69  * All srpc_*_reqst_t's 1st field must be matchbits of reply buffer,
  70  * and 2nd field matchbits of bulk buffer if any.
  71  *
  72  * All srpc_*_reply_t's 1st field must be a __u32 status, and 2nd field
  73  * session id if needed.
  74  */
  75 typedef struct {
  76         __u64                   rpyid;          /* reply buffer matchbits */
  77         __u64                   bulkid;         /* bulk buffer matchbits */
  78 } WIRE_ATTR srpc_generic_reqst_t;
  79
  80 typedef struct {
  81         __u32                   status;
  82         lst_sid_t               sid;
  83 } WIRE_ATTR srpc_generic_reply_t;
  84
  85 /* FRAMEWORK RPCs */
  86 typedef struct {
  87         __u64                   mksn_rpyid;      /* reply buffer matchbits */
  88         lst_sid_t               mksn_sid;        /* session id */
  89         __u32                   mksn_force;      /* use brute force */
  90         char                    mksn_name[LST_NAME_SIZE];
  91 } WIRE_ATTR srpc_mksn_reqst_t;                  /* make session request */
  92
  93 typedef struct {
  94         __u32                   mksn_status;      /* session status */
  95         lst_sid_t               mksn_sid;         /* session id */
  96         __u32                   mksn_timeout;     /* session timeout */
  97         char                    mksn_name[LST_NAME_SIZE];
  98 } WIRE_ATTR srpc_mksn_reply_t; /* make session reply */
  99
 100 typedef struct {
 101         __u64                   rmsn_rpyid;      /* reply buffer matchbits */
 102         lst_sid_t               rmsn_sid;        /* session id */
 103 } WIRE_ATTR srpc_rmsn_reqst_t; /* remove session request */
 104
 105 typedef struct {
 106         __u32                   rmsn_status;
 107         lst_sid_t               rmsn_sid;        /* session id */
 108 } WIRE_ATTR srpc_rmsn_reply_t; /* remove session reply */
 109
 110 typedef struct {
 111         __u64                   join_rpyid;     /* reply buffer matchbits */
 112         lst_sid_t               join_sid;       /* session id to join */
 113         char                    join_group[LST_NAME_SIZE]; /* group name */
 114 } WIRE_ATTR srpc_join_reqst_t;
 115
 116 typedef struct {
 117         __u32                   join_status;    /* returned status */
 118         lst_sid_t               join_sid;       /* session id */
 119         __u32                   join_timeout;   /* # seconds' inactivity to expire */
 120         char                    join_session[LST_NAME_SIZE]; /* session name */
 121 } WIRE_ATTR srpc_join_reply_t;
 122
 123 typedef struct {
 124         __u64                   dbg_rpyid;      /* reply buffer matchbits */
 125         lst_sid_t               dbg_sid;        /* session id */
 126         __u32                   dbg_flags;      /* bitmap of debug */
 127 } WIRE_ATTR srpc_debug_reqst_t;
 128
 129 typedef struct {
 130         __u32                   dbg_status;     /* returned code */
 131         lst_sid_t               dbg_sid;        /* session id */
 132         __u32                   dbg_timeout;    /* session timeout */
 133         __u32                   dbg_nbatch;     /* # of batches in the node */
 134         char                    dbg_name[LST_NAME_SIZE]; /* session name */
 135 } WIRE_ATTR srpc_debug_reply_t;
 136
 137 #define SRPC_BATCH_OPC_RUN      1
 138 #define SRPC_BATCH_OPC_STOP     2
 139 #define SRPC_BATCH_OPC_QUERY    3
 140
 141 typedef struct {
 142         __u64                   bar_rpyid;      /* reply buffer matchbits */
 143         lst_sid_t               bar_sid;        /* session id */
 144         lst_bid_t               bar_bid;        /* batch id */
 145         __u32                   bar_opc;        /* create/start/stop batch */
 146         __u32                   bar_testidx;    /* index of test */
 147         __u32                   bar_arg;        /* parameters */
 148 } WIRE_ATTR srpc_batch_reqst_t;
 149
 150 typedef struct {
 151         __u32                   bar_status;     /* status of request */
 152         lst_sid_t               bar_sid;        /* session id */
 153         __u32                   bar_active;     /* # of active tests in batch/test */
 154         __u32                   bar_time;       /* remained time */
 155 } WIRE_ATTR srpc_batch_reply_t;
 156
 157 typedef struct {
 158         __u64                   str_rpyid;      /* reply buffer matchbits */
 159         lst_sid_t               str_sid;        /* session id */
 160         __u32                   str_type;       /* type of stat */
 161 } WIRE_ATTR srpc_stat_reqst_t;
 162
 163 typedef struct {
 164         __u32                   str_status;
 165         lst_sid_t               str_sid;
 166         sfw_counters_t          str_fw;
 167         srpc_counters_t         str_rpc;
 168         lnet_counters_t         str_lnet;
 169 } WIRE_ATTR srpc_stat_reply_t;
 170
 171 typedef struct {
 172         __u32                   blk_opc;        /* bulk operation code */
 173         __u32                   blk_npg;        /* # of pages */
 174         __u32                   blk_flags;      /* reserved flags */
 175 } WIRE_ATTR test_bulk_req_t;
 176
 177 typedef struct {
 178         /** bulk operation code */
 179         __u16                   blk_opc;
 180         /** data check flags */
 181         __u16                   blk_flags;
 182         /** data length */
 183         __u32                   blk_len;
 184         /** bulk offset */
 185         __u32                   blk_offset;
 186 } WIRE_ATTR test_bulk_req_v1_t;
 187
 188 typedef struct {
 189         __u32                   png_size;       /* size of ping message */
 190         __u32                   png_flags;      /* reserved flags */
 191 } WIRE_ATTR test_ping_req_t;
 192
 193 typedef struct {
 194         __u64                   tsr_rpyid;      /* reply buffer matchbits */
 195         __u64                   tsr_bulkid;     /* bulk buffer matchbits */
 196         lst_sid_t               tsr_sid;        /* session id */
 197         lst_bid_t               tsr_bid;        /* batch id */
 198         __u32                   tsr_service;    /* test type: bulk|ping|... */
 199         /* test client loop count or # server buffers needed */
 200         __u32                   tsr_loop;
 201         __u32                   tsr_concur;     /* concurrency of test */
 202         __u8                    tsr_is_client;  /* is test client or not */
 203         __u8                    tsr_stop_onerr; /* stop on error */
 204         __u32                   tsr_ndest;      /* # of dest nodes */
 205
 206         union {
 207                 test_ping_req_t         ping;
 208                 test_bulk_req_t         bulk_v0;
 209                 test_bulk_req_v1_t      bulk_v1;
 210         }               tsr_u;
 211 } WIRE_ATTR srpc_test_reqst_t;
 212
 213 typedef struct {
 214         __u32                   tsr_status;     /* returned code */
 215         lst_sid_t               tsr_sid;
 216 } WIRE_ATTR srpc_test_reply_t;
 217
 218 /* TEST RPCs */
 219 typedef struct {
 220         __u64                   pnr_rpyid;
 221         __u32                   pnr_magic;
 222         __u32                   pnr_seq;
 223         __u64                   pnr_time_sec;
 224         __u64                   pnr_time_usec;
 225 } WIRE_ATTR srpc_ping_reqst_t;
 226
 227 typedef struct {
 228         __u32                   pnr_status;
 229         __u32                   pnr_magic;
 230         __u32                   pnr_seq;
 231 } WIRE_ATTR srpc_ping_reply_t;
 232
 233 typedef struct {
 234         __u64                   brw_rpyid;      /* reply buffer matchbits */
 235         __u64                   brw_bulkid;     /* bulk buffer matchbits */
 236         __u32                   brw_rw;         /* read or write */
 237         __u32                   brw_len;        /* bulk data len */
 238         __u32                   brw_flags;      /* bulk data patterns */
 239 } WIRE_ATTR srpc_brw_reqst_t; /* bulk r/w request */
 240
 241 typedef struct {
 242         __u32                   brw_status;
 243 } WIRE_ATTR srpc_brw_reply_t; /* bulk r/w reply */
 244
 245 #define SRPC_MSG_MAGIC                  0xeeb0f00d
 246 #define SRPC_MSG_VERSION                1
 247
 248 typedef struct srpc_msg {
 249         /** magic number */
 250         __u32   msg_magic;
 251         /** message version number */
 252         __u32   msg_version;
 253         /** type of message body: srpc_msg_type_t */
 254         __u32   msg_type;
 255         __u32   msg_reserved0;
 256         __u32   msg_reserved1;
 257         /** test session features */
 258         __u32   msg_ses_feats;
 259         union {
 260                 srpc_generic_reqst_t reqst;
 261                 srpc_generic_reply_t reply;
 262
 263                 srpc_mksn_reqst_t    mksn_reqst;
 264                 srpc_mksn_reply_t    mksn_reply;
 265                 srpc_rmsn_reqst_t    rmsn_reqst;
 266                 srpc_rmsn_reply_t    rmsn_reply;
 267                 srpc_debug_reqst_t   dbg_reqst;
 268                 srpc_debug_reply_t   dbg_reply;
 269                 srpc_batch_reqst_t   bat_reqst;
 270                 srpc_batch_reply_t   bat_reply;
 271                 srpc_stat_reqst_t    stat_reqst;
 272                 srpc_stat_reply_t    stat_reply;
 273                 srpc_test_reqst_t    tes_reqst;
 274                 srpc_test_reply_t    tes_reply;
 275                 srpc_join_reqst_t    join_reqst;
 276                 srpc_join_reply_t    join_reply;
 277
 278                 srpc_ping_reqst_t    ping_reqst;
 279                 srpc_ping_reply_t    ping_reply;
 280                 srpc_brw_reqst_t     brw_reqst;
 281                 srpc_brw_reply_t     brw_reply;
 282         }     msg_body;
 283 } WIRE_ATTR srpc_msg_t;
 284
 285 static inline void
 286 srpc_unpack_msg_hdr(srpc_msg_t *msg)
 287 {
 288         if (msg->msg_magic == SRPC_MSG_MAGIC)
 289                 return; /* no flipping needed */
 290
 291         /* We do not swap the magic number here as it is needed to
 292            determine whether the body needs to be swapped. */
 293         /* __swab32s(&msg->msg_magic); */
 294         __swab32s(&msg->msg_type);
 295         __swab32s(&msg->msg_version);
 296         __swab32s(&msg->msg_ses_feats);
 297         __swab32s(&msg->msg_reserved0);
 298         __swab32s(&msg->msg_reserved1);
 299 }
 300
 301 #endif /* __SELFTEST_RPC_H__ */