├── .github └── workflows │ └── todo.yml ├── LICENSE ├── README.md └── ibswinfo.sh /.github/workflows/todo.yml: -------------------------------------------------------------------------------- 1 | name: TODO to issue 2 | on: ["push"] 3 | jobs: 4 | build: 5 | runs-on: "ubuntu-latest" 6 | steps: 7 | - uses: "actions/checkout@master" 8 | - name: "TODO to Issue" 9 | uses: "alstr/todo-to-issue-action@master" 10 | with: 11 | REPO: ${{ github.repository }} 12 | BEFORE: ${{ github.event.before }} 13 | SHA: ${{ github.sha }} 14 | TOKEN: ${{ secrets.GITHUB_TOKEN }} 15 | LABEL: "# TODO" 16 | COMMENT_MARKER: "#" 17 | id: "todo" 18 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ibswinfo 2 | Get information from unmanaged NVIDIA Infiniband switches. 3 | 4 | 5 | ## Description 6 | 7 | `ibswinfo` is a simple script to get status and monitoring information from 8 | unmanaged NVIDIA Infiniband switches. 9 | 10 | NVIDIA Infiniband switches come in two flavors: 11 | 12 | * managed switches have their own management controller, which allows 13 | monitoring fan speeds and temperatures, getting serial numbers, or updating 14 | firmwares over a variety of protocols (SSH, SNMP, HTTPs...) 15 | 16 | * unmanaged switches are just that: unmanaged. 17 | 18 | Some in-band management is possible for unmanaged switches with NVIDIA firmware 19 | tools, but the only way to get their status is via the LEDs on their chassis: 20 | they're either green (that's good), or red (that's bad). But you won't know 21 | unless you physically take a look at them, which makes it difficult to get 22 | notifications and alerts when problems occur. 23 | 24 | `ibswinfo` helps solve this problem, by leveraging [NVIDIA Firmware Tools 25 | (MFT)](https://network.nvidia.com/products/adapter-software/firmware-tools/) to 26 | allow sysadmins to get more information about their unmanaged Infiniband 27 | switches. It can be used to gather hardware vitals such as fan speeds or 28 | temperatures, and monitor the switches more closely. 29 | 30 | As of version [0.6](https://github.com/stanford-rc/ibswinfo/releases/tag/0.6), 31 | `ibswinfo` also allows setting a user-friendly name (node description) for 32 | unmanaged switches. No more endless lists of identical and unhelpful switch 33 | names like "SwitchX - NVIDIA Networking", sysadmins can now customize each 34 | switch by setting a descriptive name, using their model, physical location, 35 | cluster name, etc. and make each switch more easily identifiable. 36 | 37 | 38 | ## Installation 39 | 40 | ### Dependencies 41 | 42 | * [NVIDIA Firmware Tools 43 | (MFT)](https://network.nvidia.com/products/adapter-software/firmware-tools/) 44 | 45 | \>= 4.18.0 46 | 47 | \>= 4.22.0 for switch name setting support 48 | 49 | * [`infiniband-diags`](https://github.com/linux-rdma/rdma-core) 50 | * `bash`, `coreutils`, `awk` and `sed` 51 | 52 | ### Preparation 53 | 54 | `ibswinfo` can address switches by using the virtual devices created by MST, 55 | the NVIDIA Software Tools service, or by LID. 56 | 57 | * to use the MST virtual devices, you can start the `mst` service and populate 58 | entries in `/dev/mst` with: 59 | 60 | ``` 61 | # mst start 62 | # mst ib add 63 | ``` 64 | 65 | Check that `/dev/mst` contains entries for your unmanaged switches (they 66 | should look like `/dev/mst/SW_*`), and you can run `ibswinfo` like this: 67 | ``` 68 | # ./ibswinfo.sh -d /dev/mst/SW_model_node-desc_lid-0x0001 69 | ``` 70 | or without the `/dev/mst` prefix, using the virtual device name directly: 71 | ``` 72 | # ./ibswinfo.sh -d SW_model_node-desc_lid-0x0001 73 | ``` 74 | 75 | * to address switches by LID, starting the `mst` service is not required. You 76 | can get currently assigned LIDs with `ibswitches`, and run `ibswinfo` 77 | directly like this: `./ibswinfo.sh -d lid-16` 78 | 79 | 80 | ## Supported hardware 81 | 82 | `ibswinfo` has been tested with the following unmanaged Infiniband switches: 83 | * SB7790 Switch-IB (EDR) (_known limitation: QSFP module temperatures reported 84 | as 0_) 85 | * SB7890 Switch-IB2 (EDR) 86 | * QM8790 Quantum (HDR) 87 | 88 | Limited support is also available for the managed version of those switches: 89 | * SB7800 Switch-IB2 (EDR) 90 | * QM8700 Quantum (HDR) 91 | 92 | > [!NOTE] 93 | > If you find other working models, please feel free to open an 94 | [issue](https://github.com/stanford-rc/ibswinfo/issues/new) and 95 | we'll complete the list. 96 | 97 | 98 | ### Available information 99 | 100 | * Node description (switch name) 101 | * Part number, serial number 102 | * PSID, GUID, firmware version 103 | * Uptime 104 | * Power supply information (status, consumption, part and serial numbers) 105 | * Temperatures (including QSFP modules temp.) 106 | * Fan speeds and status 107 | 108 | 109 | ## Usage 110 | 111 | ```none 112 | Usage: ibswinfo.sh -d [-T] [-o ] [-S ] 113 | 114 | global options: 115 | -d MST device path ("mst status" shows devices list) 116 | or LID (eg. "-d lid-44") 117 | get info: 118 | -o Only display inventory|vitals|status information 119 | -T get QSFP modules temperature 120 | 121 | set info: 122 | -S set device description (63 char max.) 123 | 124 | ``` 125 | 126 | ### Default output 127 | 128 | By default, `ibswinfo` presents all the available information for a switch in a 129 | table-like output: 130 | 131 | ```none 132 | # ./ibswinfo.sh -d 133 | ================================================= 134 | 135 | ================================================= 136 | part number | MQM8790-HS2F 137 | serial number | 138 | product name | Jaguar Unmng IB 200 139 | revision | AC 140 | ports | 40 141 | PSID | MT_0000000063 142 | GUID | 143 | firmware version | 27.2000.1886 144 | CPLD | 3 145 | ------------------------------------------------- 146 | uptime (d-h:m:s) | 196d-07:05:40 147 | ------------------------------------------------- 148 | PSU0 status | OK 149 | P/N | MTEF-PSF-AC-C 150 | S/N | 151 | DC power | OK 152 | fan status | OK 153 | power (W) | 64 154 | PSU1 status | OK 155 | P/N | MTEF-PSF-AC-C 156 | S/N | 157 | DC power | OK 158 | fan status | OK 159 | power (W) | 47 160 | ------------------------------------------------- 161 | temperature (C) | 34 162 | max temp (C) | 41 163 | warn threshold (C) | 95/105 (low/high) 164 | ------------------------------------------------- 165 | fan status | OK 166 | fan#1 (rpm) | 5426 167 | fan#2 (rpm) | 4746 168 | fan#3 (rpm) | 5426 169 | fan#4 (rpm) | 4798 170 | fan#5 (rpm) | 5426 171 | fan#6 (rpm) | 4815 172 | fan#7 (rpm) | 5382 173 | fan#8 (rpm) | 4868 174 | fan#9 (rpm) | 5471 175 | ------------------------------------------------- 176 | ``` 177 | 178 | ### Targeted outputs 179 | 180 | Specific information can be targeted by choosing the appropriate output type: 181 | `inventory`, `status` or `vitals`. 182 | 183 | This can be particularly useful to quickly get a switch's serial number, check 184 | its status to create alerts, or feed hardware metrics to a monitoring system. 185 | Targeted outputs are designed to be parsed for input to other tools. 186 | 187 | For instance, to only get hardware vitals, including QSFP temperatures: 188 | 189 | ``` 190 | # ./ibswinfo -d -o vitals -T 191 | uptime (sec) : 16982312 192 | psu0.power (W) : 92 193 | psu1.power (W) : 102 194 | cur.temp (C) : 73 195 | max.temp (C) : 80 196 | QSFP#01.temp (C) : 44 197 | QSFP#02.temp (C) : 43 198 | QSFP#03.temp (C) : 43 199 | QSFP#04.temp (C) : 47 200 | QSFP#05.temp (C) : 42 201 | QSFP#06.temp (C) : 46 202 | QSFP#07.temp (C) : 44 203 | QSFP#08.temp (C) : 46 204 | QSFP#09.temp (C) : 44 205 | QSFP#10.temp (C) : 45 206 | QSFP#11.temp (C) : 44 207 | QSFP#12.temp (C) : 44 208 | QSFP#13.temp (C) : 48 209 | QSFP#14.temp (C) : 47 210 | QSFP#15.temp (C) : 51 211 | QSFP#16.temp (C) : 49 212 | QSFP#17.temp (C) : 53 213 | QSFP#18.temp (C) : 50 214 | QSFP#19.temp (C) : 52 215 | QSFP#20.temp (C) : 50 216 | QSFP#21.temp (C) : 51 217 | QSFP#22.temp (C) : 49 218 | QSFP#23.temp (C) : 47 219 | QSFP#24.temp (C) : 47 220 | QSFP#25.temp (C) : 44 221 | QSFP#26.temp (C) : 44 222 | QSFP#27.temp (C) : 42 223 | QSFP#28.temp (C) : 46 224 | QSFP#29.temp (C) : 41 225 | QSFP#30.temp (C) : 45 226 | QSFP#31.temp (C) : 40 227 | QSFP#32.temp (C) : 45 228 | QSFP#33.temp (C) : 39 229 | QSFP#34.temp (C) : 44 230 | QSFP#35.temp (C) : 37 231 | QSFP#36.temp (C) : 39 232 | fan#1.speed (rpm) : 6355 233 | fan#2.speed (rpm) : 5421 234 | fan#3.speed (rpm) : 6570 235 | fan#4.speed (rpm) : 5508 236 | fan#5.speed (rpm) : 6415 237 | fan#6.speed (rpm) : 5486 238 | fan#7.speed (rpm) : 6268 239 | fan#8.speed (rpm) : 5421 240 | ``` 241 | 242 | Or, to only get fans and power supplies' status: 243 | 244 | ``` 245 | # ./ibswinfo -d -o status 246 | psu0.status : OK 247 | psu0.dc : OK 248 | psu0.fan : OK 249 | psu1.status : OK 250 | psu1.dc : OK 251 | psu1.fan : OK 252 | fans : OK 253 | ``` 254 | 255 | 256 | ### Setting switch names 257 | *requires `ibswinfo` >= 0.6 and MFT >= 4.22.0* 258 | 259 | Unmanaged switches' node descriptions can be customized, for easier management 260 | and better switch identification. 261 | 262 | To update a switch's name to ``" 263 | ``` 264 | # ./ibswinfo -d -S 265 | Device: 266 | Current node description: 267 | Set node description to : 268 | >> Confirm? (y/N) y 269 | Setting new node description... done! 270 | ``` 271 | 272 | By default, unmanaged Infiniband switches all come with the same node 273 | description, based on their model, and it can quickly become cumbersome to 274 | determine which is which. Setting customized and descriptive switch names can 275 | help solve that problem and allow better identification of switches in the 276 | datacenter. 277 | 278 | Before: 279 | ``` 280 | # ibswitches 281 | Switch : 0xXXXXXXXXXXXXXXXa ports 37 "SwitchX - Mellanox Technologies" base port 0 lid 1 lmc 0 282 | Switch : 0xXXXXXXXXXXXXXXXb ports 37 "SwitchX - Mellanox Technologies" base port 0 lid 2 lmc 0 283 | Switch : 0xXXXXXXXXXXXXXXXc ports 37 "SwitchX - Mellanox Technologies" base port 0 lid 3 lmc 0 284 | Switch : 0xXXXXXXXXXXXXXXXd ports 37 "SwitchX - Mellanox Technologies" base port 0 lid 4 lmc 0 285 | ``` 286 | 287 | After: 288 | ``` 289 | # ibswitches 290 | Switch : 0xXXXXXXXXXXXXXXXa ports 37 "switch1 in rack1 U1" base port 0 lid 1 lmc 0 291 | Switch : 0xXXXXXXXXXXXXXXXb ports 37 "switch2 in rack1 U3" base port 0 lid 2 lmc 0 292 | Switch : 0xXXXXXXXXXXXXXXXc ports 37 "switch3 in rack1 U5" base port 0 lid 3 lmc 0 293 | Switch : 0xXXXXXXXXXXXXXXXd ports 37 "switch4 in rack1 U7" base port 0 lid 4 lmc 0 294 | ``` 295 | 296 | 297 | 298 | -------------------------------------------------------------------------------- /ibswinfo.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # vim: set tabstop=4 expandtab shiftwidth=4: 3 | # vim: set textwidth=80: 4 | # 5 | #============================================================================== 6 | # ibswinfo 7 | # 8 | # Gather information from unmanaged Infiniband switches 9 | # 10 | # Requires : NVIDIA Firmare Tools (MFT) 11 | # 12 | # Author : Kilian Cavalotti 13 | # Created : 2020/04/20 14 | # License : GNU GPL v3 15 | # 16 | #============================================================================== 17 | 18 | set -e # stop on error 19 | set -u # stop on uninitialized variable 20 | 21 | ## -- constants --------------------------------------------------------------- 22 | 23 | MFT_URL="https://www.mellanox.com/products/adapter-software/firmware-tools" 24 | MAX_ND_LEN=64 25 | 26 | 27 | ## -- functions --------------------------------------------------------------- 28 | 29 | # display error and quit 30 | err() { 31 | [[ "$*" != "" ]] && echo "error: $*" >&2 32 | exit 1 33 | } 34 | 35 | # display warning and continue 36 | warn() { 37 | [[ "$*" != "" ]] && echo "warning: $*" >&2 38 | } 39 | 40 | # display separators 41 | sep() { echo "-------------------------------------------------" ;} 42 | dblsep() { echo "=================================================" ;} 43 | 44 | # display key-value 45 | out_kv() { 46 | local k=$1 47 | local v=$2 48 | local s 49 | [[ "${out:-}" != "" ]] && s=":" || s="|" 50 | [[ "$v" != "" ]] && printf "%-18s %s %s\n" "$k" "$s" "$v" || return 0 51 | } 52 | 53 | # hex to dec 54 | htod() { 55 | local d=$1 56 | echo $((16#${d//0x/})) 57 | } 58 | 59 | # hex to bin 60 | # $1: hex value to convert 61 | # $2: num bits to output 62 | htob() { 63 | local v=$1 64 | local b=${2:-16} 65 | for ((i=b-1; i>=0; i--)); do 66 | printf "%d" $(( (v>>i)%2 )); 67 | done 68 | echo 69 | } 70 | 71 | # dec to hex 72 | dtoh() { 73 | local h=$1 74 | printf "%x\n" "$h" 75 | } 76 | 77 | # hex to string 78 | # sample input: 79 | # 0x73656372657420 80 | # 0x6d657373616765 81 | # sample output: 82 | # secret message 83 | htos() { 84 | local h=$* 85 | local s 86 | s=$(sed 's/0x\|[[:space:]]//g; s/\(..\)/\\x\1/g' <<< "$h") 87 | printf "%b\n" "$s" | tr -d \\0 88 | } 89 | 90 | # string to hex array (split and padded) 91 | # sample input: 92 | # secret message 93 | # sample output: 94 | # 0x73656372 95 | # 0x6574206d 96 | # 0x65737361 97 | # 0x67650000 98 | stoh() { 99 | local str=$* 100 | local i chr hex 101 | local cks=8 # chunk size for splitting 102 | # convert 103 | for (( i=0; i<${#str}; i++ )); do 104 | chr="${str:$i:1}" 105 | hex+=$(printf "%x" "'${chr}") 106 | done 107 | # pad 108 | [[ $((${#hex}%cks)) != 0 ]] && \ 109 | hex+=$(printf "%-$((cks-${#hex}%cks))s" "" | tr ' ' '0') 110 | # split 111 | for (( i=0; i<${#hex}; i+=cks )); do 112 | echo "0x${hex:$i:$cks}" 113 | done 114 | } 115 | 116 | # seconds to d-h:m:s 117 | sec_to_dhms() { 118 | local s=$1 119 | printf '%dd-%02d:%02d:%02d\n' $((s/86400)) \ 120 | $((s%86400/3600)) \ 121 | $((s%3600/60)) \ 122 | $((s%60)) 123 | } 124 | 125 | # get register values 126 | # $1: reg name 127 | # $2: indexes (optional) 128 | get_reg() { 129 | local reg=$1 130 | local idx=${2:+--indexes "$2"} 131 | # shellcheck disable=SC2086 132 | mlxreg_ext -d "$dev" --reg_name "$reg" --get $idx 2>&1 133 | } 134 | 135 | # show register definition 136 | # $1: reg name 137 | show_reg() { 138 | local reg=$1 139 | mlxreg_ext -d "$dev" --show_reg "$reg" 2>&1 140 | } 141 | 142 | # decode multifield values from register 143 | # $1: field name (regex supported) 144 | # $2: reg name 145 | mstr_dec() { 146 | local f=$1 147 | local r=$2 148 | # sort fields, and convert them, in one fell swoop 149 | htos "$(awk -v f="$f" '$0 ~ f {gsub(/\[|\]/," "); print}' \ 150 | <<< "${reg[$r]}" | sort -k2n | awk '{printf $NF}')" 151 | } 152 | 153 | 154 | ## -- arg handling ------------------------------------------------------------ 155 | 156 | usage() { 157 | cat << EOU 158 | Usage: ${0##*/} -d [-T] [-o <$outputs>] [-S ] 159 | 160 | global options: 161 | -d MST device path ("mst status" shows devices list) 162 | or LID (eg. "-d lid-44") 163 | get info: 164 | -o Only display $outputs information 165 | -T get transceiver modules temperature 166 | 167 | set info: 168 | -S set device description ($MAX_ND_LEN char max.) 169 | -y skip confirmation 170 | 171 | EOU 172 | return 0 173 | } 174 | 175 | # defaults 176 | outputs="inventory|vitals|status" 177 | out="" 178 | dev="" 179 | desc="" 180 | opt_T=0 181 | opt_y=0 182 | optspec="hd:To:S:y" 183 | while getopts "$optspec" optchar; do 184 | case "${optchar}" in 185 | h|\?) 186 | usage >&2 187 | exit 2 188 | ;; 189 | d) 190 | dev=${OPTARG} 191 | ;; 192 | T) 193 | opt_T=1 194 | ;; 195 | o) 196 | out=${OPTARG} 197 | [[ ! "$out" =~ ^($outputs)$ ]] && { 198 | err "unknown output requested, not in $outputs" 199 | exit 2 200 | } 201 | ;; 202 | S) 203 | desc=${OPTARG} 204 | [[ ${#desc} -gt $MAX_ND_LEN ]] && { 205 | err "description string > $MAX_ND_LEN characters" 206 | exit 2 207 | } 208 | ;; 209 | y) 210 | opt_y=1 211 | ;; 212 | esac 213 | done 214 | 215 | # drop -T for inventory/status outputs 216 | [[ "$out" =~ inventory|status ]] && opt_T=0 217 | 218 | # check conflicting options 219 | [[ -n "$desc" ]] && [[ -n "$out" || "$opt_T" -eq 1 ]] && { 220 | err "conflicting options, can't get and set info at the same time" 221 | exit 2 222 | } 223 | 224 | 225 | ## -- checks ------------------------------------------------------------------ 226 | 227 | # id 228 | [[ "$(id -u)" == 0 ]] || err "must run as root, aborting." 229 | 230 | # tools and dependencies 231 | declare -A tools 232 | tools[awk]="" 233 | tools[sed]="" 234 | tools[tr]="coreutils" 235 | tools[paste]="coreutils" 236 | tools[mst]="MFT ($MFT_URL)" 237 | tools[mlxreg]="MFT ($MFT_URL)" 238 | tools[smpquery]="infiniband-diags" 239 | for t in "${!tools[@]}"; do 240 | type $t &>/dev/null || \ 241 | err "$t not found${tools[$t]:+, please install ${tools[$t]}}" 242 | done 243 | 244 | # MFT version 245 | mft_cur=$(mst version | awk '{gsub(/,/,""); print $3}' | cut -d- -f1) 246 | mft_req="4.18.0" # minimum required MFT version 247 | mft_req_desc="4.22.0" # minimum required MFT version to set device name 248 | mft_max="4.31.0" # highest MFT version tested 249 | mft_cur=$(mst version | awk '{gsub(/,/,""); print $3}' | cut -d- -f1) 250 | [[ ${mft_cur//./} -lt ${mft_req//./} ]] && \ 251 | err "MFT version must be >= $mft_req (current version is $mft_cur)" 252 | [[ "$desc" != "" ]] && [[ ${mft_cur//./} -lt ${mft_req_desc//./} ]] && \ 253 | err "MFT >= $mft_req_desc required to set device description" 254 | [[ ${mft_cur//./} -gt ${mft_max//./} ]] && \ 255 | warn "Not tested with MFT version $mft_cur, YMMV" 256 | 257 | 258 | # device 259 | [[ $dev == "" ]] && err "missing device argument" 260 | [[ ${dev:0:4} != "lid-" ]] && { 261 | [[ ${dev:0:8} == '/dev/mst' ]] && dev=${dev/\/dev\/mst\//} 262 | [[ ${dev:0:3} == "SW_" ]] || err "$dev doesn't look like a switch device name" 263 | [[ -r /dev/mst/$dev ]] || err "$dev not found in /dev/mst, is mst started?" 264 | } 265 | 266 | 267 | ## -- initiate registers ------------------------------------------------------ 268 | 269 | # PRM registers 270 | # cf. mft/prm_dbs/switch/ext/register_access_table.adb 271 | # and kernel:drivers/net/ethernet/mellanox/mlxsw/reg.h 272 | # 273 | # MGIR - Management General Information Register 274 | # MGPIR - Management General Peripheral Information Register 275 | # MSGI - Misc System General Information Register 276 | # MSCI - ...? CPLD information 277 | # MSPS - Misc System Power Supply Register 278 | # MTMP - Management Temperature 279 | # MTCAP - Management Temperature Capabilities 280 | # MFCR - Management Fan Control Register 281 | # FORE - Fan Out of Range Event Register 282 | # SPZR - ...? node description 283 | 284 | # gather register values 285 | declare -A reg 286 | declare -A rid 287 | # select register to read, depending on what output is required 288 | case $out in 289 | inventory) 290 | reg_names="MGIR MSGI MSCI SPZR MSPS" 291 | ;; 292 | status) 293 | reg_names="MGIR MGPIR MSPS MTMP MTCAP MFCR FORE" 294 | ;; 295 | vitals) 296 | reg_names="MGIR MGPIR MSPS MTMP MTCAP MFCR" 297 | ;; 298 | *) 299 | reg_names="MGIR MGPIR MSGI MSCI MSPS SPZR MTMP MTCAP MFCR FORE" 300 | ;; 301 | esac 302 | # some registers need an index 303 | # and that depends on the version of MFT we're using 304 | add_idx="" add_tmp_idx="" 305 | [[ ${mft_cur//./} -gt 4150 ]] && add_idx="slot_index=0x0" 306 | [[ ${mft_cur//./} -gt 4190 && \ 307 | ${mft_cur//./} -lt 4210 ]] && rid[MGIR]="module_base=0x0" 308 | [[ ${mft_cur//./} -ge 4230 ]] && rid[SPZR]="router_entity=0x0," 309 | [[ ${mft_cur//./} -ge 4301 ]] && add_tmp_idx="asic_index=0x0,ig=0x0,i=0x0," 310 | rid[MGPIR]+="slot_index=0x0" 311 | rid[MSCI]+="index=0x0" # handle main CPLD only 312 | rid[SPZR]+="swid=0x0" 313 | rid[MTMP]+="sensor_index=0x0${add_idx:+,$add_idx}${add_tmp_idx:+,$add_tmp_idx}" 314 | rid[MTCAP]="$add_idx" 315 | # get registers 316 | _regs=$(for r in $reg_names; do 317 | echo "$r" "$(get_reg "$r" "${rid[$r]:-}" |& paste -s -d '@')" & 318 | done) 319 | # store them 320 | while read -r r v; do 321 | o=${v//@/$'\n'} 322 | [[ "$o" =~ -E- ]] && [[ $r != MGPIR ]] && err "${o/-E-/}" 323 | reg[$r]=$o 324 | done <<< "$_regs" 325 | 326 | 327 | ## -- node description mgmt --------------------------------------------------- 328 | 329 | [[ -n "$desc" ]] && { 330 | # get current node description 331 | cur_nd=$(mstr_dec "node_description" SPZR) 332 | echo "Device: $dev" 333 | echo " Current node description: $cur_nd" 334 | echo " Set node description to : $desc" 335 | [[ "$opt_y" == "0" ]] && { 336 | read -p ">> Confirm? (y/N) " -n 1 -r 337 | echo 338 | [[ $REPLY =~ ^[Yy]$ ]] || exit 1 339 | } 340 | echo -n "Setting new node description... " 341 | 342 | # convert string to hex array 343 | mapfile -t nd_arr < <(stoh "$desc") 344 | val="ndm=0x1" 345 | for e in "${!nd_arr[@]}"; do 346 | val+=",node_description[$e]=${nd_arr[$e]}" 347 | done 348 | # fill all remaining fields with 0s to make sure we override all of the 349 | # previous node description 350 | ((e+=1)) 351 | while [[ $e -le 15 ]]; do 352 | val+=",node_description[$e]=0x00000000" 353 | ((e+=1)) 354 | done 355 | mlxreg_out=$(mlxreg_ext -d "$dev" --reg_name SPZR --set "$val" \ 356 | --indexes "${rid[SPZR]}" --yes) 357 | ret=$? 358 | [[ "$ret" != 0 ]] && { 359 | err "$mlxreg_out" 360 | exit $ret 361 | } 362 | echo "done!" 363 | exit 0 364 | } 365 | 366 | 367 | ## -- data gathering ---------------------------------------------------------- 368 | 369 | # extract data from register values 370 | # inventory 371 | [[ ! "$out" =~ status|vitals ]] && { 372 | # part/serial number 373 | pn=$(mstr_dec "part_number" MSGI) 374 | sn=$(mstr_dec "serial_number" MSGI) 375 | cn=$(mstr_dec "roduct_name" MSGI) 376 | rv=$(htos "$(awk '/^revision / {printf $NF}' <<< "${reg[MSGI]}")") 377 | 378 | # PSID 379 | psid=$(mstr_dec '^psid' MGIR) 380 | 381 | # FW version 382 | maj=$(htod "$(awk '/^extended_major / {printf $NF}' <<< "${reg[MGIR]}")") 383 | min=$(htod "$(awk '/^extended_minor / {printf $NF}' <<< "${reg[MGIR]}")") 384 | sub=$(htod "$(awk '/^extended_sub_minor / {printf $NF}' <<< "${reg[MGIR]}")") 385 | 386 | # CPLD version 387 | cpld=$(htod "$(awk '/^version / {printf $NF}' <<< "${reg[MSCI]}")") 388 | 389 | # node description 390 | #shellcheck disable=SC2046 391 | nd=$(mstr_dec "node_description" SPZR) 392 | guid=$(awk '/^node_guid/ {gsub(/0x/,"",$NF); g=g$NF} END {print "0x"g}' \ 393 | <<< "${reg[SPZR]}") 394 | } 395 | 396 | # status 397 | [[ ! "$out" =~ inventory|vitals ]] && { 398 | # fan under/over limit alerts 399 | fu=$(htod "$(awk '/^fan_under_limit / {printf $NF}' <<< "${reg[FORE]}")") 400 | fo=$(htod "$(awk '/^fan_over_limit / {printf $NF}' <<< "${reg[FORE]}")") 401 | # TODO break down FORE bitmasks to get alerted fan id 402 | [[ $((fo+fu)) == 0 ]] && fa="OK" || fa="ERROR" 403 | } 404 | 405 | # vitals and status 406 | [[ ! $out =~ inventory ]] && { 407 | # number of modules 408 | nm=$(htod "$(awk '/num_of_modules_per_system / {printf $NF}' <<< "${reg[MGPIR]}")") 409 | [[ $nm == 0 ]] && \ 410 | nm=$(htod "$(awk '/num_of_modules / {printf $NF}' <<< "${reg[MGPIR]}")") 411 | # max number of ports 412 | np=$(htod "$(awk '/num_ports / {printf $NF}' <<< "${reg[MGIR]}")") 413 | 414 | # uptime 415 | h_uptime=$(awk '/^uptime / {print $NF}' <<< "${reg[MGIR]}") 416 | s_uptime=$(htod "$h_uptime") 417 | 418 | # temperatures 419 | _tp=$(htod "$(awk '/^temperature / {printf $NF}' <<< "${reg[MTMP]}")") 420 | _mt=$(htod "$(awk '/^max_temperature / {printf $NF}' <<< "${reg[MTMP]}")") 421 | _twl=$(htod "$(awk '/^temperature_threshold_lo / {printf $NF}' <<< "${reg[MTMP]}")") 422 | _twh=$(htod "$(awk '/^temperature_threshold_hi / {printf $NF}' <<< "${reg[MTMP]}")") 423 | tp=$((_tp/8)) 424 | mt=$((_mt/8)) 425 | twl=$((_twl/8)) twh=$((_twh/8)) 426 | 427 | # optionally get modules temperature 428 | [[ "$opt_T" == "1" ]] && { 429 | _qtps=$(for q in $(seq 1 "$nm"); do 430 | i=$(dtoh $((q+63))) 431 | r="sensor_index=0x$i${add_idx:+,$add_idx}" 432 | r+=${add_tmp_idx:+,$add_tmp_idx} 433 | echo "$q" "$(get_reg MTMP "$r" |\ 434 | awk '/^temperature / {print $NF}')" & 435 | done) 436 | while read -r q t; do 437 | qt[$q]=$(($(htod "$t")/8)) 438 | done <<< "$_qtps" 439 | } 440 | 441 | # fan speeds 442 | # first tachos bitmask (lsb) 443 | atlsb_bmsz=$(awk '/^tacho_active / {printf $(NF-2)}' < <(show_reg MFCR)) 444 | atlsb_bmsk=$(htob "$(awk '/^tacho_active / {printf $NF}' \ 445 | <<< "${reg[MFCR]}")" "$atlsb_bmsz") 446 | # second tachos bitmask (msb) 447 | atmsb_bmsz=$(awk '/^tacho_active_msb / {printf $(NF-2)}' < <(show_reg MFCR)) 448 | atmsb_bmsk=$(htob "$(awk '/^tacho_active_msb / {printf $NF}' \ 449 | <<< "${reg[MFCR]}")" "$atmsb_bmsz") 450 | at_bmsz=$((atlsb_bmsz+atmsb_bmsz)) 451 | at_bmsk="${atmsb_bmsk}${atlsb_bmsk}" 452 | 453 | # gather fan speeds for active tachos 454 | for (( i=${#at_bmsk}-1; i>0; i-- )); do 455 | [[ ${at_bmsk:$((i-1)):1} == 1 ]] && at_idxs+="$((at_bmsz-i)) " 456 | done 457 | _fsps=$(for t in ${at_idxs:-}; do 458 | echo "$t" "$(get_reg MFSM "tacho=0x$(dtoh "$t")" |& 459 | awk '/^rpm / {print $NF}')" & 460 | done) 461 | while read -r t s; do 462 | fs[$t]=$(htod "${s:-0}") 463 | done <<< "$_fsps" 464 | } 465 | 466 | # PSUs (inventory/status/vitals) 467 | #shellcheck disable=SC2001 468 | psu_idxs=$(sed 's/.*psu\([0-9]\).*/\1/;t;d' <<< "${reg[MSPS]}" | sort -u) 469 | declare -A ps 470 | for i in $psu_idxs; do 471 | # get PSU status bitmasks, a lot of guessing is taking place here 472 | for j in 0 1; do 473 | _bm[$j]=$(awk -v i="$i" -v j="$j" '$0 ~ "psu"i"\\["j"\\]" { 474 | gsub(/0x/,""); print $NF}' <<< "${reg[MSPS]}") 475 | done 476 | _pr=${_bm[0]:0:1} # PSU present 477 | _dc=${_bm[0]: -2:1} # PSU DC status, maybe? 478 | _fs=${_bm[1]: -1:1} # PSU fan status 479 | [[ "$_pr" == 5 ]] && ps[$i.pr]="OK" || ps[$i.pr]="ERROR" 480 | [[ "$_fs" == 2 ]] && ps[$i.fs]="OK" || ps[$i.fs]="ERROR" 481 | [[ "$_fs" == 3 ]] && ps[$i.fs]="" # probably a managed switch 482 | [[ "$_dc" == 1 ]] && ps[$i.dc]="OK" || ps[$i.dc]="ERROR" 483 | 484 | # serial number 485 | ps[$i.sn]=$(htos "$(awk -v i="$i" '$0 ~ "psu"i && /psu.\[[4-6]\]/ { 486 | printf $NF}' <<< "${reg[MSPS]}")") 487 | # part number 488 | ps[$i.pn]=$(htos "$(awk -v i="$i" '$0 ~ "psu"i && /psu.\[1[2-5]\]/ { 489 | printf $NF}' <<< "${reg[MSPS]}")") 490 | # power consumption, some guessing too 491 | ps[$i.wt]=$(htod "$(awk -v i="$i" '$0 ~ "psu"i && /psu.\[2\]/ { 492 | gsub(/0x8/,"") 493 | printf $NF}' <<< "${reg[MSPS]}")") 494 | [[ ${ps[$i.wt]} == 0 ]] && ps[$i.wt]="" 495 | done 496 | 497 | 498 | # TODO consider interfaces counters (tx/rx) in PPCNT 499 | 500 | # TODO consider cable information in PDDR 501 | # idx local_port=0x[portnum],pnat=0x0,page_select=0x3,group_opcode=0x0 for PHYs 502 | 503 | 504 | ## -- output ------------------------------------------------------------------ 505 | 506 | # targeted outputs 507 | case $out in 508 | inventory) 509 | out_kv "node_desription" "$nd" 510 | out_kv "part_number" "$pn" 511 | out_kv "serial" "$sn" 512 | out_kv "product_name" "$cn" 513 | out_kv "revision" "$rv" 514 | out_kv "fw_version" "$(printf "%d.%04d.%04d" "$maj" "$min" "$sub")" 515 | out_kv "cpld" "$cpld" 516 | [[ "${ps[${psu_idxs:0:1}.pr]}" != "" ]] && { 517 | for i in $psu_idxs; do 518 | out_kv "psu$i.part_number" "${ps[$i.pn]}" 519 | out_kv "psu$i.serial" "${ps[$i.sn]}" 520 | done 521 | } 522 | exit 0 523 | ;; 524 | 525 | status) 526 | [[ "${ps[${psu_idxs:0:1}.pr]}" != "" ]] && { 527 | for i in $psu_idxs; do 528 | out_kv "psu$i.status" "${ps[$i.pr]}" 529 | out_kv "psu$i.dc" "${ps[$i.dc]}" 530 | out_kv "psu$i.fan" "${ps[$i.fs]}" 531 | done 532 | } 533 | out_kv "fans" "$fa" 534 | exit 0 535 | ;; 536 | 537 | 538 | vitals) 539 | out_kv "uptime (sec)" "$s_uptime" 540 | [[ "${ps[${psu_idxs:0:1}.pr]}" != "" ]] && { 541 | for i in $psu_idxs; do 542 | out_kv "psu$i.power (W)" "${ps[$i.wt]}" 543 | done 544 | } 545 | out_kv "cur.temp (C)" "${tp}" 546 | out_kv "max.temp (C)" "${mt}" 547 | [[ "$opt_T" == "1" ]] && { 548 | for q in $(seq 1 "$nm"); do 549 | out_kv "module#$(printf "%02d" "$q").temp (C)" "${qt[$q]}" 550 | done 551 | } 552 | for t in ${at_idxs:-}; do 553 | out_kv "fan#$t.speed (rpm)" "${fs[$t]}" 554 | done 555 | exit 0 556 | ;; 557 | esac 558 | 559 | 560 | ## full (default) output 561 | dblsep 562 | echo " $nd" 563 | dblsep 564 | out_kv "part number" "$pn" 565 | out_kv "serial number" "$sn" 566 | out_kv "product name" "$cn" 567 | out_kv "revision" "$rv" 568 | out_kv "modules" "$nm" 569 | out_kv "max ports" "$np" 570 | out_kv "PSID" "$psid" 571 | out_kv "GUID" "$guid" 572 | out_kv "firmware version" "$(printf "%d.%04d.%04d" "$maj" "$min" "$sub")" 573 | out_kv "CPLD" "$cpld" 574 | sep 575 | out_kv "uptime (d-h:m:s)" "$(sec_to_dhms "$s_uptime")" 576 | sep 577 | [[ "${ps[${psu_idxs:0:1}.pr]}" != "" ]] && { 578 | for i in $psu_idxs; do 579 | out_kv "PSU$i status" "${ps[$i.pr]}" 580 | out_kv " P/N" "${ps[$i.pn]}" 581 | out_kv " S/N" "${ps[$i.sn]}" 582 | out_kv " DC power" "${ps[$i.dc]}" 583 | out_kv " fan status" "${ps[$i.fs]}" 584 | out_kv " power (W)" "${ps[$i.wt]}" 585 | done 586 | sep 587 | } 588 | out_kv "temperature (C)" "${tp}" 589 | out_kv "max temp (C)" "${mt}" 590 | out_kv "warn threshold (C)" "$twl/$twh (low/high)" 591 | [[ "$opt_T" == "1" ]] && { 592 | for q in $(seq 1 "$nm"); do 593 | out_kv "module#$(printf "%02d" "$q") (C) " "${qt[$q]}" 594 | done 595 | } 596 | sep 597 | 598 | # fan status 599 | out_kv "fan status" "$fa" 600 | for t in ${at_idxs:-}; do 601 | out_kv "fan#$t (rpm)" "${fs[$t]}" 602 | done 603 | [[ ${at_idxs:-} != "" ]] && sep 604 | 605 | --------------------------------------------------------------------------------