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