lustre/doc/lctl.lyx

   1 #LyX 1.2 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 220
   3 \textclass amsart-plain
   4 \language english
   5 \inputencoding auto
   6 \fontscheme times
   7 \graphics default
   8 \paperfontsize default
   9 \spacing single
  10 \papersize letterpaper
  11 \paperpackage a4
  12 \use_geometry 0
  13 \use_amsmath 0
  14 \use_natbib 0
  15 \use_numerical_citations 0
  16 \paperorientation portrait
  17 \secnumdepth 3
  18 \tocdepth 3
  19 \paragraph_separation skip
  20 \defskip medskip
  21 \quotes_language english
  22 \quotes_times 2
  23 \papercolumns 1
  24 \papersides 1
  25 \paperpagestyle default
  26
  27 \layout Section
  28
  29 lctl
  30 \layout Subsection
  31
  32 NAME
  33 \layout Description
  34
  35 lctl Low level Lustre filesystem configuration utility.
  36 \layout Subsection
  37
  38 SYNOPSIS
  39 \layout Standard
  40
  41
  42 \series bold
  43 \emph on
  44 \SpecialChar ~
  45
  46 \newline
  47 lctl
  48 \layout Standard
  49
  50
  51 \series bold
  52 \emph on
  53 lctl\SpecialChar ~
  54 --device\SpecialChar ~
  55 <devno> <command\SpecialChar ~
  56 [args]>
  57 \layout Standard
  58
  59
  60 \series bold
  61 \emph on
  62 lctl\SpecialChar ~
  63 --threads\SpecialChar ~
  64 <numthreads>\SpecialChar ~
  65 <verbose>\SpecialChar ~
  66 <devno>\SpecialChar ~
  67 <command [args]>
  68 \layout Subsection
  69
  70 DESCRIPTION
  71 \layout Standard
  72
  73 The program can be invoked in interactive mode by issuing
  74 \series bold
  75 lctl.
  76
  77 \series default
  78  After that, commands are issued as below.
  79  The most common commands in lctl are (in matching pairs)
  80 \family typewriter
  81 \size small
  82 device
  83 \family default
  84 \size default
  85  and
  86 \family typewriter
  87 \size small
  88 attach
  89 \family default
  90 \size default
  91 ,
  92 \family typewriter
  93 \size small
  94 detach
  95 \family default
  96 \size default
  97  and
  98 \family typewriter
  99 \size small
 100 setup
 101 \family default
 102 \size default
 103 ,
 104 \family typewriter
 105 \size small
 106 cleanup
 107 \family default
 108 \size default
 109  and
 110 \family typewriter
 111 \size small
 112 connect
 113 \family default
 114 \size default
 115 ,
 116 \family typewriter
 117 \size small
 118 disconnect
 119 \family default
 120 \size default
 121  and
 122 \family typewriter
 123 \size small
 124 help
 125 \family default
 126 \size default
 127 , and
 128 \family typewriter
 129 \size small
 130 quit
 131 \family default
 132 \size default
 133 .
 134  To get a complete listing of available commands, type
 135 \family typewriter
 136 \size small
 137 help
 138 \family default
 139 \size default
 140  at the lctl prompt.
 141   To get basic help on the meaning and syntax of a command, type
 142 \family typewriter
 143 \size small
 144 help command
 145 \family default
 146 \size default
 147 .
 148   Command completion is activated with the
 149 \family typewriter
 150 \size small
 151 TAB
 152 \family default
 153 \size default
 154  key, and command history is available via the up- and down-arrow keys.
 155
 156 \layout Standard
 157
 158 For non-interactive single threaded use, one uses the second invocation,
 159  which runs
 160 \emph on
 161 command
 162 \emph default
 163  after connecting to the device
 164 \emph on
 165 .
 166
 167 \emph default
 168
 169 \layout List
 170 \labelwidthstring 00.00.0000
 171
 172
 173 \series bold
 174 \emph on
 175 --device
 176 \series default
 177 \emph default
 178  The device number to be used for the operation.
 179  The value of devno is an integer, normally found by calling
 180 \emph on
 181 lctl name2dev
 182 \emph default
 183 on a device name.
 184
 185 \layout List
 186 \labelwidthstring 00.00.0000
 187
 188
 189 \series bold
 190 \emph on
 191 --threads
 192 \series default
 193 \emph default
 194  How many threads should be forked doing the command specified.
 195  The numthreads variable is a strictly positivie integer indicating how
 196  many threads should be started.
 197  Verbose can take values <XXXX>;
 198 \emph on
 199 devno
 200 \emph default
 201 is used as above.
 202 \layout LyX-Code
 203
 204 \layout LyX-Code
 205
 206 \layout Description
 207
 208 Network\SpecialChar ~
 209 Configuration
 210 \begin_deeper
 211 \layout List
 212 \labelwidthstring 00.00.0000
 213
 214
 215 \series bold
 216 \emph on
 217 network\SpecialChar ~
 218 <tcp/elans/myrinet>
 219 \series default
 220 \emph default
 221  Indicate what kind of network applies for the configuration commands that
 222  follow.
 223 \layout List
 224 \labelwidthstring 00.00.0000
 225
 226
 227 \series bold
 228 \emph on
 229 connect\SpecialChar ~
 230 [[<hostname>\SpecialChar ~
 231 <port>]\SpecialChar ~
 232 |\SpecialChar ~
 233 <elan\SpecialChar ~
 234 id>]
 235 \series default
 236 \emph default
 237  This will establish a connection to a remote network network
 238 \emph on
 239 id
 240 \emph default
 241  given by the hostname/port combination, or the elan
 242 \emph on
 243 id
 244 \emph default
 245 .
 246 \layout List
 247 \labelwidthstring 00.00.0000
 248
 249
 250 \series bold
 251 \emph on
 252 disconnect\SpecialChar ~
 253 <nid>
 254 \series default
 255 \emph default
 256  Disconnect from a remote
 257 \emph on
 258 nid
 259 \emph default
 260 .
 261 \layout List
 262 \labelwidthstring 00.00.0000
 263
 264
 265 \series bold
 266 \emph on
 267 mynid\SpecialChar ~
 268 [nid]
 269 \series default
 270 \emph default
 271  Informs the socknal of the local
 272 \emph on
 273 nid
 274 \emph default
 275 .
 276  It defaults to hostname for tcp networks and is automatically setup for
 277  elan/myrinet networks.
 278 \layout List
 279 \labelwidthstring 00.00.0000
 280
 281
 282 \series bold
 283 \emph on
 284 add_uuid\SpecialChar ~
 285 <uuid>\SpecialChar ~
 286 <nid>
 287 \series default
 288 \emph default
 289  Associate a given UUID with an
 290 \emph on
 291 nid.
 292 \layout List
 293 \labelwidthstring 00.00.0000
 294
 295
 296 \series bold
 297 \emph on
 298 close_uuid\SpecialChar ~
 299 <uuid>
 300 \series default
 301 \emph default
 302  Disconnect a UUID.
 303 \layout List
 304 \labelwidthstring 00.00.0000
 305
 306
 307 \series bold
 308 \emph on
 309 del_uuid\SpecialChar ~
 310 <uuid>
 311 \series default
 312 \emph default
 313  Delete a UUID association.
 314 \layout List
 315 \labelwidthstring 00.00.0000
 316
 317
 318 \series bold
 319 \emph on
 320 add_route\SpecialChar ~
 321 <gateway>\SpecialChar ~
 322 <target>\SpecialChar ~
 323 [target]
 324 \series default
 325 \emph default
 326  Add an entry to the routing table for the given target.
 327 \layout List
 328 \labelwidthstring 00.00.0000
 329
 330
 331 \series bold
 332 \emph on
 333 del_route\SpecialChar ~
 334 <target>
 335 \series default
 336 \emph default
 337  Delete an entry for the target from the routing table.
 338 \layout List
 339 \labelwidthstring 00.00.0000
 340
 341
 342 \series bold
 343 \emph on
 344 route_list
 345 \series default
 346 \emph default
 347  Print the complete routing table.
 348 \layout List
 349 \labelwidthstring 00.00.0000
 350
 351
 352 \series bold
 353 \emph on
 354 recv_mem\SpecialChar ~
 355 [size]
 356 \series default
 357 \emph default
 358  Set the socket
 359 \emph on
 360 receive
 361 \emph default
 362  buffer size; if the size is omitted, the default size for the buffer is
 363  printed.
 364 \layout List
 365 \labelwidthstring 00.00.0000
 366
 367
 368 \series bold
 369 \emph on
 370 send_mem\SpecialChar ~
 371 [size]
 372 \series default
 373 \emph default
 374  Set send buffer size for the socket; if size is omitted, the default size
 375  for the buffer is printed.
 376 \layout List
 377 \labelwidthstring 00.00.0000
 378
 379
 380 \series bold
 381 \emph on
 382 nagle\SpecialChar ~
 383 [on/off]
 384 \series default
 385 \emph default
 386  Enable/disable nagle; omitting the argument will cause the default value
 387  to be printed.
 388 \end_deeper
 389 \layout Description
 390
 391 Device\SpecialChar ~
 392 Selection
 393 \begin_deeper
 394 \layout List
 395 \labelwidthstring 00.00.0000
 396
 397
 398 \series bold
 399 \emph on
 400 newdev
 401 \series default
 402 \emph default
 403  Create a new device.
 404 \layout List
 405 \labelwidthstring 00.00.0000
 406
 407
 408 \series bold
 409 \emph on
 410 name2dev
 411 \series default
 412 \emph default
 413  This command can be used to determine a device number for the given device
 414  name.
 415 \layout List
 416 \labelwidthstring 00.00.0000
 417
 418
 419 \series bold
 420 \emph on
 421 device
 422 \series default
 423 \emph default
 424  This will select the specified OBD device.
 425   All other commands depend on the device being set.
 426
 427 \layout List
 428 \labelwidthstring 00.00.0000
 429
 430
 431 \series bold
 432 \emph on
 433 device_list
 434 \series default
 435 \emph default
 436  Show all the devices.
 437 \end_deeper
 438 \layout Description
 439
 440 Device\SpecialChar ~
 441 Configuration
 442 \begin_deeper
 443 \layout List
 444 \labelwidthstring 00.00.0000
 445
 446
 447 \series bold
 448 \emph on
 449 attach\SpecialChar ~
 450 type\SpecialChar ~
 451 [name\SpecialChar ~
 452 [uuid]]
 453 \series default
 454 \emph default
 455
 456 \shape italic
 457 \emph on
 458 Attach
 459 \shape default
 460 \emph default
 461  a type to the current device (which you need to set using the
 462 \family typewriter
 463 \size small
 464 device
 465 \family default
 466 \size default
 467  command) and give that device a name and UUID.
 468   This allows us to identify the device for use later, and also tells us
 469  what type of device we will have.
 470 \layout List
 471 \labelwidthstring 00.00.0000
 472
 473
 474 \series bold
 475 \emph on
 476 setup\SpecialChar ~
 477 <args...>
 478 \series default
 479 \emph default
 480  Type specific device setup commands.
 481  For obdfilter, a setup command tells the driver which block device it should
 482  use for storage and what type of filesystem is on that device.
 483
 484 \layout List
 485 \labelwidthstring 00.00.0000
 486
 487
 488 \series bold
 489 \emph on
 490 cleanup
 491 \series default
 492 \emph default
 493  Cleanup a previously setup device.
 494 \layout List
 495 \labelwidthstring 00.00.0000
 496
 497
 498 \series bold
 499 \emph on
 500 detach
 501 \series default
 502 \emph default
 503  Remove driver (and name and UUID) from the current device.
 504 \layout List
 505 \labelwidthstring 00.00.0000
 506
 507
 508 \series bold
 509 \emph on
 510 lov_setconfig\SpecialChar ~
 511 lov-uuid\SpecialChar ~
 512 default-stripe-count\SpecialChar ~
 513 default-stripe-size\SpecialChar ~
 514 offset\SpecialChar ~
 515 pattern\SpecialChar ~
 516 UUID1\SpecialChar ~
 517 [U
 518 UID2...]
 519 \series default
 520 \emph default
 521  Write LOV configuration to an MDS device.
 522 \layout List
 523 \labelwidthstring 00.00.0000
 524
 525
 526 \series bold
 527 \emph on
 528 lov_getconfig\SpecialChar ~
 529 lov-uuid
 530 \series default
 531 \emph default
 532  Read LOV configuration from an MDS device.
 533  Returns default-stripe-count, default-stripe-size, offset, pattern, and
 534  a list of OST UUID's.
 535 \end_deeper
 536 \layout Description
 537
 538 Device\SpecialChar ~
 539 Operations
 540 \begin_deeper
 541 \layout List
 542 \labelwidthstring 00.00.0000
 543
 544
 545 \series bold
 546 \emph on
 547 probe\SpecialChar ~
 548 [timeout]
 549 \series default
 550 \emph default
 551  Build a connection handle to a device.
 552  This command is used to suspend configuration until the lctl command has
 553  ensured that the MDS and OSC services are available.
 554  This is to avoid mount failures in a rebooting cluster.
 555 \layout List
 556 \labelwidthstring 00.00.0000
 557
 558
 559 \series bold
 560 \emph on
 561 close
 562 \emph default
 563
 564 \layout List
 565 \labelwidthstring 00.00.0000
 566
 567
 568 \series bold
 569 \emph on
 570 getattr\SpecialChar ~
 571 <objid>
 572 \series default
 573 \emph default
 574  Get attributes for an OST object
 575 \emph on
 576 <objid>
 577 \emph default
 578  .
 579 \layout List
 580 \labelwidthstring 00.00.0000
 581
 582
 583 \series bold
 584 \emph on
 585 setattr\SpecialChar ~
 586 <objid>\SpecialChar ~
 587 <mode>
 588 \series default
 589 \emph default
 590  Set mode attribute for OST object
 591 \emph on
 592 <objid>
 593 \emph default
 594 .
 595 \layout List
 596 \labelwidthstring 00.00.0000
 597
 598
 599 \series bold
 600 \emph on
 601 create\SpecialChar ~
 602 [num\SpecialChar ~
 603 [mode\SpecialChar ~
 604 [verbose]]]
 605 \series default
 606 \emph default
 607  Create the specified number
 608 \emph on
 609 <num>
 610 \emph default
 611  of OST objects with the given
 612 \emph on
 613 <mode>
 614 \emph default
 615 .
 616 \layout List
 617 \labelwidthstring 00.00.0000
 618
 619
 620 \series bold
 621 \emph on
 622 destroy\SpecialChar ~
 623 <objid>
 624 \series default
 625 \emph default
 626  Destroy an OST object.
 627 \layout List
 628 \labelwidthstring 00.00.0000
 629
 630
 631 \series bold
 632 \emph on
 633 test_getattr\SpecialChar ~
 634 <num>\SpecialChar ~
 635 [verbose\SpecialChar ~
 636 [[t]objid]]
 637 \series default
 638 \emph default
 639  Do
 640 \emph on
 641 <num>
 642 \emph default
 643
 644 \emph on
 645 getattrs
 646 \emph default
 647  on OST object
 648 \emph on
 649 <objid>
 650 \emph default
 651  (
 652 \emph on
 653 objectid
 654 \emph default
 655 +1 on each thread).
 656 \layout List
 657 \labelwidthstring 00.00.0000
 658
 659
 660 \series bold
 661 \emph on
 662 test_brw\SpecialChar ~
 663 [t]<num>\SpecialChar ~
 664 [write\SpecialChar ~
 665 [verbose\SpecialChar ~
 666 [npages\SpecialChar ~
 667 [[t]objid]]]]
 668 \series default
 669 \emph default
 670  Do
 671 \emph on
 672 <num>
 673 \emph default
 674  bulk
 675 \emph on
 676 read
 677 \emph default
 678 /
 679 \emph on
 680 writes
 681 \emph default
 682  on OST object
 683 \emph on
 684 <objid>
 685 \emph default
 686  (
 687 \emph on
 688 <npages>
 689 \emph default
 690  per I/O).
 691 \layout List
 692 \labelwidthstring 00.00.0000
 693
 694
 695 \series bold
 696 \emph on
 697 test_ldlm
 698 \series default
 699 \emph default
 700  Perform lock manager test.
 701 \layout List
 702 \labelwidthstring 00.00.0000
 703
 704
 705 \series bold
 706 \emph on
 707 ldlm_regress_start\SpecialChar ~
 708 %s\SpecialChar ~
 709 [numthreads\SpecialChar ~
 710 [refheld\SpecialChar ~
 711 [numres\SpecialChar ~
 712 [numext]]]]
 713 \series default
 714 \emph default
 715  Start lock manager stress test.
 716 \layout List
 717 \labelwidthstring 00.00.0000
 718
 719
 720 \series bold
 721 \emph on
 722 ldlm_regress_stop
 723 \series default
 724 \emph default
 725  Stop lock manager stress test.
 726 \layout List
 727 \labelwidthstring 00.00.0000
 728
 729
 730 \series bold
 731 \emph on
 732 dump_ldlm
 733 \series default
 734 \emph default
 735  Dump all lock manager state, this is very useful for debugging
 736 \layout List
 737 \labelwidthstring 00.00.0000
 738
 739
 740 \series bold
 741 \emph on
 742 newconn\SpecialChar ~
 743 <olduuid>\SpecialChar ~
 744 [newuuid]
 745 \end_deeper
 746 \layout Description
 747
 748 Debug
 749 \begin_deeper
 750 \layout List
 751 \labelwidthstring 00.00.0000
 752
 753
 754 \series bold
 755 \emph on
 756 debug_kernel\SpecialChar ~
 757 [file]\SpecialChar ~
 758 [raw]
 759 \series default
 760 \emph default
 761  Get debug buffer and dump to a
 762 \emph on
 763 fileusage
 764 \emph default
 765 .
 766 \layout List
 767 \labelwidthstring 00.00.0000
 768
 769
 770 \series bold
 771 \emph on
 772 debug_file\SpecialChar ~
 773 <input>\SpecialChar ~
 774 [output]\SpecialChar ~
 775 [raw]
 776 \series default
 777 \emph default
 778  Read debug buffer from input and dump to
 779 \emph on
 780 outputusage
 781 \emph default
 782 .
 783 \layout List
 784 \labelwidthstring 00.00.0000
 785
 786
 787 \series bold
 788 \emph on
 789 clear
 790 \series default
 791 \emph default
 792  Clear kernel debug buffer.
 793 \layout List
 794 \labelwidthstring 00.00.0000
 795
 796
 797 \series bold
 798 \emph on
 799 mark\SpecialChar ~
 800 <text>
 801 \series default
 802 \emph default
 803  Insert marker text in kernel debug buffer.
 804 \layout List
 805 \labelwidthstring 00.00.0000
 806
 807
 808 \series bold
 809 \emph on
 810 filter\SpecialChar ~
 811 <subsystem\SpecialChar ~
 812 id/debug\SpecialChar ~
 813 mask>
 814 \series default
 815 \emph default
 816  Filter message type from the kernel debug buffer.
 817 \layout List
 818 \labelwidthstring 00.00.0000
 819
 820
 821 \series bold
 822 \emph on
 823 show\SpecialChar ~
 824 <subsystem\SpecialChar ~
 825 id/debug\SpecialChar ~
 826 mask>
 827 \series default
 828 \emph default
 829  Show specific type of messages.
 830 \layout List
 831 \labelwidthstring 00.00.0000
 832
 833
 834 \series bold
 835 \emph on
 836 debug_list\SpecialChar ~
 837 <subs/types>
 838 \series default
 839 \emph default
 840  List all the subsystem and debug types.
 841 \layout List
 842 \labelwidthstring 00.00.0000
 843
 844
 845 \series bold
 846 \emph on
 847 panic
 848 \series default
 849 \emph default
 850  Force the kernel to panic.
 851 \end_deeper
 852 \layout Description
 853
 854 Control
 855 \begin_deeper
 856 \layout List
 857 \labelwidthstring 00.00.0000
 858
 859
 860 \series bold
 861 \emph on
 862 help
 863 \series default
 864 \emph default
 865  Show a complete list of commands;
 866 \emph on
 867 help <command name>
 868 \emph default
 869  can be used to get help on specific command.
 870 \layout List
 871 \labelwidthstring 00.00.0000
 872
 873
 874 \series bold
 875 \emph on
 876 exit
 877 \series default
 878 \emph default
 879  Close the lctl session.
 880 \layout List
 881 \labelwidthstring 00.00.0000
 882
 883
 884 \series bold
 885 \emph on
 886 quit
 887 \series default
 888 \emph default
 889  Close the lctl session.
 890 \end_deeper
 891 \layout Subsection
 892
 893 EXAMPLES
 894 \layout Description
 895
 896
 897 \emph on
 898 attach
 899 \layout LyX-Code
 900
 901
 902 \size small
 903 # lctl
 904 \newline
 905 lctl > newdev
 906 \newline
 907 lctl > attach obdfilter OBDDEV OBDUUID
 908 \size default
 909
 910 \newline
 911
 912 \layout Description
 913
 914
 915 \emph on
 916 connect
 917 \layout LyX-Code
 918
 919
 920 \size small
 921 lctl > name2dev OSCDEV
 922 \newline
 923 2
 924 \newline
 925 lctl > device 2
 926 \newline
 927 lctl > connect
 928 \size default
 929
 930 \newline
 931
 932 \layout Description
 933
 934
 935 \emph on
 936 getattr
 937 \layout LyX-Code
 938
 939
 940 \size small
 941 lctl > getattr 12
 942 \newline
 943 id: 12
 944 \newline
 945 grp: 0
 946 \newline
 947 atime: 1002663714
 948 \newline
 949 mtime: 1002663535
 950 \newline
 951 ctime: 1002663535
 952 \newline
 953 size: 10
 954 \newline
 955 blocks: 8
 956 \newline
 957 blksize: 4096
 958 \newline
 959 mode: 100644
 960 \newline
 961 uid: 0
 962 \newline
 963 gid: 0
 964 \newline
 965 flags: 0
 966 \newline
 967 obdflags: 0
 968 \newline
 969 nlink: 1
 970 \newline
 971 valid: ffffffff
 972 \newline
 973 inline:
 974 \newline
 975 obdmd:
 976 \newline
 977 lctl > disconnect
 978 \newline
 979 Finished (success)
 980 \newline
 981
 982 \layout Description
 983
 984
 985 \emph on
 986 setup
 987 \emph default
 988
 989 \layout LyX-Code
 990
 991
 992 \size small
 993 lctl > setup /dev/loop0 extN
 994 \newline
 995 lctl > quit
 996 \size default
 997
 998 \newline
 999
1000 \layout LyX-Code
1001
1002 \layout Subsection
1003
1004 BUGS
1005 \layout Standard
1006
1007 None are known.
1008 \the_end