lnet/include/uapi/linux/lnet/lnet-dlc.h

   1 /*
   2  * LGPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library.
  18  *
  19  * LGPL HEADER END
  20  *
  21  */
  22 /*
  23  * Copyright (c) 2014, 2017, Intel Corporation.
  24  */
  25 /*
  26  * Author: Amir Shehata <amir.shehata@intel.com>
  27  */
  28
  29 #ifndef __UAPI_LNET_DLC_H_
  30 #define __UAPI_LNET_DLC_H_
  31
  32 #include <linux/types.h>
  33 #include <linux/lnet/libcfs_ioctl.h>
  34 #include <linux/lnet/lnet-types.h>
  35
  36 #define MAX_NUM_SHOW_ENTRIES    32
  37 #define LNET_MAX_STR_LEN        128
  38 #define LNET_MAX_SHOW_NUM_CPT   128
  39 #define LNET_MAX_SHOW_NUM_NID   128
  40 #define LNET_UNDEFINED_HOPS     ((__u32) -1)
  41
  42 #define LNET_RT_ALIVE           (1 << 0)
  43 #define LNET_RT_MULTI_HOP       (1 << 1)
  44
  45 /*
  46  * sparse kernel source annotations
  47  */
  48 #ifndef __user
  49 #define __user
  50 #endif
  51
  52 #define LNET_GENL_NAME          "lnet"
  53 #define LNET_GENL_VERSION       0x05
  54
  55 /* enum lnet_commands         - Supported core LNet Netlink commands
  56  *
  57  *  @LNET_CMD_UNSPEC:           unspecified command to catch errors
  58  *
  59  *  @LNET_CMD_NETS:             command to manage the LNet networks
  60  *  @LNET_CMD_PING:             command to send pings to LNet connections
  61  */
  62 enum lnet_commands {
  63         LNET_CMD_UNSPEC         = 0,
  64
  65         LNET_CMD_CONFIGURE      = 1,
  66         LNET_CMD_NETS           = 2,
  67         LNET_CMD_PEERS          = 3,
  68         LNET_CMD_ROUTES         = 4,
  69         LNET_CMD_CONNS          = 5,
  70         LNET_CMD_PING           = 6,
  71
  72         __LNET_CMD_MAX_PLUS_ONE
  73 };
  74
  75 #define LNET_CMD_MAX (__LNET_CMD_MAX_PLUS_ONE - 1)
  76
  77 /*
  78  * To allow for future enhancements to extend the tunables
  79  * add a hdr to this structure, so that the version can be set
  80  * and checked for backwards compatibility. Newer versions of LNet
  81  * can still work with older versions of lnetctl. The restriction is
  82  * that the structure can be added to and not removed from in order
  83  * to not invalidate older lnetctl utilities. Moreover, the order of
  84  * fields must remain the same, and new fields appended to the structure
  85  *
  86  * That said all existing LND tunables will be added in this structure
  87  * to avoid future changes.
  88  */
  89 struct lnet_ioctl_config_lnd_cmn_tunables {
  90         __u32 lct_version;
  91         __s32 lct_peer_timeout;
  92         __s32 lct_peer_tx_credits;
  93         __s32 lct_peer_rtr_credits;
  94         __s32 lct_max_tx_credits;
  95 };
  96
  97 struct lnet_ioctl_config_o2iblnd_tunables {
  98         __u32 lnd_version;
  99         __u32 lnd_peercredits_hiw;
 100         __u32 lnd_map_on_demand;
 101         __u32 lnd_concurrent_sends;
 102         __u32 lnd_fmr_pool_size;
 103         __u32 lnd_fmr_flush_trigger;
 104         __u32 lnd_fmr_cache;
 105         __u16 lnd_conns_per_peer;
 106         __u16 lnd_ntx;
 107 };
 108
 109 struct lnet_ioctl_config_kfilnd_tunables {
 110         __u32 lnd_version;
 111         __u32 lnd_prov_major_version;
 112         __u32 lnd_prov_minor_version;
 113         __u32 lnd_auth_key;
 114 };
 115
 116 struct lnet_ioctl_config_socklnd_tunables {
 117         __u32 lnd_version;
 118         __u16 lnd_conns_per_peer;
 119         __u16 lnd_pad;
 120 };
 121
 122 struct lnet_lnd_tunables {
 123         union {
 124                 struct lnet_ioctl_config_o2iblnd_tunables lnd_o2ib;
 125                 struct lnet_ioctl_config_socklnd_tunables lnd_sock;
 126                 struct lnet_ioctl_config_kfilnd_tunables lnd_kfi;
 127         } lnd_tun_u;
 128 };
 129
 130 struct lnet_ioctl_config_lnd_tunables {
 131         struct lnet_ioctl_config_lnd_cmn_tunables lt_cmn;
 132         struct lnet_lnd_tunables lt_tun;
 133 };
 134
 135 struct lnet_ioctl_net_config {
 136         char ni_interface[LNET_MAX_STR_LEN];
 137         __u32 ni_status;
 138         __u32 ni_cpts[LNET_MAX_SHOW_NUM_CPT];
 139         char cfg_bulk[0];
 140 };
 141
 142 #define LNET_TINY_BUF_IDX       0
 143 #define LNET_SMALL_BUF_IDX      1
 144 #define LNET_LARGE_BUF_IDX      2
 145
 146 /* # different router buffer pools */
 147 #define LNET_NRBPOOLS           (LNET_LARGE_BUF_IDX + 1)
 148
 149 struct lnet_ioctl_pool_cfg {
 150         struct {
 151                 __u32 pl_npages;
 152                 __u32 pl_nbuffers;
 153                 __u32 pl_credits;
 154                 __u32 pl_mincredits;
 155         } pl_pools[LNET_NRBPOOLS];
 156         __u32 pl_routing;
 157 };
 158
 159 struct lnet_ioctl_ping_data {
 160         struct libcfs_ioctl_hdr ping_hdr;
 161
 162         __u32 op_param;
 163         __u32 ping_count;
 164         __u32 ping_flags;
 165         __u32 mr_info;
 166         struct lnet_process_id ping_id;
 167         struct lnet_process_id __user *ping_buf;
 168         lnet_nid_t ping_src;
 169 };
 170
 171 struct lnet_ioctl_config_data {
 172         struct libcfs_ioctl_hdr cfg_hdr;
 173
 174         __u32 cfg_net;
 175         __u32 cfg_count;
 176         __u64 cfg_nid;
 177         __u32 cfg_ncpts;
 178
 179         union {
 180                 struct {
 181                         __u32 rtr_hop;
 182                         __u32 rtr_priority;
 183                         __u32 rtr_flags;
 184                         __u32 rtr_sensitivity;
 185                 } cfg_route;
 186                 struct {
 187                         char net_intf[LNET_MAX_STR_LEN];
 188                         __s32 net_peer_timeout;
 189                         __s32 net_peer_tx_credits;
 190                         __s32 net_peer_rtr_credits;
 191                         __s32 net_max_tx_credits;
 192                         __u32 net_cksum_algo;
 193                         __u32 net_interface_count;
 194                 } cfg_net;
 195                 struct {
 196                         __u32 buf_enable;
 197                         __s32 buf_tiny;
 198                         __s32 buf_small;
 199                         __s32 buf_large;
 200                 } cfg_buffers;
 201         } cfg_config_u;
 202
 203         char cfg_bulk[0];
 204 };
 205
 206 struct lnet_ioctl_comm_count {
 207         __u32 ico_get_count;
 208         __u32 ico_put_count;
 209         __u32 ico_reply_count;
 210         __u32 ico_ack_count;
 211         __u32 ico_hello_count;
 212 };
 213
 214 struct lnet_ioctl_element_stats {
 215         __u32 iel_send_count;
 216         __u32 iel_recv_count;
 217         __u32 iel_drop_count;
 218 };
 219
 220 enum lnet_health_type {
 221         LNET_HEALTH_TYPE_LOCAL_NI = 0,
 222         LNET_HEALTH_TYPE_PEER_NI,
 223 };
 224
 225 struct lnet_ioctl_local_ni_hstats {
 226         struct libcfs_ioctl_hdr hlni_hdr;
 227         lnet_nid_t hlni_nid;
 228         __u32 hlni_local_interrupt;
 229         __u32 hlni_local_dropped;
 230         __u32 hlni_local_aborted;
 231         __u32 hlni_local_no_route;
 232         __u32 hlni_local_timeout;
 233         __u32 hlni_local_error;
 234         __s32 hlni_fatal_error;
 235         __s32 hlni_health_value;
 236         __u32 hlni_ping_count;
 237         __u64 hlni_next_ping;
 238 };
 239
 240 struct lnet_ioctl_peer_ni_hstats {
 241         __u32 hlpni_remote_dropped;
 242         __u32 hlpni_remote_timeout;
 243         __u32 hlpni_remote_error;
 244         __u32 hlpni_network_timeout;
 245         __s32 hlpni_health_value;
 246         __u32 hlpni_ping_count;
 247         __u64 hlpni_next_ping;
 248 };
 249
 250 struct lnet_ioctl_element_msg_stats {
 251         struct libcfs_ioctl_hdr im_hdr;
 252         __u32 im_idx;
 253         struct lnet_ioctl_comm_count im_send_stats;
 254         struct lnet_ioctl_comm_count im_recv_stats;
 255         struct lnet_ioctl_comm_count im_drop_stats;
 256 };
 257
 258 /*
 259  * lnet_ioctl_config_ni
 260  *  This structure describes an NI configuration. There are multiple components
 261  *  when configuring an NI: Net, Interfaces, CPT list and LND tunables
 262  *  A network is passed as a string to the DLC and translated using
 263  *  libcfs_str2net()
 264  *  An interface is the name of the system configured interface
 265  *  (ex eth0, ib1)
 266  *  CPT is the list of CPTS LND tunables are passed in the lic_bulk area
 267  */
 268 struct lnet_ioctl_config_ni {
 269         struct libcfs_ioctl_hdr lic_cfg_hdr;
 270         lnet_nid_t              lic_nid;
 271         char                    lic_ni_intf[LNET_MAX_STR_LEN];
 272         char                    lic_legacy_ip2nets[LNET_MAX_STR_LEN];
 273         __u32                   lic_cpts[LNET_MAX_SHOW_NUM_CPT];
 274         __u32                   lic_ncpts;
 275         __u32                   lic_status;
 276         __u32                   lic_idx;
 277         __s32                   lic_dev_cpt;
 278         char                    pad[4];
 279         char                    lic_bulk[0];
 280 };
 281
 282 struct lnet_peer_ni_credit_info {
 283         char cr_aliveness[LNET_MAX_STR_LEN];
 284         __u32 cr_refcount;
 285         __s32 cr_ni_peer_tx_credits;
 286         __s32 cr_peer_tx_credits;
 287         __s32 cr_peer_min_tx_credits;
 288         __u32 cr_peer_tx_qnob;
 289         __s32 cr_peer_rtr_credits;
 290         __s32 cr_peer_min_rtr_credits;
 291         __u32 cr_ncpt;
 292 };
 293
 294 struct lnet_ioctl_peer {
 295         struct libcfs_ioctl_hdr pr_hdr;
 296         __u32 pr_count;
 297         __u32 pr_pad;
 298         lnet_nid_t pr_nid;
 299
 300         union {
 301                 struct lnet_peer_ni_credit_info  pr_peer_credits;
 302         } pr_lnd_u;
 303 };
 304
 305 struct lnet_ioctl_peer_cfg {
 306         struct libcfs_ioctl_hdr prcfg_hdr;
 307         lnet_nid_t prcfg_prim_nid;
 308         lnet_nid_t prcfg_cfg_nid;
 309         __u32 prcfg_count;
 310         __u32 prcfg_mr;
 311         __u32 prcfg_state;
 312         __u32 prcfg_size;
 313         void __user *prcfg_bulk;
 314 };
 315
 316 struct lnet_ioctl_reset_health_cfg {
 317         struct libcfs_ioctl_hdr rh_hdr;
 318         enum lnet_health_type rh_type:32;
 319         __u16 rh_all:1;
 320         __s16 rh_value;
 321         lnet_nid_t rh_nid;
 322 };
 323
 324 struct lnet_ioctl_reset_conns_per_peer_cfg {
 325         struct libcfs_ioctl_hdr rcpp_hdr;
 326         __u16 rcpp_all:1;
 327         __s16 rcpp_value;
 328         lnet_nid_t rcpp_nid;
 329 };
 330
 331 struct lnet_ioctl_recovery_list {
 332         struct libcfs_ioctl_hdr rlst_hdr;
 333         enum lnet_health_type rlst_type:32;
 334         __u32 rlst_num_nids;
 335         lnet_nid_t rlst_nid_array[LNET_MAX_SHOW_NUM_NID];
 336 };
 337
 338 struct lnet_ioctl_set_value {
 339         struct libcfs_ioctl_hdr sv_hdr;
 340         __u32 sv_value;
 341 };
 342
 343 struct lnet_ioctl_lnet_stats {
 344         struct libcfs_ioctl_hdr st_hdr;
 345         struct lnet_counters st_cntrs;
 346 };
 347
 348 /* An IP, numeric NID or a Net number is composed of 1 or more of these
 349  * descriptor structures.
 350  */
 351 struct lnet_range_expr {
 352         __u32 re_lo;
 353         __u32 re_hi;
 354         __u32 re_stride;
 355 };
 356
 357 /* le_count identifies the number of lnet_range_expr in the bulk
 358  * which follows
 359  */
 360 struct lnet_expressions {
 361         __u32 le_count;
 362 };
 363
 364 /* A net descriptor has the net type, IE: O2IBLND, SOCKLND, etc and an
 365  * expression describing a net number range.
 366  */
 367 struct lnet_ioctl_udsp_net_descr {
 368         __u32 ud_net_type;
 369         struct lnet_expressions ud_net_num_expr;
 370 };
 371
 372 /* The UDSP descriptor header contains the type of matching criteria, SRC,
 373  * DST, RTE, etc and how many lnet_expressions compose the LNet portion of
 374  * the LNet NID. For example an IP can be
 375  * composed of 4 lnet_expressions , a gni can be composed of 1
 376  */
 377 struct lnet_ioctl_udsp_descr_hdr {
 378         /* The literals SRC, DST and RTE are encoded
 379          * here.
 380          */
 381         __u32 ud_descr_type;
 382         __u32 ud_descr_count;
 383 };
 384
 385 /* each matching expression in the UDSP is described with this.
 386  * The bulk format is as follows:
 387  *      1. 1x struct lnet_ioctl_udsp_net_descr
 388  *              -> the net part of the NID
 389  *      2. >=0 struct lnet_expressions
 390  *              -> the address part of the NID
 391  */
 392 struct lnet_ioctl_udsp_descr {
 393         struct lnet_ioctl_udsp_descr_hdr iud_src_hdr;
 394         struct lnet_ioctl_udsp_net_descr iud_net;
 395 };
 396
 397 /* The cumulative UDSP descriptor
 398  * The bulk format is as follows:
 399  *      1. >=1 struct lnet_ioctl_udsp_descr
 400  *
 401  * The size indicated in iou_hdr is the total size of the UDSP.
 402  *
 403  */
 404 struct lnet_ioctl_udsp {
 405         struct libcfs_ioctl_hdr iou_hdr;
 406         __s32 iou_idx;
 407         __u32 iou_action_type;
 408         __u32 iou_bulk_size;
 409         union {
 410                 __u32 priority;
 411         } iou_action;
 412         void __user *iou_bulk;
 413 };
 414
 415 /* structure used to request udsp instantiation information on the
 416  * specified construct.
 417  *   cud_nid: the NID of the local or remote NI to pull info on.
 418  *   cud_nid_priority: NID prio of the requested NID.
 419  *   cud_net_priority: net prio of network of the requested NID.
 420  *   cud_pref_nid: array of preferred NIDs if it exists.
 421  */
 422 struct lnet_ioctl_construct_udsp_info {
 423         struct libcfs_ioctl_hdr cud_hdr;
 424         __u32 cud_peer:1;
 425         lnet_nid_t cud_nid;
 426         __u32 cud_nid_priority;
 427         __u32 cud_net_priority;
 428         lnet_nid_t cud_pref_nid[LNET_MAX_SHOW_NUM_NID];
 429         lnet_nid_t cud_pref_rtr_nid[LNET_MAX_SHOW_NUM_NID];
 430 };
 431
 432 #endif /* _LNET_DLC_H_ */