Whamcloud - gitweb
8ec4069aa23f38fdc54ed219ba448074f907655d
[fs/lustre-release.git] / lnet / utils / lnetconfig / liblnetconfig.h
1 /*
2  * LGPL 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 Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of the
9  * License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful, but
12  * 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. If not, see <http://www.gnu.org/licenses/>.
18  *
19  * LGPL HEADER END
20  *
21  * Copyright (c) 2014, 2017, Intel Corporation.
22  *
23  * Author:
24  *   Amir Shehata <amir.shehata@intel.com>
25  */
26
27 #ifndef LIB_LNET_CONFIG_API_H
28 #define LIB_LNET_CONFIG_API_H
29
30 #include <net/if.h>
31 #include <libcfs/util/string.h>
32 #include <linux/lnet/lnet-dlc.h>
33 #include <linux/lnet/nidstr.h>
34
35 #define LUSTRE_CFG_RC_NO_ERR                     0
36 #define LUSTRE_CFG_RC_BAD_PARAM                 -1
37 #define LUSTRE_CFG_RC_MISSING_PARAM             -2
38 #define LUSTRE_CFG_RC_OUT_OF_RANGE_PARAM        -3
39 #define LUSTRE_CFG_RC_OUT_OF_MEM                -4
40 #define LUSTRE_CFG_RC_GENERIC_ERR               -5
41 #define LUSTRE_CFG_RC_NO_MATCH                  -6
42 #define LUSTRE_CFG_RC_MATCH                     -7
43 #define LUSTRE_CFG_RC_SKIP                      -8
44 #define LUSTRE_CFG_RC_LAST_ELEM                 -9
45
46 struct lnet_dlc_network_descr {
47         struct list_head network_on_rule;
48         __u32 nw_id;
49         struct list_head nw_intflist;
50 };
51
52 struct lnet_dlc_intf_descr {
53         struct list_head intf_on_network;
54         char intf_name[IFNAMSIZ];
55         struct cfs_expr_list *cpt_expr;
56 };
57
58 /* forward declaration of the cYAML structure. */
59 struct cYAML;
60
61 /*
62  * lustre_lnet_config_lib_init()
63  *   Initialize the Library to enable communication with the LNET kernel
64  *   module.  Returns the device ID or -EINVAL if there is an error
65  */
66 int lustre_lnet_config_lib_init();
67
68 /*
69  * lustre_lnet_config_lib_uninit
70  *      Uninitialize the DLC Library
71  */
72 void lustre_lnet_config_lib_uninit();
73
74 /*
75  * lustre_lnet_config_ni_system
76  *   Initialize/Uninitialize the lnet NI system.
77  *
78  *   up - whehter to init or uninit the system
79  *   load_ni_from_mod - load NI from mod params.
80  *   seq_no - sequence number of the request
81  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
82  *            caller
83  */
84 int lustre_lnet_config_ni_system(bool up, bool load_ni_from_mod,
85                                  int seq_no, struct cYAML **err_rc);
86
87 /*
88  * lustre_lnet_config_route
89  *   Send down an IOCTL to the kernel to configure the route
90  *
91  *   nw - network
92  *   gw - gateway
93  *   hops - number of hops passed down by the user
94  *   prio - priority of the route
95  *   seq_no - sequence number of the request
96  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
97  */
98 int lustre_lnet_config_route(char *nw, char *gw, int hops, int prio,
99                              int seq_no, struct cYAML **err_rc);
100
101 /*
102  * lustre_lnet_del_route
103  *   Send down an IOCTL to the kernel to delete a route
104  *
105  *   nw - network
106  *   gw - gateway
107  *   seq_no - sequence number of the request
108  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
109  */
110 int lustre_lnet_del_route(char *nw, char *gw, int seq_no,
111                           struct cYAML **err_rc);
112
113 /*
114  * lustre_lnet_show_route
115  *   Send down an IOCTL to the kernel to show routes
116  *   This function will get one route at a time and filter according to
117  *   provided parameters. If no routes are available then it will dump all
118  *   routes that are in the system.
119  *
120  *   nw - network.  Optional.  Used to filter output
121  *   gw - gateway. Optional. Used to filter ouptut
122  *   hops - number of hops passed down by the user
123  *          Optional.  Used to filter output.
124  *   prio - priority of the route.  Optional.  Used to filter output.
125  *   detail - flag to indicate whether detail output is required
126  *   seq_no - sequence number of the request
127  *   show_rc - [OUT] The show output in YAML.  Must be freed by caller.
128  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
129  *   backup - true to output only what's necessary for reconfiguring
130  *            a node.
131  */
132 int lustre_lnet_show_route(char *nw, char *gw,
133                            int hops, int prio, int detail,
134                            int seq_no, struct cYAML **show_rc,
135                            struct cYAML **err_rc, bool backup);
136
137 /*
138  * lustre_lnet_config_ni
139  *   Send down an IOCTL to configure a network interface. It implicitly
140  *   creates a network if one doesn't exist..
141  *
142  *   nw_descr - network and interface descriptor
143  *   global_cpts - globally defined CPTs
144  *   ip2net - this parameter allows configuring multiple networks.
145  *      it takes precedence over the net and intf parameters
146  *   tunables - LND tunables
147  *   seq_no - sequence number of the request
148  *   lnd_tunables - lnet specific tunable parameters
149  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
150  */
151 int lustre_lnet_config_ni(struct lnet_dlc_network_descr *nw_descr,
152                           struct cfs_expr_list *global_cpts,
153                           char *ip2net,
154                           struct lnet_ioctl_config_lnd_tunables *tunables,
155                           int seq_no, struct cYAML **err_rc);
156
157 /*
158  * lustre_lnet_del_ni
159  *   Send down an IOCTL to delete a network interface. It implicitly
160  *   deletes a network if it becomes empty of nis
161  *
162  *   nw  - network and interface list
163  *   seq_no - sequence number of the request
164  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
165  */
166 int lustre_lnet_del_ni(struct lnet_dlc_network_descr *nw,
167                        int seq_no, struct cYAML **err_rc);
168
169 /*
170  * lustre_lnet_show_net
171  *   Send down an IOCTL to show networks.
172  *   This function will use the nw paramter to filter the output.  If it's
173  *   not provided then all networks are listed.
174  *
175  *   nw - network to show.  Optional.  Used to filter output.
176  *   detail - flag to indicate if we require detail output.
177  *   seq_no - sequence number of the request
178  *   show_rc - [OUT] The show output in YAML.  Must be freed by caller.
179  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
180  *   backup - true to output only what's necessary for reconfiguring
181  *            a node.
182  */
183 int lustre_lnet_show_net(char *nw, int detail, int seq_no,
184                          struct cYAML **show_rc, struct cYAML **err_rc,
185                          bool backup);
186
187 /*
188  * lustre_lnet_enable_routing
189  *   Send down an IOCTL to enable or diable routing
190  *
191  *   enable - 1 to enable routing, 0 to disable routing
192  *   seq_no - sequence number of the request
193  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
194  */
195 int lustre_lnet_enable_routing(int enable, int seq_no,
196                                struct cYAML **err_rc);
197
198 /*
199  * lustre_lnet_config_numa_range
200  *   Set the NUMA range which impacts the NIs to be selected
201  *   during sending. If the NUMA range is large the NUMA
202  *   distance between the message memory and the NI becomes
203  *   less significant. The NUMA range is a relative number
204  *   with no other meaning besides allowing a wider breadth
205  *   for picking an NI to send from.
206  *
207  *   range - numa range value.
208  *   seq_no - sequence number of the request
209  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
210  *   caller
211  */
212 int lustre_lnet_config_numa_range(int range, int seq_no,
213                                   struct cYAML **err_rc);
214
215 /*
216  * lustre_lnet_show_num_range
217  *   Get the currently set NUMA range
218  *
219  *   seq_no - sequence number of the request
220  *   show_rc - [OUT] struct cYAML tree containing NUMA range info
221  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
222  *   caller
223  */
224 int lustre_lnet_show_numa_range(int seq_no, struct cYAML **show_rc,
225                                 struct cYAML **err_rc);
226
227 /*
228  * lustre_lnet_config_ni_healthv
229  *   set the health value of the NI. -1 resets the value to maximum.
230  *
231  *   value: health value to set.
232  *   all: true to set all local NIs to that value.
233  *   ni_nid: NI NID to set its health value. all parameter always takes
234  *   precedence
235  *   seq_no - sequence number of the request
236  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
237  *   caller
238  */
239 int lustre_lnet_config_ni_healthv(int value, bool all, char *ni_nid,
240                                   int seq_no, struct cYAML **err_rc);
241
242 /*
243  * lustre_lnet_config_peer_ni_healthv
244  *   set the health value of the peer NI. -1 resets the value to maximum.
245  *
246  *   value: health value to set.
247  *   all: true to set all local NIs to that value.
248  *   pni_nid: Peer NI NID to set its health value. all parameter always takes
249  *   precedence
250  *   seq_no - sequence number of the request
251  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
252  *   caller
253  */
254 int lustre_lnet_config_peer_ni_healthv(int value, bool all, char *pni_nid,
255                                        int seq_no, struct cYAML **err_rc);
256
257 /*
258  * lustre_lnet_config_hsensitivity
259  *   sets the health sensitivity; the value by which to decrement the
260  *   health value of a local or peer NI. If 0 then health is turned off
261  *
262  *   sen - sensitivity value to configure
263  *   seq_no - sequence number of the request
264  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
265  *   caller
266  */
267 int lustre_lnet_config_hsensitivity(int sen, int seq_no, struct cYAML **err_rc);
268
269 /*
270  * lustre_lnet_show_hsensitivity
271  *    show the health sensitivity in the system
272  *
273  *   seq_no - sequence number of the request
274  *   show_rc - [OUT] struct cYAML tree containing health sensitivity info
275  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
276  *   caller
277  */
278 int lustre_lnet_show_hsensitivity(int seq_no, struct cYAML **show_rc,
279                                   struct cYAML **err_rc);
280
281 /*
282  * lustre_lnet_config_transaction_to
283  *   sets the timeout after which a message expires or a timeout event is
284  *   propagated for an expired response.
285  *
286  *   timeout - timeout value to configure
287  *   seq_no - sequence number of the request
288  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
289  *   caller
290  */
291 int lustre_lnet_config_transaction_to(int timeout, int seq_no, struct cYAML **err_rc);
292
293 /*
294  * lustre_lnet_show_transaction_to
295  *    show the transaction timeout in the system
296  *
297  *   seq_no - sequence number of the request
298  *   show_rc - [OUT] struct cYAML tree containing transaction timeout info
299  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
300  *   caller
301  */
302 int lustre_lnet_show_transaction_to(int seq_no, struct cYAML **show_rc,
303                                     struct cYAML **err_rc);
304
305 /*
306  * lustre_lnet_config_retry_count
307  *   sets the maximum number of retries to resend a message
308  *
309  *   count - maximum value to configure
310  *   seq_no - sequence number of the request
311  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
312  *   caller
313  */
314 int lustre_lnet_config_retry_count(int count, int seq_no, struct cYAML **err_rc);
315
316 /*
317  * lustre_lnet_show_retry_count
318  *    show current maximum number of retries in the system
319  *
320  *   seq_no - sequence number of the request
321  *   show_rc - [OUT] struct cYAML tree containing retry count info
322  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
323  *   caller
324  */
325 int lustre_lnet_show_retry_count(int seq_no, struct cYAML **show_rc,
326                                  struct cYAML **err_rc);
327
328 /*
329  * lustre_lnet_config_max_intf
330  *   Sets the maximum number of interfaces per node. this tunable is
331  *   primarily useful for sanity checks prior to allocating memory.
332  *
333  *   max - maximum value to configure
334  *   seq_no - sequence number of the request
335  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
336  *   caller
337  */
338 int lustre_lnet_config_max_intf(int max, int seq_no, struct cYAML **err_rc);
339
340 /*
341  * lustre_lnet_show_max_intf
342  *    show current maximum interface setting
343  *
344  *   seq_no - sequence number of the request
345  *   show_rc - [OUT] struct cYAML tree containing NUMA range info
346  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
347  *   caller
348  */
349 int lustre_lnet_show_max_intf(int seq_no, struct cYAML **show_rc,
350                               struct cYAML **err_rc);
351
352 /*
353  * lustre_lnet_config_discovery
354  *   Enable or disable peer discovery. Peer discovery is enabled by default.
355  *
356  *   enable - non-0 enables, 0 disables
357  *   seq_no - sequence number of the request
358  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
359  *   caller
360  */
361 int lustre_lnet_config_discovery(int enable, int seq_no, struct cYAML **err_rc);
362
363 /*
364  * lustre_lnet_show_discovery
365  *    show current peer discovery setting
366  *
367  *   seq_no - sequence number of the request
368  *   show_rc - [OUT] struct cYAML tree containing NUMA range info
369  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by
370  *   caller
371  */
372 int lustre_lnet_show_discovery(int seq_no, struct cYAML **show_rc,
373                                struct cYAML **err_rc);
374
375 /*
376  * lustre_lnet_config_buffers
377  *   Send down an IOCTL to configure routing buffer sizes.  A value of 0 means
378  *   default that particular buffer to default size. A value of -1 means
379  *   leave the value of the buffer un changed.
380  *
381  *   tiny - tiny buffers
382  *   small - small buffers
383  *   large - large buffers.
384  *   seq_no - sequence number of the request
385  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
386  */
387 int lustre_lnet_config_buffers(int tiny, int small, int large,
388                                int seq_no, struct cYAML **err_rc);
389
390 /*
391  * lustre_lnet_show_routing
392  *   Send down an IOCTL to dump buffers and routing status
393  *   This function is used to dump buffers for all CPU partitions.
394  *
395  *   seq_no - sequence number of the request
396  *   show_rc - [OUT] The show output in YAML.  Must be freed by caller.
397  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
398  *   backup - true to output only what's necessary for reconfiguring
399  *            a node.
400  */
401 int lustre_lnet_show_routing(int seq_no, struct cYAML **show_rc,
402                              struct cYAML **err_rc, bool backup);
403
404 /*
405  * lustre_lnet_show_stats
406  *   Shows internal LNET statistics.  This is useful to display the
407  *   current LNET activity, such as number of messages route, etc
408  *
409  *     seq_no - sequence number of the command
410  *     show_rc - YAML structure of the resultant show
411  *     err_rc - YAML strucutre of the resultant return code.
412  */
413 int lustre_lnet_show_stats(int seq_no, struct cYAML **show_rc,
414                            struct cYAML **err_rc);
415
416 /*
417  * lustre_lnet_config_peer_nid
418  *   Add a peer nid to a peer with primary nid pnid. If no pnid is given
419  *   then the first nid in the nid list becomes the primary nid for
420  *   a newly created peer.
421  *   Otherwise if pnid is provided and it's unique then a new peer is
422  *   created with pnid as the primary NID and the nids in the nid list as
423  *   secondary nids.
424  *   If any of the peers nids provided in with exception to the pnid is
425  *   not unique the operation fails. Some peer nids might have already
426  *   been added. It's the role of the caller of this API to remove the
427  *   added NIDs if they wish.
428  *
429  *     pnid - Primary NID of the peer
430  *     nid - list of nids to add
431  *     num_nids - number of nids in the nid array
432  *     mr - true if this peer is MR capable.
433  *     ip2nets - true if a list of nid expressions are given to configure
434  *     multiple peers
435  *     seq_no - sequence number of the command
436  *     err_rc - YAML strucutre of the resultant return code.
437  */
438 int lustre_lnet_config_peer_nid(char *pnid, char **nid, int num_nids,
439                                 bool mr, bool ip2nets, int seq_no,
440                                 struct cYAML **err_rc);
441
442 /*
443  * lustre_lnet_del_peer_nid
444  *  Delete the nids given in the nid list from the peer with primary NID
445  *  pnid. If pnid is NULL or it doesn't identify a peer the operation
446  *  fails and no change happens to the system.
447  *  The operation is aborted on the first NID that fails to be deleted.
448  *
449  *     pnid - Primary NID of the peer
450  *     nid - list of nids to add
451  *     num_nids - number of nids in the nid array
452  *     ip2nets - used to specify a range of nids
453  *     seq_no - sequence number of the command
454  *     err_rc - YAML strucutre of the resultant return code.
455  */
456 int lustre_lnet_del_peer_nid(char *pnid, char **nid, int num_nids,
457                              bool ip2nets, int seq_no, struct cYAML **err_rc);
458
459 /*
460  * lustre_lnet_show_peer
461  *   Show the peer identified by nid, knid. If knid is NULL all
462  *   peers in the system are shown.
463  *
464  *     knid - A NID of the peer
465  *     detail - display detailed information
466  *     seq_no - sequence number of the command
467  *     show_rc - YAML structure of the resultant show
468  *     err_rc - YAML strucutre of the resultant return code.
469  *     backup - true to output only what's necessary for reconfiguring
470  *              a node.
471  *
472  */
473 int lustre_lnet_show_peer(char *knid, int detail, int seq_no,
474                           struct cYAML **show_rc, struct cYAML **err_rc,
475                           bool backup);
476
477 /*
478  * lustre_lnet_list_peer
479  *   List the known peers.
480  *
481  *     seq_no - sequence number of the command
482  *     show_rc - YAML structure of the resultant show
483  *     err_rc - YAML strucutre of the resultant return code.
484  *
485  */
486 int lustre_lnet_list_peer(int seq_no,
487                           struct cYAML **show_rc, struct cYAML **err_rc);
488
489 /* lustre_lnet_ping_nid
490  *   Ping the nid list, pnids.
491  *
492  *    pnids - NID list to ping.
493  *    timeout - timeout(seconds) for ping.
494  *    seq_no - sequence number of the command.
495  *    show_rc - YAML structure of the resultant show.
496  *    err_rc - YAML strucutre of the resultant return code.
497  *
498  */
499 int lustre_lnet_ping_nid(char *pnid, int timeout, int seq_no,
500                         struct cYAML **show_rc, struct cYAML **err_rc);
501
502 /* lustre_lnet_discover_nid
503  *   Discover the nid list, pnids.
504  *
505  *    pnids - NID list to discover.
506  *    force - force discovery.
507  *    seq_no - sequence number of the command.
508  *    show_rc - YAML structure of the resultant show.
509  *    err_rc - YAML strucutre of the resultant return code.
510  *
511  */
512 int lustre_lnet_discover_nid(char *pnid, int force, int seq_no,
513                              struct cYAML **show_rc, struct cYAML **err_rc);
514
515 /*
516  * lustre_yaml_config
517  *   Parses the provided YAML file and then calls the specific APIs
518  *   to configure the entities identified in the file
519  *
520  *   f - YAML file
521  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
522  */
523 int lustre_yaml_config(char *f, struct cYAML **err_rc);
524
525 /*
526  * lustre_yaml_del
527  *   Parses the provided YAML file and then calls the specific APIs
528  *   to delete the entities identified in the file
529  *
530  *   f - YAML file
531  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
532  */
533 int lustre_yaml_del(char *f, struct cYAML **err_rc);
534
535 /*
536  * lustre_yaml_show
537  *   Parses the provided YAML file and then calls the specific APIs
538  *   to show the entities identified in the file
539  *
540  *   f - YAML file
541  *   show_rc - [OUT] The show output in YAML.  Must be freed by caller.
542  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
543  */
544 int lustre_yaml_show(char *f, struct cYAML **show_rc,
545                      struct cYAML **err_rc);
546
547 /*
548  * lustre_yaml_exec
549  *   Parses the provided YAML file and then calls the specific APIs
550  *   to execute the entities identified in the file
551  *
552  *   f - YAML file
553  *   show_rc - [OUT] The show output in YAML.  Must be freed by caller.
554  *   err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
555  */
556 int lustre_yaml_exec(char *f, struct cYAML **show_rc,
557                      struct cYAML **err_rc);
558
559 /*
560  * lustre_lnet_init_nw_descr
561  *      initialize the network descriptor structure for use
562  */
563 void lustre_lnet_init_nw_descr(struct lnet_dlc_network_descr *nw_descr);
564
565 /*
566  * lustre_lnet_parse_interfaces
567  *      prase an interface string and populate descriptor structures
568  *              intf_str - interface string of the format
569  *                      <intf>[<expr>], <intf>[<expr>],..
570  *              nw_descr - network descriptor to populate
571  *              init - True to initialize nw_descr
572  */
573 int lustre_lnet_parse_interfaces(char *intf_str,
574                                  struct lnet_dlc_network_descr *nw_descr);
575
576 /*
577  * lustre_lnet_parse_nids
578  *      Parse a set of nids into a locally allocated array and return the
579  *      pointer of the array to the caller. The caller is responsible for
580  *      freeing the array. If an initial array is provided then copy over
581  *      the contents of that array into the new array and append to it the
582  *      new content.
583  *      The nids can be of the form "nid [,nid, nid, nid]"
584  *              nids: nids string to be parsed
585  *              array: initial array of content
586  *              size: num of elements in the array
587  *              out_array: [OUT] new allocated array.
588  *      Returns size of array
589  *              sets the out_array to NULL on failure.
590  */
591 int lustre_lnet_parse_nids(char *nids, char **array, int size,
592                            char ***out_array);
593
594 #endif /* LIB_LNET_CONFIG_API_H */