[eb03905] | 1 | @c |
---|
| 2 | @c COPYRIGHT (c) 1988-2008. |
---|
| 3 | @c On-Line Applications Research Corporation (OAR). |
---|
| 4 | @c All rights reserved. |
---|
| 5 | |
---|
[88d2967] | 6 | @chapter RTEMS Specific Commands |
---|
[eb03905] | 7 | |
---|
| 8 | @section Introduction |
---|
| 9 | |
---|
| 10 | The RTEMS shell has the following rtems commands: |
---|
| 11 | |
---|
| 12 | @itemize @bullet |
---|
| 13 | |
---|
[bac3d6d] | 14 | @item @code{shutdown} - Shutdown the system |
---|
[eb03905] | 15 | @item @code{cpuuse} - print or reset per thread cpu usage |
---|
| 16 | @item @code{stackuse} - print per thread stack usage |
---|
| 17 | @item @code{perioduse} - print or reset per period usage |
---|
[2bd71d95] | 18 | @item @code{profreport} - print a profiling report |
---|
[eb03905] | 19 | @item @code{wkspace} - Display information on Executive Workspace |
---|
| 20 | @item @code{config} - Show the system configuration. |
---|
| 21 | @item @code{itask} - List init tasks for the system |
---|
| 22 | @item @code{extension} - Display information about extensions |
---|
| 23 | @item @code{task} - Display information about tasks |
---|
| 24 | @item @code{queue} - Display information about message queues |
---|
| 25 | @item @code{sema} - display information about semaphores |
---|
| 26 | @item @code{region} - display information about regions |
---|
| 27 | @item @code{part} - display information about partitions |
---|
| 28 | @item @code{object} - Display information about RTEMS objects |
---|
| 29 | @item @code{driver} - Display the RTEMS device driver table |
---|
| 30 | @item @code{dname} - Displays information about named drivers |
---|
[75d16dd8] | 31 | @item @code{pthread} - Displays information about POSIX threads |
---|
[eb03905] | 32 | |
---|
| 33 | @end itemize |
---|
| 34 | |
---|
| 35 | @section Commands |
---|
| 36 | |
---|
[88d2967] | 37 | This section details the RTEMS Specific Commands available. A |
---|
| 38 | subsection is dedicated to each of the commands and |
---|
| 39 | describes the behavior and configuration of that |
---|
| 40 | command as well as providing an example usage. |
---|
[0a90bf2] | 41 | |
---|
| 42 | @c |
---|
| 43 | @c |
---|
| 44 | @c |
---|
| 45 | @page |
---|
[bac3d6d] | 46 | @subsection shutdown - Shutdown the system |
---|
[0a90bf2] | 47 | |
---|
[bac3d6d] | 48 | @pgindex shutdown |
---|
[0a90bf2] | 49 | |
---|
| 50 | @subheading SYNOPSYS: |
---|
| 51 | |
---|
| 52 | @example |
---|
[bac3d6d] | 53 | shutdown |
---|
[0a90bf2] | 54 | @end example |
---|
| 55 | |
---|
| 56 | @subheading DESCRIPTION: |
---|
| 57 | |
---|
| 58 | This command is used to shutdown the RTEMS application. |
---|
| 59 | |
---|
| 60 | @subheading EXIT STATUS: |
---|
| 61 | |
---|
| 62 | This command does not return. |
---|
| 63 | |
---|
| 64 | @subheading NOTES: |
---|
| 65 | |
---|
| 66 | |
---|
| 67 | @subheading EXAMPLES: |
---|
| 68 | |
---|
[bac3d6d] | 69 | The following is an example of how to use @code{shutdown}: |
---|
[0a90bf2] | 70 | |
---|
| 71 | @example |
---|
[bac3d6d] | 72 | SHLL [/] $ shutdown |
---|
| 73 | System shutting down at user request |
---|
[0a90bf2] | 74 | @end example |
---|
| 75 | |
---|
| 76 | The user will not see another prompt and the system will |
---|
| 77 | shutdown. |
---|
| 78 | |
---|
| 79 | @subheading CONFIGURATION: |
---|
| 80 | |
---|
[bac3d6d] | 81 | @findex CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN |
---|
| 82 | @findex CONFIGURE_SHELL_COMMAND_SHUTDOWN |
---|
[0a90bf2] | 83 | |
---|
| 84 | This command is included in the default shell command set. |
---|
| 85 | When building a custom command set, define |
---|
[bac3d6d] | 86 | @code{CONFIGURE_SHELL_COMMAND_SHUTDOWN} to have this |
---|
[0a90bf2] | 87 | command included. |
---|
| 88 | |
---|
| 89 | This command can be excluded from the shell command set by |
---|
[bac3d6d] | 90 | defining @code{CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN} when all |
---|
[0a90bf2] | 91 | shell commands have been configured. |
---|
| 92 | |
---|
| 93 | @subheading PROGRAMMING INFORMATION: |
---|
| 94 | |
---|
[bac3d6d] | 95 | The configuration structure for the @code{shutdown} has the |
---|
[0a90bf2] | 96 | following prototype: |
---|
| 97 | |
---|
| 98 | @example |
---|
[bac3d6d] | 99 | extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command; |
---|
[0a90bf2] | 100 | @end example |
---|
| 101 | |
---|
[eb03905] | 102 | @c |
---|
| 103 | @c |
---|
| 104 | @c |
---|
| 105 | @page |
---|
| 106 | @subsection cpuuse - print or reset per thread cpu usage |
---|
| 107 | |
---|
| 108 | @pgindex cpuuse |
---|
| 109 | |
---|
| 110 | @subheading SYNOPSYS: |
---|
| 111 | |
---|
[ea08043] | 112 | @example |
---|
[eb03905] | 113 | cpuuse [-r] |
---|
[ea08043] | 114 | @end example |
---|
[eb03905] | 115 | |
---|
| 116 | @subheading DESCRIPTION: |
---|
| 117 | |
---|
[88d2967] | 118 | This command may be used to print a report on the per thread |
---|
| 119 | cpu usage or to reset the per thread CPU usage statistics. When |
---|
| 120 | invoked with the @code{-r} option, the CPU usage statistics |
---|
| 121 | are reset. |
---|
[eb03905] | 122 | |
---|
[ea08043] | 123 | @subheading EXIT STATUS: |
---|
| 124 | |
---|
| 125 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 126 | |
---|
[eb03905] | 127 | @subheading NOTES: |
---|
| 128 | |
---|
[88d2967] | 129 | The granularity of the timing information reported is dependent |
---|
| 130 | upon the BSP and the manner in which RTEMS was built. In the |
---|
| 131 | default RTEMS configuration, if the BSP supports nanosecond |
---|
| 132 | granularity timestamps, then the information reported will be |
---|
| 133 | highly accurate. Otherwise, the accuracy of the information |
---|
| 134 | reported is limited by the clock tick quantum. |
---|
[eb03905] | 135 | |
---|
| 136 | @subheading EXAMPLES: |
---|
| 137 | |
---|
[dc1c4308] | 138 | The following is an example of how to use @code{cpuuse}: |
---|
[eb03905] | 139 | |
---|
| 140 | @example |
---|
[88d2967] | 141 | SHLL [/] $ cpuuse |
---|
| 142 | CPU Usage by thread |
---|
| 143 | ID NAME SECONDS PERCENT |
---|
| 144 | 0x09010001 IDLE 49.745393 98.953 |
---|
| 145 | 0x0a010001 UI1 0.000000 0.000 |
---|
| 146 | 0x0a010002 SHLL 0.525928 1.046 |
---|
| 147 | Time since last CPU Usage reset 50.271321 seconds |
---|
| 148 | SHLL [/] $ cpuuse -r |
---|
| 149 | Resetting CPU Usage information |
---|
| 150 | SHLL [/] $ cpuuse |
---|
| 151 | CPU Usage by thread |
---|
| 152 | ID NAME SECONDS PERCENT |
---|
| 153 | 0x09010001 IDLE 0.000000 0.000 |
---|
| 154 | 0x0a010001 UI1 0.000000 0.000 |
---|
| 155 | 0x0a010002 SHLL 0.003092 100.000 |
---|
| 156 | Time since last CPU Usage reset 0.003092 seconds |
---|
[eb03905] | 157 | @end example |
---|
| 158 | |
---|
[88d2967] | 159 | In the above example, the system had set idle for nearly |
---|
| 160 | a minute when the first report was generated. The |
---|
| 161 | @code{cpuuse -r} and @code{cpuuse} commands were pasted |
---|
| 162 | from another window so were executed with no gap between. |
---|
| 163 | In the second report, only the @code{shell} thread has |
---|
| 164 | run since the CPU Usage was reset. It has consumed |
---|
| 165 | approximately 3.092 milliseconds of CPU time processing |
---|
| 166 | the two commands and generating the output. |
---|
| 167 | |
---|
[eb03905] | 168 | @subheading CONFIGURATION: |
---|
| 169 | |
---|
| 170 | @findex CONFIGURE_SHELL_NO_COMMAND_CPUUSE |
---|
| 171 | @findex CONFIGURE_SHELL_COMMAND_CPUUSE |
---|
| 172 | |
---|
[b88d9ccf] | 173 | This command is included in the default shell command set. |
---|
| 174 | When building a custom command set, define |
---|
| 175 | @code{CONFIGURE_SHELL_COMMAND_CPUUSE} to have this |
---|
| 176 | command included. |
---|
[eb03905] | 177 | |
---|
[b88d9ccf] | 178 | This command can be excluded from the shell command set by |
---|
| 179 | defining @code{CONFIGURE_SHELL_NO_COMMAND_CPUUSE} when all |
---|
[4f973104] | 180 | shell commands have been configured. |
---|
[eb03905] | 181 | |
---|
| 182 | @subheading PROGRAMMING INFORMATION: |
---|
| 183 | |
---|
| 184 | @findex rtems_shell_rtems_main_cpuuse |
---|
| 185 | |
---|
[dc1c4308] | 186 | The @code{cpuuse} is implemented by a C language function |
---|
[eb03905] | 187 | which has the following prototype: |
---|
| 188 | |
---|
| 189 | @example |
---|
| 190 | int rtems_shell_rtems_main_cpuuse( |
---|
| 191 | int argc, |
---|
| 192 | char **argv |
---|
| 193 | ); |
---|
| 194 | @end example |
---|
| 195 | |
---|
[dc1c4308] | 196 | The configuration structure for the @code{cpuuse} has the |
---|
[eb03905] | 197 | following prototype: |
---|
| 198 | |
---|
| 199 | @example |
---|
| 200 | extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command; |
---|
| 201 | @end example |
---|
| 202 | |
---|
| 203 | @c |
---|
| 204 | @c |
---|
| 205 | @c |
---|
| 206 | @page |
---|
| 207 | @subsection stackuse - print per thread stack usage |
---|
| 208 | |
---|
| 209 | @pgindex stackuse |
---|
| 210 | |
---|
| 211 | @subheading SYNOPSYS: |
---|
| 212 | |
---|
[ea08043] | 213 | @example |
---|
[eb03905] | 214 | stackuse |
---|
[ea08043] | 215 | @end example |
---|
[eb03905] | 216 | |
---|
| 217 | @subheading DESCRIPTION: |
---|
| 218 | |
---|
[88d2967] | 219 | This command prints a Stack Usage Report for all of the tasks |
---|
| 220 | and threads in the system. On systems which support it, the |
---|
| 221 | usage of the interrupt stack is also included in the report. |
---|
[eb03905] | 222 | |
---|
[ea08043] | 223 | @subheading EXIT STATUS: |
---|
| 224 | |
---|
[88d2967] | 225 | This command always succeeds and returns 0. |
---|
[ea08043] | 226 | |
---|
[eb03905] | 227 | @subheading NOTES: |
---|
| 228 | |
---|
[5d2c65e] | 229 | The @code{CONFIGURE_STACK_CHECKER_ENABLED} @code{confdefs.h} constant |
---|
[88d2967] | 230 | must be defined when the application is configured for this |
---|
| 231 | command to have any information to report. |
---|
[eb03905] | 232 | |
---|
| 233 | @subheading EXAMPLES: |
---|
| 234 | |
---|
[dc1c4308] | 235 | The following is an example of how to use @code{stackuse}: |
---|
[eb03905] | 236 | |
---|
[88d2967] | 237 | @smallexample |
---|
| 238 | SHLL [/] $ stackuse |
---|
| 239 | Stack usage by thread |
---|
| 240 | ID NAME LOW HIGH CURRENT AVAILABLE USED |
---|
| 241 | 0x09010001 IDLE 0x023d89a0 - 0x023d99af 0x023d9760 4096 608 |
---|
| 242 | 0x0a010001 UI1 0x023d9f30 - 0x023daf3f 0x023dad18 4096 1804 |
---|
| 243 | 0x0a010002 SHLL 0x023db4c0 - 0x023df4cf 0x023de9d0 16384 5116 |
---|
| 244 | 0xffffffff INTR 0x023d2760 - 0x023d375f 0x00000000 4080 316 |
---|
| 245 | @end smallexample |
---|
[eb03905] | 246 | |
---|
| 247 | @subheading CONFIGURATION: |
---|
| 248 | |
---|
| 249 | @findex CONFIGURE_SHELL_NO_COMMAND_STACKUSE |
---|
| 250 | @findex CONFIGURE_SHELL_COMMAND_STACKUSE |
---|
| 251 | |
---|
[b88d9ccf] | 252 | This command is included in the default shell command set. |
---|
| 253 | When building a custom command set, define |
---|
| 254 | @code{CONFIGURE_SHELL_COMMAND_STACKUSE} to have this |
---|
| 255 | command included. |
---|
[eb03905] | 256 | |
---|
[b88d9ccf] | 257 | This command can be excluded from the shell command set by |
---|
| 258 | defining @code{CONFIGURE_SHELL_NO_COMMAND_STACKUSE} when all |
---|
[4f973104] | 259 | shell commands have been configured. |
---|
[eb03905] | 260 | |
---|
| 261 | @subheading PROGRAMMING INFORMATION: |
---|
| 262 | |
---|
| 263 | @findex rtems_shell_rtems_main_stackuse |
---|
| 264 | |
---|
[dc1c4308] | 265 | The @code{stackuse} is implemented by a C language function |
---|
[eb03905] | 266 | which has the following prototype: |
---|
| 267 | |
---|
| 268 | @example |
---|
| 269 | int rtems_shell_rtems_main_stackuse( |
---|
| 270 | int argc, |
---|
| 271 | char **argv |
---|
| 272 | ); |
---|
| 273 | @end example |
---|
| 274 | |
---|
[dc1c4308] | 275 | The configuration structure for the @code{stackuse} has the |
---|
[eb03905] | 276 | following prototype: |
---|
| 277 | |
---|
| 278 | @example |
---|
| 279 | extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command; |
---|
| 280 | @end example |
---|
| 281 | |
---|
| 282 | @c |
---|
| 283 | @c |
---|
| 284 | @c |
---|
| 285 | @page |
---|
| 286 | @subsection perioduse - print or reset per period usage |
---|
| 287 | |
---|
| 288 | @pgindex perioduse |
---|
| 289 | |
---|
| 290 | @subheading SYNOPSYS: |
---|
| 291 | |
---|
[ea08043] | 292 | @example |
---|
[eb03905] | 293 | perioduse [-r] |
---|
[ea08043] | 294 | @end example |
---|
[eb03905] | 295 | |
---|
| 296 | @subheading DESCRIPTION: |
---|
| 297 | |
---|
[88d2967] | 298 | This command may be used to print a statistics report on the rate |
---|
| 299 | monotonic periods in the application or to reset the rate monotonic |
---|
| 300 | period usage statistics. When invoked with the @code{-r} option, the |
---|
| 301 | usage statistics are reset. |
---|
[eb03905] | 302 | |
---|
[ea08043] | 303 | @subheading EXIT STATUS: |
---|
| 304 | |
---|
| 305 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 306 | |
---|
[eb03905] | 307 | @subheading NOTES: |
---|
| 308 | |
---|
[88d2967] | 309 | The granularity of the timing information reported is dependent |
---|
| 310 | upon the BSP and the manner in which RTEMS was built. In the |
---|
| 311 | default RTEMS configuration, if the BSP supports nanosecond |
---|
| 312 | granularity timestamps, then the information reported will be |
---|
| 313 | highly accurate. Otherwise, the accuracy of the information |
---|
| 314 | reported is limited by the clock tick quantum. |
---|
[eb03905] | 315 | |
---|
| 316 | @subheading EXAMPLES: |
---|
| 317 | |
---|
[dc1c4308] | 318 | The following is an example of how to use @code{perioduse}: |
---|
[eb03905] | 319 | |
---|
[88d2967] | 320 | @smallexample |
---|
| 321 | SHLL [/] $ perioduse |
---|
| 322 | Period information by period |
---|
| 323 | --- CPU times are in seconds --- |
---|
| 324 | --- Wall times are in seconds --- |
---|
| 325 | ID OWNER COUNT MISSED CPU TIME WALL TIME |
---|
| 326 | MIN/MAX/AVG MIN/MAX/AVG |
---|
| 327 | 0x42010001 TA1 502 0 0:000039/0:042650/0:004158 0:000039/0:020118/0:002848 |
---|
| 328 | 0x42010002 TA2 502 0 0:000041/0:042657/0:004309 0:000041/0:020116/0:002848 |
---|
| 329 | 0x42010003 TA3 501 0 0:000041/0:041564/0:003653 0:000041/0:020003/0:002814 |
---|
| 330 | 0x42010004 TA4 501 0 0:000043/0:044075/0:004911 0:000043/0:020004/0:002814 |
---|
| 331 | 0x42010005 TA5 10 0 0:000065/0:005413/0:002739 0:000065/1:000457/0:041058 |
---|
| 332 | |
---|
| 333 | MIN/MAX/AVG MIN/MAX/AVG |
---|
| 334 | SHLL [/] $ perioduse -r |
---|
| 335 | Resetting Period Usage information |
---|
| 336 | SHLL [/] $ perioduse |
---|
| 337 | --- CPU times are in seconds --- |
---|
| 338 | --- Wall times are in seconds --- |
---|
| 339 | ID OWNER COUNT MISSED CPU TIME WALL TIME |
---|
| 340 | MIN/MAX/AVG MIN/MAX/AVG |
---|
| 341 | 0x42010001 TA1 0 0 |
---|
| 342 | 0x42010002 TA2 0 0 |
---|
| 343 | 0x42010003 TA3 0 0 |
---|
| 344 | 0x42010004 TA4 0 0 |
---|
| 345 | 0x42010005 TA5 0 0 |
---|
| 346 | @end smallexample |
---|
[eb03905] | 347 | |
---|
| 348 | @subheading CONFIGURATION: |
---|
| 349 | |
---|
| 350 | @findex CONFIGURE_SHELL_NO_COMMAND_PERIODUSE |
---|
| 351 | @findex CONFIGURE_SHELL_COMMAND_PERIODUSE |
---|
| 352 | |
---|
[b88d9ccf] | 353 | This command is included in the default shell command set. |
---|
| 354 | When building a custom command set, define |
---|
| 355 | @code{CONFIGURE_SHELL_COMMAND_PERIODUSE} to have this |
---|
| 356 | command included. |
---|
[eb03905] | 357 | |
---|
[b88d9ccf] | 358 | This command can be excluded from the shell command set by |
---|
| 359 | defining @code{CONFIGURE_SHELL_NO_COMMAND_PERIODUSE} when all |
---|
[4f973104] | 360 | shell commands have been configured. |
---|
[eb03905] | 361 | |
---|
| 362 | @subheading PROGRAMMING INFORMATION: |
---|
| 363 | |
---|
| 364 | @findex rtems_shell_rtems_main_perioduse |
---|
| 365 | |
---|
[dc1c4308] | 366 | The @code{perioduse} is implemented by a C language function |
---|
[eb03905] | 367 | which has the following prototype: |
---|
| 368 | |
---|
| 369 | @example |
---|
| 370 | int rtems_shell_rtems_main_perioduse( |
---|
| 371 | int argc, |
---|
| 372 | char **argv |
---|
| 373 | ); |
---|
| 374 | @end example |
---|
| 375 | |
---|
[dc1c4308] | 376 | The configuration structure for the @code{perioduse} has the |
---|
[eb03905] | 377 | following prototype: |
---|
| 378 | |
---|
| 379 | @example |
---|
| 380 | extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command; |
---|
| 381 | @end example |
---|
| 382 | |
---|
[2bd71d95] | 383 | @c |
---|
| 384 | @c |
---|
| 385 | @c |
---|
| 386 | @page |
---|
| 387 | @subsection profreport - print a profiling report |
---|
| 388 | |
---|
| 389 | @pgindex profreport |
---|
| 390 | |
---|
| 391 | @subheading SYNOPSYS: |
---|
| 392 | |
---|
| 393 | @example |
---|
| 394 | profreport |
---|
| 395 | @end example |
---|
| 396 | |
---|
| 397 | @subheading DESCRIPTION: |
---|
| 398 | |
---|
| 399 | This command may be used to print a profiling report. |
---|
| 400 | |
---|
| 401 | @subheading EXIT STATUS: |
---|
| 402 | |
---|
| 403 | This command returns 0. |
---|
| 404 | |
---|
| 405 | @subheading NOTES: |
---|
| 406 | |
---|
| 407 | Profiling must be enabled at build configuration time to get profiling |
---|
| 408 | information. |
---|
| 409 | |
---|
| 410 | @subheading EXAMPLES: |
---|
| 411 | |
---|
| 412 | The following is an example of how to use @code{profreport}: |
---|
| 413 | |
---|
| 414 | @smallexample |
---|
| 415 | SHLL [/] $ profreport |
---|
| 416 | <ProfilingReport name="Shell"> |
---|
| 417 | <PerCPUProfilingReport processorIndex="0"> |
---|
| 418 | <MaxThreadDispatchDisabledTime unit="ns">10447</MaxThreadDispatchDisabledTime> |
---|
| 419 | <MeanThreadDispatchDisabledTime unit="ns">2</MeanThreadDispatchDisabledTime> |
---|
| 420 | <TotalThreadDispatchDisabledTime unit="ns">195926627</TotalThreadDispatchDisabledTime> |
---|
| 421 | <ThreadDispatchDisabledCount>77908688</ThreadDispatchDisabledCount> |
---|
| 422 | <MaxInterruptDelay unit="ns">0</MaxInterruptDelay> |
---|
| 423 | <MaxInterruptTime unit="ns">688</MaxInterruptTime> |
---|
| 424 | <MeanInterruptTime unit="ns">127</MeanInterruptTime> |
---|
| 425 | <TotalInterruptTime unit="ns">282651157</TotalInterruptTime> |
---|
| 426 | <InterruptCount>2215855</InterruptCount> |
---|
| 427 | </PerCPUProfilingReport> |
---|
| 428 | <PerCPUProfilingReport processorIndex="1"> |
---|
| 429 | <MaxThreadDispatchDisabledTime unit="ns">9053</MaxThreadDispatchDisabledTime> |
---|
| 430 | <MeanThreadDispatchDisabledTime unit="ns">41</MeanThreadDispatchDisabledTime> |
---|
| 431 | <TotalThreadDispatchDisabledTime unit="ns">3053830335</TotalThreadDispatchDisabledTime> |
---|
| 432 | <ThreadDispatchDisabledCount>73334202</ThreadDispatchDisabledCount> |
---|
| 433 | <MaxInterruptDelay unit="ns">0</MaxInterruptDelay> |
---|
| 434 | <MaxInterruptTime unit="ns">57</MaxInterruptTime> |
---|
| 435 | <MeanInterruptTime unit="ns">35</MeanInterruptTime> |
---|
| 436 | <TotalInterruptTime unit="ns">76980203</TotalInterruptTime> |
---|
| 437 | <InterruptCount>2141179</InterruptCount> |
---|
| 438 | </PerCPUProfilingReport> |
---|
| 439 | <SMPLockProfilingReport name="SMP lock stats"> |
---|
| 440 | <MaxAcquireTime unit="ns">608</MaxAcquireTime> |
---|
| 441 | <MaxSectionTime unit="ns">1387</MaxSectionTime> |
---|
| 442 | <MeanAcquireTime unit="ns">112</MeanAcquireTime> |
---|
| 443 | <MeanSectionTime unit="ns">338</MeanSectionTime> |
---|
| 444 | <TotalAcquireTime unit="ns">119031</TotalAcquireTime> |
---|
| 445 | <TotalSectionTime unit="ns">357222</TotalSectionTime> |
---|
| 446 | <UsageCount>1055</UsageCount> |
---|
| 447 | <ContentionCount initialQueueLength="0">1055</ContentionCount> |
---|
| 448 | <ContentionCount initialQueueLength="1">0</ContentionCount> |
---|
| 449 | <ContentionCount initialQueueLength="2">0</ContentionCount> |
---|
| 450 | <ContentionCount initialQueueLength="3">0</ContentionCount> |
---|
| 451 | </SMPLockProfilingReport> |
---|
| 452 | <SMPLockProfilingReport name="Giant"> |
---|
| 453 | <MaxAcquireTime unit="ns">4186</MaxAcquireTime> |
---|
| 454 | <MaxSectionTime unit="ns">7575</MaxSectionTime> |
---|
| 455 | <MeanAcquireTime unit="ns">160</MeanAcquireTime> |
---|
| 456 | <MeanSectionTime unit="ns">183</MeanSectionTime> |
---|
| 457 | <TotalAcquireTime unit="ns">1772793111</TotalAcquireTime> |
---|
| 458 | <TotalSectionTime unit="ns">2029733879</TotalSectionTime> |
---|
| 459 | <UsageCount>11039140</UsageCount> |
---|
| 460 | <ContentionCount initialQueueLength="0">11037655</ContentionCount> |
---|
| 461 | <ContentionCount initialQueueLength="1">1485</ContentionCount> |
---|
| 462 | <ContentionCount initialQueueLength="2">0</ContentionCount> |
---|
| 463 | <ContentionCount initialQueueLength="3">0</ContentionCount> |
---|
| 464 | </SMPLockProfilingReport> |
---|
| 465 | </ProfilingReport> |
---|
| 466 | @end smallexample |
---|
| 467 | |
---|
| 468 | @subheading CONFIGURATION: |
---|
| 469 | |
---|
| 470 | @findex CONFIGURE_SHELL_NO_COMMAND_PROFREPORT |
---|
| 471 | @findex CONFIGURE_SHELL_COMMAND_PROFREPORT |
---|
| 472 | |
---|
| 473 | When building a custom command set, define |
---|
| 474 | @code{CONFIGURE_SHELL_COMMAND_PROFREPORT} to have this |
---|
| 475 | command included. |
---|
| 476 | |
---|
| 477 | This command can be excluded from the shell command set by |
---|
| 478 | defining @code{CONFIGURE_SHELL_NO_COMMAND_PROFREPORT} when all |
---|
| 479 | shell commands have been configured. |
---|
| 480 | |
---|
| 481 | @subheading PROGRAMMING INFORMATION: |
---|
| 482 | |
---|
| 483 | The configuration structure for the @code{profreport} has the |
---|
| 484 | following prototype: |
---|
| 485 | |
---|
| 486 | @example |
---|
| 487 | extern rtems_shell_cmd_t rtems_shell_PROFREPORT_Command; |
---|
| 488 | @end example |
---|
| 489 | |
---|
[eb03905] | 490 | @c |
---|
| 491 | @c |
---|
| 492 | @c |
---|
| 493 | @page |
---|
| 494 | @subsection wkspace - display information on executive workspace |
---|
| 495 | |
---|
| 496 | @pgindex wkspace |
---|
| 497 | |
---|
| 498 | @subheading SYNOPSYS: |
---|
| 499 | |
---|
[ea08043] | 500 | @example |
---|
[eb03905] | 501 | wkspace |
---|
[ea08043] | 502 | @end example |
---|
[eb03905] | 503 | |
---|
| 504 | @subheading DESCRIPTION: |
---|
| 505 | |
---|
[88d2967] | 506 | This command prints information on the current state of |
---|
| 507 | the RTEMS Executive Workspace reported. This includes the |
---|
| 508 | following information: |
---|
| 509 | |
---|
| 510 | @itemize @bullet |
---|
| 511 | @item Number of free blocks |
---|
| 512 | @item Largest free block |
---|
| 513 | @item Total bytes free |
---|
| 514 | @item Number of used blocks |
---|
| 515 | @item Largest used block |
---|
| 516 | @item Total bytes used |
---|
| 517 | @end itemize |
---|
[eb03905] | 518 | |
---|
[ea08043] | 519 | @subheading EXIT STATUS: |
---|
| 520 | |
---|
[88d2967] | 521 | This command always succeeds and returns 0. |
---|
[ea08043] | 522 | |
---|
[eb03905] | 523 | @subheading NOTES: |
---|
| 524 | |
---|
| 525 | NONE |
---|
| 526 | |
---|
| 527 | @subheading EXAMPLES: |
---|
| 528 | |
---|
[dc1c4308] | 529 | The following is an example of how to use @code{wkspace}: |
---|
[eb03905] | 530 | |
---|
| 531 | @example |
---|
[88d2967] | 532 | SHLL [/] $ wkspace |
---|
| 533 | Number of free blocks: 1 |
---|
| 534 | Largest free block: 132336 |
---|
| 535 | Total bytes free: 132336 |
---|
| 536 | Number of used blocks: 36 |
---|
| 537 | Largest used block: 16408 |
---|
| 538 | Total bytes used: 55344 |
---|
[eb03905] | 539 | @end example |
---|
| 540 | |
---|
| 541 | @subheading CONFIGURATION: |
---|
| 542 | |
---|
| 543 | @findex CONFIGURE_SHELL_NO_COMMAND_WKSPACE |
---|
| 544 | @findex CONFIGURE_SHELL_COMMAND_WKSPACE |
---|
| 545 | |
---|
[b88d9ccf] | 546 | This command is included in the default shell command set. |
---|
| 547 | When building a custom command set, define |
---|
| 548 | @code{CONFIGURE_SHELL_COMMAND_WKSPACE} to have this |
---|
| 549 | command included. |
---|
[eb03905] | 550 | |
---|
[b88d9ccf] | 551 | This command can be excluded from the shell command set by |
---|
| 552 | defining @code{CONFIGURE_SHELL_NO_COMMAND_WKSPACE} when all |
---|
[4f973104] | 553 | shell commands have been configured. |
---|
[eb03905] | 554 | |
---|
| 555 | @subheading PROGRAMMING INFORMATION: |
---|
| 556 | |
---|
| 557 | @findex rtems_shell_rtems_main_wkspace |
---|
| 558 | |
---|
[dc1c4308] | 559 | The @code{wkspace} is implemented by a C language function |
---|
[eb03905] | 560 | which has the following prototype: |
---|
| 561 | |
---|
| 562 | @example |
---|
| 563 | int rtems_shell_rtems_main_wkspace( |
---|
| 564 | int argc, |
---|
| 565 | char **argv |
---|
| 566 | ); |
---|
| 567 | @end example |
---|
| 568 | |
---|
[dc1c4308] | 569 | The configuration structure for the @code{wkspace} has the |
---|
[eb03905] | 570 | following prototype: |
---|
| 571 | |
---|
| 572 | @example |
---|
| 573 | extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command; |
---|
| 574 | @end example |
---|
| 575 | |
---|
| 576 | @c |
---|
| 577 | @c |
---|
| 578 | @c |
---|
| 579 | @page |
---|
| 580 | @subsection config - show the system configuration. |
---|
| 581 | |
---|
| 582 | @pgindex config |
---|
| 583 | |
---|
| 584 | @subheading SYNOPSYS: |
---|
| 585 | |
---|
[ea08043] | 586 | @example |
---|
[eb03905] | 587 | config |
---|
[ea08043] | 588 | @end example |
---|
[eb03905] | 589 | |
---|
| 590 | @subheading DESCRIPTION: |
---|
| 591 | |
---|
[88d2967] | 592 | This command display information about the RTEMS Configuration. |
---|
[eb03905] | 593 | |
---|
[ea08043] | 594 | @subheading EXIT STATUS: |
---|
| 595 | |
---|
[88d2967] | 596 | This command always succeeds and returns 0. |
---|
[ea08043] | 597 | |
---|
[eb03905] | 598 | @subheading NOTES: |
---|
| 599 | |
---|
[88d2967] | 600 | At this time, it does not report every configuration parameter. |
---|
| 601 | This is an area in which user submissions or sponsorship of |
---|
| 602 | a developer would be appreciated. |
---|
[eb03905] | 603 | |
---|
| 604 | @subheading EXAMPLES: |
---|
| 605 | |
---|
[dc1c4308] | 606 | The following is an example of how to use @code{config}: |
---|
[eb03905] | 607 | |
---|
[88d2967] | 608 | @smallexample |
---|
| 609 | INITIAL (startup) Configuration Info |
---|
| 610 | ------------------------------------------------------------------------------ |
---|
| 611 | WORKSPACE start: 0x23d22e0; size: 0x2dd20 |
---|
| 612 | TIME usec/tick: 10000; tick/timeslice: 50; tick/sec: 100 |
---|
| 613 | MAXIMUMS tasks: 20; timers: 0; sems: 50; que's: 20; ext's: 1 |
---|
| 614 | partitions: 0; regions: 0; ports: 0; periods: 0 |
---|
| 615 | @end smallexample |
---|
[eb03905] | 616 | |
---|
| 617 | @subheading CONFIGURATION: |
---|
| 618 | |
---|
| 619 | @findex CONFIGURE_SHELL_NO_COMMAND_CONFIG |
---|
| 620 | @findex CONFIGURE_SHELL_COMMAND_CONFIG |
---|
| 621 | |
---|
[b88d9ccf] | 622 | This command is included in the default shell command set. |
---|
| 623 | When building a custom command set, define |
---|
| 624 | @code{CONFIGURE_SHELL_COMMAND_CONFIG} to have this |
---|
| 625 | command included. |
---|
[eb03905] | 626 | |
---|
[b88d9ccf] | 627 | This command can be excluded from the shell command set by |
---|
| 628 | defining @code{CONFIGURE_SHELL_NO_COMMAND_CONFIG} when all |
---|
[4f973104] | 629 | shell commands have been configured. |
---|
[eb03905] | 630 | |
---|
| 631 | @subheading PROGRAMMING INFORMATION: |
---|
| 632 | |
---|
| 633 | @findex rtems_shell_rtems_main_config |
---|
| 634 | |
---|
[dc1c4308] | 635 | The @code{config} is implemented by a C language function |
---|
[eb03905] | 636 | which has the following prototype: |
---|
| 637 | |
---|
| 638 | @example |
---|
| 639 | int rtems_shell_rtems_main_config( |
---|
| 640 | int argc, |
---|
| 641 | char **argv |
---|
| 642 | ); |
---|
| 643 | @end example |
---|
| 644 | |
---|
[dc1c4308] | 645 | The configuration structure for the @code{config} has the |
---|
[eb03905] | 646 | following prototype: |
---|
| 647 | |
---|
| 648 | @example |
---|
| 649 | extern rtems_shell_cmd_t rtems_shell_CONFIG_Command; |
---|
| 650 | @end example |
---|
| 651 | |
---|
| 652 | @c |
---|
| 653 | @c |
---|
| 654 | @c |
---|
| 655 | @page |
---|
| 656 | @subsection itask - list init tasks for the system |
---|
| 657 | |
---|
| 658 | @pgindex itask |
---|
| 659 | |
---|
| 660 | @subheading SYNOPSYS: |
---|
| 661 | |
---|
[ea08043] | 662 | @example |
---|
[eb03905] | 663 | itask |
---|
[ea08043] | 664 | @end example |
---|
[eb03905] | 665 | |
---|
| 666 | @subheading DESCRIPTION: |
---|
| 667 | |
---|
[88d2967] | 668 | This command prints a report on the set of initialization |
---|
| 669 | tasks and threads in the system. |
---|
[eb03905] | 670 | |
---|
[ea08043] | 671 | @subheading EXIT STATUS: |
---|
| 672 | |
---|
[88d2967] | 673 | This command always succeeds and returns 0. |
---|
[ea08043] | 674 | |
---|
[eb03905] | 675 | @subheading NOTES: |
---|
| 676 | |
---|
[88d2967] | 677 | At this time, it includes only Classic API Initialization Tasks. |
---|
| 678 | This is an area in which user submissions or sponsorship of |
---|
| 679 | a developer would be appreciated. |
---|
[eb03905] | 680 | |
---|
| 681 | @subheading EXAMPLES: |
---|
| 682 | |
---|
[dc1c4308] | 683 | The following is an example of how to use @code{itask}: |
---|
[eb03905] | 684 | |
---|
[88d2967] | 685 | @smallexample |
---|
| 686 | SHLL [/] $ itask |
---|
| 687 | # NAME ENTRY ARGUMENT PRIO MODES ATTRIBUTES STACK SIZE |
---|
| 688 | ------------------------------------------------------------------------------ |
---|
| 689 | 0 UI1 [0x2002258] 0 [0x0] 1 nP DEFAULT 4096 [0x1000] |
---|
| 690 | @end smallexample |
---|
[eb03905] | 691 | |
---|
| 692 | @subheading CONFIGURATION: |
---|
| 693 | |
---|
| 694 | @findex CONFIGURE_SHELL_NO_COMMAND_ITASK |
---|
| 695 | @findex CONFIGURE_SHELL_COMMAND_ITASK |
---|
| 696 | |
---|
[b88d9ccf] | 697 | This command is included in the default shell command set. |
---|
| 698 | When building a custom command set, define |
---|
| 699 | @code{CONFIGURE_SHELL_COMMAND_ITASK} to have this |
---|
| 700 | command included. |
---|
[eb03905] | 701 | |
---|
[b88d9ccf] | 702 | This command can be excluded from the shell command set by |
---|
| 703 | defining @code{CONFIGURE_SHELL_NO_COMMAND_ITASK} when all |
---|
[4f973104] | 704 | shell commands have been configured. |
---|
[eb03905] | 705 | |
---|
| 706 | @subheading PROGRAMMING INFORMATION: |
---|
| 707 | |
---|
| 708 | @findex rtems_shell_rtems_main_itask |
---|
| 709 | |
---|
[dc1c4308] | 710 | The @code{itask} is implemented by a C language function |
---|
[eb03905] | 711 | which has the following prototype: |
---|
| 712 | |
---|
| 713 | @example |
---|
| 714 | int rtems_shell_rtems_main_itask( |
---|
| 715 | int argc, |
---|
| 716 | char **argv |
---|
| 717 | ); |
---|
| 718 | @end example |
---|
| 719 | |
---|
[dc1c4308] | 720 | The configuration structure for the @code{itask} has the |
---|
[eb03905] | 721 | following prototype: |
---|
| 722 | |
---|
| 723 | @example |
---|
| 724 | extern rtems_shell_cmd_t rtems_shell_ITASK_Command; |
---|
| 725 | @end example |
---|
| 726 | |
---|
| 727 | @c |
---|
| 728 | @c |
---|
| 729 | @c |
---|
| 730 | @page |
---|
| 731 | @subsection extension - display information about extensions |
---|
| 732 | |
---|
| 733 | @pgindex extension |
---|
| 734 | |
---|
| 735 | @subheading SYNOPSYS: |
---|
| 736 | |
---|
[ea08043] | 737 | @example |
---|
[eb03905] | 738 | extension [id [id ...] ] |
---|
[ea08043] | 739 | @end example |
---|
[eb03905] | 740 | |
---|
| 741 | @subheading DESCRIPTION: |
---|
| 742 | |
---|
[88d2967] | 743 | When invoked with no arguments, this command prints information on |
---|
| 744 | the set of User Extensions currently active in the system. |
---|
| 745 | |
---|
| 746 | If invoked with a set of ids as arguments, then just |
---|
| 747 | those objects are included in the information printed. |
---|
[eb03905] | 748 | |
---|
[ea08043] | 749 | @subheading EXIT STATUS: |
---|
| 750 | |
---|
| 751 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 752 | |
---|
[eb03905] | 753 | @subheading NOTES: |
---|
| 754 | |
---|
| 755 | NONE |
---|
| 756 | |
---|
| 757 | @subheading EXAMPLES: |
---|
| 758 | |
---|
[88d2967] | 759 | The following is an example of using the @code{extension} command |
---|
| 760 | on a system with no user extensions. |
---|
[eb03905] | 761 | |
---|
[88d2967] | 762 | @smallexample |
---|
| 763 | SHLL [/] $ extension |
---|
| 764 | ID NAME |
---|
| 765 | ------------------------------------------------------------------------------ |
---|
| 766 | @end smallexample |
---|
[eb03905] | 767 | |
---|
| 768 | @subheading CONFIGURATION: |
---|
| 769 | |
---|
| 770 | @findex CONFIGURE_SHELL_NO_COMMAND_EXTENSION |
---|
| 771 | @findex CONFIGURE_SHELL_COMMAND_EXTENSION |
---|
| 772 | |
---|
[b88d9ccf] | 773 | This command is included in the default shell command set. |
---|
| 774 | When building a custom command set, define |
---|
| 775 | @code{CONFIGURE_SHELL_COMMAND_EXTENSION} to have this |
---|
| 776 | command included. |
---|
[eb03905] | 777 | |
---|
[b88d9ccf] | 778 | This command can be excluded from the shell command set by |
---|
| 779 | defining @code{CONFIGURE_SHELL_NO_COMMAND_EXTENSION} when all |
---|
[4f973104] | 780 | shell commands have been configured. |
---|
[eb03905] | 781 | |
---|
| 782 | @subheading PROGRAMMING INFORMATION: |
---|
| 783 | |
---|
| 784 | @findex rtems_shell_rtems_main_extension |
---|
| 785 | |
---|
[dc1c4308] | 786 | The @code{extension} is implemented by a C language function |
---|
[eb03905] | 787 | which has the following prototype: |
---|
| 788 | |
---|
| 789 | @example |
---|
| 790 | int rtems_shell_rtems_main_extension( |
---|
| 791 | int argc, |
---|
| 792 | char **argv |
---|
| 793 | ); |
---|
| 794 | @end example |
---|
| 795 | |
---|
[dc1c4308] | 796 | The configuration structure for the @code{extension} has the |
---|
[eb03905] | 797 | following prototype: |
---|
| 798 | |
---|
| 799 | @example |
---|
| 800 | extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command; |
---|
| 801 | @end example |
---|
| 802 | |
---|
| 803 | @c |
---|
| 804 | @c |
---|
| 805 | @c |
---|
| 806 | @page |
---|
| 807 | @subsection task - display information about tasks |
---|
| 808 | |
---|
| 809 | @pgindex task |
---|
| 810 | |
---|
| 811 | @subheading SYNOPSYS: |
---|
| 812 | |
---|
[ea08043] | 813 | @example |
---|
[eb03905] | 814 | task [id [id ...] ] |
---|
[ea08043] | 815 | @end example |
---|
[eb03905] | 816 | |
---|
| 817 | @subheading DESCRIPTION: |
---|
| 818 | |
---|
[88d2967] | 819 | When invoked with no arguments, this command prints information on |
---|
| 820 | the set of Classic API Tasks currently active in the system. |
---|
| 821 | |
---|
| 822 | If invoked with a set of ids as arguments, then just |
---|
| 823 | those objects are included in the information printed. |
---|
[eb03905] | 824 | |
---|
[ea08043] | 825 | @subheading EXIT STATUS: |
---|
| 826 | |
---|
| 827 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 828 | |
---|
[eb03905] | 829 | @subheading NOTES: |
---|
| 830 | |
---|
| 831 | NONE |
---|
| 832 | |
---|
| 833 | @subheading EXAMPLES: |
---|
| 834 | |
---|
[88d2967] | 835 | The following is an example of how to use the @code{task} on an |
---|
| 836 | application with just two Classic API tasks: |
---|
[eb03905] | 837 | |
---|
[88d2967] | 838 | @smallexample |
---|
| 839 | SHLL [/] $ task |
---|
| 840 | ID NAME PRIO STAT MODES EVENTS WAITID WAITARG NOTES |
---|
| 841 | ------------------------------------------------------------------------------ |
---|
| 842 | 0a010001 UI1 1 SUSP P:T:nA NONE |
---|
| 843 | 0a010002 SHLL 100 READY P:T:nA NONE |
---|
| 844 | @end smallexample |
---|
[eb03905] | 845 | |
---|
| 846 | @subheading CONFIGURATION: |
---|
| 847 | |
---|
| 848 | @findex CONFIGURE_SHELL_NO_COMMAND_TASK |
---|
| 849 | @findex CONFIGURE_SHELL_COMMAND_TASK |
---|
| 850 | |
---|
[b88d9ccf] | 851 | This command is included in the default shell command set. |
---|
| 852 | When building a custom command set, define |
---|
| 853 | @code{CONFIGURE_SHELL_COMMAND_TASK} to have this |
---|
| 854 | command included. |
---|
[eb03905] | 855 | |
---|
[b88d9ccf] | 856 | This command can be excluded from the shell command set by |
---|
| 857 | defining @code{CONFIGURE_SHELL_NO_COMMAND_TASK} when all |
---|
[4f973104] | 858 | shell commands have been configured. |
---|
[eb03905] | 859 | |
---|
| 860 | @subheading PROGRAMMING INFORMATION: |
---|
| 861 | |
---|
| 862 | @findex rtems_shell_rtems_main_task |
---|
| 863 | |
---|
[dc1c4308] | 864 | The @code{task} is implemented by a C language function |
---|
[eb03905] | 865 | which has the following prototype: |
---|
| 866 | |
---|
| 867 | @example |
---|
| 868 | int rtems_shell_rtems_main_task( |
---|
| 869 | int argc, |
---|
| 870 | char **argv |
---|
| 871 | ); |
---|
| 872 | @end example |
---|
| 873 | |
---|
[dc1c4308] | 874 | The configuration structure for the @code{task} has the |
---|
[eb03905] | 875 | following prototype: |
---|
| 876 | |
---|
| 877 | @example |
---|
| 878 | extern rtems_shell_cmd_t rtems_shell_TASK_Command; |
---|
| 879 | @end example |
---|
| 880 | |
---|
| 881 | @c |
---|
| 882 | @c |
---|
| 883 | @c |
---|
| 884 | @page |
---|
| 885 | @subsection queue - display information about message queues |
---|
| 886 | |
---|
| 887 | @pgindex queue |
---|
| 888 | |
---|
| 889 | @subheading SYNOPSYS: |
---|
| 890 | |
---|
[ea08043] | 891 | @example |
---|
[eb03905] | 892 | queue [id [id ... ] ] |
---|
[ea08043] | 893 | @end example |
---|
[eb03905] | 894 | |
---|
| 895 | @subheading DESCRIPTION: |
---|
| 896 | |
---|
[88d2967] | 897 | When invoked with no arguments, this command prints information on |
---|
| 898 | the set of Classic API Message Queues currently active in the system. |
---|
| 899 | |
---|
| 900 | If invoked with a set of ids as arguments, then just |
---|
| 901 | those objects are included in the information printed. |
---|
[eb03905] | 902 | |
---|
[ea08043] | 903 | @subheading EXIT STATUS: |
---|
| 904 | |
---|
| 905 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 906 | |
---|
[eb03905] | 907 | @subheading NOTES: |
---|
| 908 | |
---|
| 909 | NONE |
---|
| 910 | |
---|
| 911 | @subheading EXAMPLES: |
---|
| 912 | |
---|
[88d2967] | 913 | The following is an example of using the @code{queue} command |
---|
| 914 | on a system with no Classic API Message Queues. |
---|
[eb03905] | 915 | |
---|
[88d2967] | 916 | @smallexample |
---|
| 917 | SHLL [/] $ queue |
---|
| 918 | ID NAME ATTRIBUTES PEND MAXPEND MAXSIZE |
---|
| 919 | ------------------------------------------------------------------------------ |
---|
| 920 | @end smallexample |
---|
[eb03905] | 921 | |
---|
| 922 | @subheading CONFIGURATION: |
---|
| 923 | |
---|
| 924 | @findex CONFIGURE_SHELL_NO_COMMAND_QUEUE |
---|
| 925 | @findex CONFIGURE_SHELL_COMMAND_QUEUE |
---|
| 926 | |
---|
[b88d9ccf] | 927 | This command is included in the default shell command set. |
---|
| 928 | When building a custom command set, define |
---|
| 929 | @code{CONFIGURE_SHELL_COMMAND_QUEUE} to have this |
---|
| 930 | command included. |
---|
[eb03905] | 931 | |
---|
[b88d9ccf] | 932 | This command can be excluded from the shell command set by |
---|
| 933 | defining @code{CONFIGURE_SHELL_NO_COMMAND_QUEUE} when all |
---|
[4f973104] | 934 | shell commands have been configured. |
---|
[eb03905] | 935 | |
---|
| 936 | @subheading PROGRAMMING INFORMATION: |
---|
| 937 | |
---|
| 938 | @findex rtems_shell_rtems_main_queue |
---|
| 939 | |
---|
[dc1c4308] | 940 | The @code{queue} is implemented by a C language function |
---|
[eb03905] | 941 | which has the following prototype: |
---|
| 942 | |
---|
| 943 | @example |
---|
| 944 | int rtems_shell_rtems_main_queue( |
---|
| 945 | int argc, |
---|
| 946 | char **argv |
---|
| 947 | ); |
---|
| 948 | @end example |
---|
| 949 | |
---|
[dc1c4308] | 950 | The configuration structure for the @code{queue} has the |
---|
[eb03905] | 951 | following prototype: |
---|
| 952 | |
---|
| 953 | @example |
---|
| 954 | extern rtems_shell_cmd_t rtems_shell_QUEUE_Command; |
---|
| 955 | @end example |
---|
| 956 | |
---|
| 957 | @c |
---|
| 958 | @c |
---|
| 959 | @c |
---|
| 960 | @page |
---|
| 961 | @subsection sema - display information about semaphores |
---|
| 962 | |
---|
| 963 | @pgindex sema |
---|
| 964 | |
---|
| 965 | @subheading SYNOPSYS: |
---|
| 966 | |
---|
[ea08043] | 967 | @example |
---|
[eb03905] | 968 | sema [id [id ... ] ] |
---|
[ea08043] | 969 | @end example |
---|
[eb03905] | 970 | |
---|
| 971 | @subheading DESCRIPTION: |
---|
| 972 | |
---|
[88d2967] | 973 | When invoked with no arguments, this command prints information on |
---|
| 974 | the set of Classic API Semaphores currently active in the system. |
---|
| 975 | |
---|
| 976 | If invoked with a set of objects ids as arguments, then just |
---|
| 977 | those objects are included in the information printed. |
---|
[eb03905] | 978 | |
---|
[ea08043] | 979 | @subheading EXIT STATUS: |
---|
| 980 | |
---|
| 981 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 982 | |
---|
[eb03905] | 983 | @subheading NOTES: |
---|
| 984 | |
---|
| 985 | NONE |
---|
| 986 | |
---|
| 987 | @subheading EXAMPLES: |
---|
| 988 | |
---|
[dc1c4308] | 989 | The following is an example of how to use @code{sema}: |
---|
[eb03905] | 990 | |
---|
[88d2967] | 991 | @smallexample |
---|
| 992 | SHLL [/] $ sema |
---|
| 993 | ID NAME ATTR PRICEIL CURR_CNT HOLDID |
---|
| 994 | ------------------------------------------------------------------------------ |
---|
| 995 | 1a010001 LBIO PR:BI:IN 0 1 00000000 |
---|
| 996 | 1a010002 TRmi PR:BI:IN 0 1 00000000 |
---|
| 997 | 1a010003 LBI00 PR:BI:IN 0 1 00000000 |
---|
| 998 | 1a010004 TRia PR:BI:IN 0 1 00000000 |
---|
| 999 | 1a010005 TRoa PR:BI:IN 0 1 00000000 |
---|
| 1000 | 1a010006 TRxa <assoc.c: BAD NAME> 0 0 09010001 |
---|
| 1001 | 1a010007 LBI01 PR:BI:IN 0 1 00000000 |
---|
| 1002 | 1a010008 LBI02 PR:BI:IN 0 1 00000000 |
---|
| 1003 | @end smallexample |
---|
[eb03905] | 1004 | |
---|
| 1005 | @subheading CONFIGURATION: |
---|
| 1006 | |
---|
| 1007 | @findex CONFIGURE_SHELL_NO_COMMAND_SEMA |
---|
| 1008 | @findex CONFIGURE_SHELL_COMMAND_SEMA |
---|
| 1009 | |
---|
[b88d9ccf] | 1010 | This command is included in the default shell command set. |
---|
| 1011 | When building a custom command set, define |
---|
| 1012 | @code{CONFIGURE_SHELL_COMMAND_SEMA} to have this |
---|
| 1013 | command included. |
---|
[eb03905] | 1014 | |
---|
[b88d9ccf] | 1015 | This command can be excluded from the shell command set by |
---|
| 1016 | defining @code{CONFIGURE_SHELL_NO_COMMAND_SEMA} when all |
---|
[4f973104] | 1017 | shell commands have been configured. |
---|
[eb03905] | 1018 | |
---|
| 1019 | @subheading PROGRAMMING INFORMATION: |
---|
| 1020 | |
---|
| 1021 | @findex rtems_shell_rtems_main_sema |
---|
| 1022 | |
---|
[dc1c4308] | 1023 | The @code{sema} is implemented by a C language function |
---|
[eb03905] | 1024 | which has the following prototype: |
---|
| 1025 | |
---|
| 1026 | @example |
---|
| 1027 | int rtems_shell_rtems_main_sema( |
---|
| 1028 | int argc, |
---|
| 1029 | char **argv |
---|
| 1030 | ); |
---|
| 1031 | @end example |
---|
| 1032 | |
---|
[dc1c4308] | 1033 | The configuration structure for the @code{sema} has the |
---|
[eb03905] | 1034 | following prototype: |
---|
| 1035 | |
---|
| 1036 | @example |
---|
| 1037 | extern rtems_shell_cmd_t rtems_shell_SEMA_Command; |
---|
| 1038 | @end example |
---|
| 1039 | |
---|
| 1040 | @c |
---|
| 1041 | @c |
---|
| 1042 | @c |
---|
| 1043 | @page |
---|
| 1044 | @subsection region - display information about regions |
---|
| 1045 | |
---|
| 1046 | @pgindex region |
---|
| 1047 | |
---|
| 1048 | @subheading SYNOPSYS: |
---|
| 1049 | |
---|
[ea08043] | 1050 | @example |
---|
[eb03905] | 1051 | region [id [id ... ] ] |
---|
[ea08043] | 1052 | @end example |
---|
[eb03905] | 1053 | |
---|
| 1054 | @subheading DESCRIPTION: |
---|
| 1055 | |
---|
[88d2967] | 1056 | When invoked with no arguments, this command prints information on |
---|
| 1057 | the set of Classic API Regions currently active in the system. |
---|
| 1058 | |
---|
| 1059 | If invoked with a set of object ids as arguments, then just |
---|
| 1060 | those object are included in the information printed. |
---|
[eb03905] | 1061 | |
---|
[ea08043] | 1062 | @subheading EXIT STATUS: |
---|
| 1063 | |
---|
| 1064 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 1065 | |
---|
[eb03905] | 1066 | @subheading NOTES: |
---|
| 1067 | |
---|
| 1068 | NONE |
---|
| 1069 | |
---|
| 1070 | @subheading EXAMPLES: |
---|
| 1071 | |
---|
[88d2967] | 1072 | The following is an example of using the @code{region} command |
---|
| 1073 | on a system with no user extensions. |
---|
[eb03905] | 1074 | |
---|
[88d2967] | 1075 | @smallexample |
---|
| 1076 | SHLL [/] $ region |
---|
| 1077 | ID NAME ATTR STARTADDR LENGTH PAGE_SIZE USED_BLOCKS |
---|
| 1078 | ------------------------------------------------------------------------------ |
---|
| 1079 | @end smallexample |
---|
[eb03905] | 1080 | |
---|
| 1081 | @subheading CONFIGURATION: |
---|
| 1082 | |
---|
| 1083 | @findex CONFIGURE_SHELL_NO_COMMAND_REGION |
---|
| 1084 | @findex CONFIGURE_SHELL_COMMAND_REGION |
---|
| 1085 | |
---|
[b88d9ccf] | 1086 | This command is included in the default shell command set. |
---|
| 1087 | When building a custom command set, define |
---|
| 1088 | @code{CONFIGURE_SHELL_COMMAND_REGION} to have this |
---|
| 1089 | command included. |
---|
[eb03905] | 1090 | |
---|
[b88d9ccf] | 1091 | This command can be excluded from the shell command set by |
---|
| 1092 | defining @code{CONFIGURE_SHELL_NO_COMMAND_REGION} when all |
---|
[4f973104] | 1093 | shell commands have been configured. |
---|
[eb03905] | 1094 | |
---|
| 1095 | @subheading PROGRAMMING INFORMATION: |
---|
| 1096 | |
---|
| 1097 | @findex rtems_shell_rtems_main_region |
---|
| 1098 | |
---|
[dc1c4308] | 1099 | The @code{region} is implemented by a C language function |
---|
[eb03905] | 1100 | which has the following prototype: |
---|
| 1101 | |
---|
| 1102 | @example |
---|
| 1103 | int rtems_shell_rtems_main_region( |
---|
| 1104 | int argc, |
---|
| 1105 | char **argv |
---|
| 1106 | ); |
---|
| 1107 | @end example |
---|
| 1108 | |
---|
[dc1c4308] | 1109 | The configuration structure for the @code{region} has the |
---|
[eb03905] | 1110 | following prototype: |
---|
| 1111 | |
---|
| 1112 | @example |
---|
| 1113 | extern rtems_shell_cmd_t rtems_shell_REGION_Command; |
---|
| 1114 | @end example |
---|
| 1115 | |
---|
| 1116 | @c |
---|
| 1117 | @c |
---|
| 1118 | @c |
---|
| 1119 | @page |
---|
| 1120 | @subsection part - display information about partitions |
---|
| 1121 | |
---|
| 1122 | @pgindex part |
---|
| 1123 | |
---|
| 1124 | @subheading SYNOPSYS: |
---|
| 1125 | |
---|
[ea08043] | 1126 | @example |
---|
[eb03905] | 1127 | part [id [id ... ] ] |
---|
[ea08043] | 1128 | @end example |
---|
[eb03905] | 1129 | |
---|
| 1130 | @subheading DESCRIPTION: |
---|
| 1131 | |
---|
[88d2967] | 1132 | When invoked with no arguments, this command prints information on |
---|
| 1133 | the set of Classic API Partitions currently active in the system. |
---|
| 1134 | |
---|
| 1135 | If invoked with a set of object ids as arguments, then just |
---|
| 1136 | those objects are included in the information printed. |
---|
[eb03905] | 1137 | |
---|
[ea08043] | 1138 | @subheading EXIT STATUS: |
---|
| 1139 | |
---|
| 1140 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 1141 | |
---|
[eb03905] | 1142 | @subheading NOTES: |
---|
| 1143 | |
---|
| 1144 | NONE |
---|
| 1145 | |
---|
| 1146 | @subheading EXAMPLES: |
---|
| 1147 | |
---|
[88d2967] | 1148 | The following is an example of using the @code{part} command |
---|
| 1149 | on a system with no user extensions. |
---|
[eb03905] | 1150 | |
---|
[88d2967] | 1151 | @smallexample |
---|
| 1152 | SHLL [/] $ part |
---|
| 1153 | ID NAME ATTR STARTADDR LENGTH BUF_SIZE USED_BLOCKS |
---|
| 1154 | ------------------------------------------------------------------------------ |
---|
| 1155 | @end smallexample |
---|
[eb03905] | 1156 | |
---|
| 1157 | @subheading CONFIGURATION: |
---|
| 1158 | |
---|
| 1159 | @findex CONFIGURE_SHELL_NO_COMMAND_PART |
---|
| 1160 | @findex CONFIGURE_SHELL_COMMAND_PART |
---|
| 1161 | |
---|
[b88d9ccf] | 1162 | This command is included in the default shell command set. |
---|
| 1163 | When building a custom command set, define |
---|
| 1164 | @code{CONFIGURE_SHELL_COMMAND_PART} to have this |
---|
| 1165 | command included. |
---|
[eb03905] | 1166 | |
---|
[b88d9ccf] | 1167 | This command can be excluded from the shell command set by |
---|
| 1168 | defining @code{CONFIGURE_SHELL_NO_COMMAND_PART} when all |
---|
[4f973104] | 1169 | shell commands have been configured. |
---|
[eb03905] | 1170 | |
---|
| 1171 | @subheading PROGRAMMING INFORMATION: |
---|
| 1172 | |
---|
| 1173 | @findex rtems_shell_rtems_main_part |
---|
| 1174 | |
---|
[dc1c4308] | 1175 | The @code{part} is implemented by a C language function |
---|
[eb03905] | 1176 | which has the following prototype: |
---|
| 1177 | |
---|
| 1178 | @example |
---|
| 1179 | int rtems_shell_rtems_main_part( |
---|
| 1180 | int argc, |
---|
| 1181 | char **argv |
---|
| 1182 | ); |
---|
| 1183 | @end example |
---|
| 1184 | |
---|
[dc1c4308] | 1185 | The configuration structure for the @code{part} has the |
---|
[eb03905] | 1186 | following prototype: |
---|
| 1187 | |
---|
| 1188 | @example |
---|
| 1189 | extern rtems_shell_cmd_t rtems_shell_PART_Command; |
---|
| 1190 | @end example |
---|
| 1191 | |
---|
| 1192 | @c |
---|
| 1193 | @c |
---|
| 1194 | @c |
---|
| 1195 | @page |
---|
| 1196 | @subsection object - display information about rtems objects |
---|
| 1197 | |
---|
| 1198 | @pgindex object |
---|
| 1199 | |
---|
| 1200 | @subheading SYNOPSYS: |
---|
| 1201 | |
---|
[ea08043] | 1202 | @example |
---|
[eb03905] | 1203 | object [id [id ...] ] |
---|
[ea08043] | 1204 | @end example |
---|
[eb03905] | 1205 | |
---|
| 1206 | @subheading DESCRIPTION: |
---|
| 1207 | |
---|
[88d2967] | 1208 | When invoked with a set of object ids as arguments, then |
---|
| 1209 | a report on those objects is printed. |
---|
[eb03905] | 1210 | |
---|
[ea08043] | 1211 | @subheading EXIT STATUS: |
---|
| 1212 | |
---|
| 1213 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 1214 | |
---|
[eb03905] | 1215 | @subheading NOTES: |
---|
| 1216 | |
---|
| 1217 | NONE |
---|
| 1218 | |
---|
| 1219 | @subheading EXAMPLES: |
---|
| 1220 | |
---|
[dc1c4308] | 1221 | The following is an example of how to use @code{object}: |
---|
[eb03905] | 1222 | |
---|
[88d2967] | 1223 | @smallexample |
---|
| 1224 | SHLL [/] $ object 0a010001 1a010002 |
---|
| 1225 | ID NAME PRIO STAT MODES EVENTS WAITID WAITARG NOTES |
---|
| 1226 | ------------------------------------------------------------------------------ |
---|
| 1227 | 0a010001 UI1 1 SUSP P:T:nA NONE |
---|
| 1228 | ID NAME ATTR PRICEIL CURR_CNT HOLDID |
---|
| 1229 | ------------------------------------------------------------------------------ |
---|
| 1230 | 1a010002 TRmi PR:BI:IN 0 1 00000000 |
---|
| 1231 | @end smallexample |
---|
[eb03905] | 1232 | |
---|
| 1233 | @subheading CONFIGURATION: |
---|
| 1234 | |
---|
| 1235 | @findex CONFIGURE_SHELL_NO_COMMAND_OBJECT |
---|
| 1236 | @findex CONFIGURE_SHELL_COMMAND_OBJECT |
---|
| 1237 | |
---|
[b88d9ccf] | 1238 | This command is included in the default shell command set. |
---|
| 1239 | When building a custom command set, define |
---|
| 1240 | @code{CONFIGURE_SHELL_COMMAND_OBJECT} to have this |
---|
| 1241 | command included. |
---|
[eb03905] | 1242 | |
---|
[b88d9ccf] | 1243 | This command can be excluded from the shell command set by |
---|
| 1244 | defining @code{CONFIGURE_SHELL_NO_COMMAND_OBJECT} when all |
---|
[4f973104] | 1245 | shell commands have been configured. |
---|
[eb03905] | 1246 | |
---|
| 1247 | @subheading PROGRAMMING INFORMATION: |
---|
| 1248 | |
---|
| 1249 | @findex rtems_shell_rtems_main_object |
---|
| 1250 | |
---|
[dc1c4308] | 1251 | The @code{object} is implemented by a C language function |
---|
[eb03905] | 1252 | which has the following prototype: |
---|
| 1253 | |
---|
| 1254 | @example |
---|
| 1255 | int rtems_shell_rtems_main_object( |
---|
| 1256 | int argc, |
---|
| 1257 | char **argv |
---|
| 1258 | ); |
---|
| 1259 | @end example |
---|
| 1260 | |
---|
[dc1c4308] | 1261 | The configuration structure for the @code{object} has the |
---|
[eb03905] | 1262 | following prototype: |
---|
| 1263 | |
---|
| 1264 | @example |
---|
| 1265 | extern rtems_shell_cmd_t rtems_shell_OBJECT_Command; |
---|
| 1266 | @end example |
---|
| 1267 | |
---|
| 1268 | @c |
---|
| 1269 | @c |
---|
| 1270 | @c |
---|
| 1271 | @page |
---|
| 1272 | @subsection driver - display the rtems device driver table |
---|
| 1273 | |
---|
| 1274 | @pgindex driver |
---|
| 1275 | |
---|
| 1276 | @subheading SYNOPSYS: |
---|
| 1277 | |
---|
[ea08043] | 1278 | @example |
---|
[eb03905] | 1279 | driver [ major [ major ... ] ] |
---|
[ea08043] | 1280 | @end example |
---|
[eb03905] | 1281 | |
---|
| 1282 | @subheading DESCRIPTION: |
---|
| 1283 | |
---|
[88d2967] | 1284 | When invoked with no arguments, this command prints information on |
---|
| 1285 | the set of Device Drivers currently active in the system. |
---|
| 1286 | |
---|
| 1287 | If invoked with a set of major numbers as arguments, then just |
---|
| 1288 | those Device Drivers are included in the information printed. |
---|
[eb03905] | 1289 | |
---|
[ea08043] | 1290 | @subheading EXIT STATUS: |
---|
| 1291 | |
---|
| 1292 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 1293 | |
---|
[eb03905] | 1294 | @subheading NOTES: |
---|
| 1295 | |
---|
| 1296 | NONE |
---|
| 1297 | |
---|
| 1298 | @subheading EXAMPLES: |
---|
| 1299 | |
---|
[dc1c4308] | 1300 | The following is an example of how to use @code{driver}: |
---|
[eb03905] | 1301 | |
---|
[88d2967] | 1302 | @smallexample |
---|
| 1303 | SHLL [/] $ driver |
---|
| 1304 | Major Entry points |
---|
| 1305 | ------------------------------------------------------------------------------ |
---|
| 1306 | 0 init: [0x200256c]; control: [0x20024c8] |
---|
| 1307 | open: [0x2002518]; close: [0x2002504] |
---|
| 1308 | read: [0x20024f0]; write: [0x20024dc] |
---|
| 1309 | 1 init: [0x20023fc]; control: [0x2002448] |
---|
| 1310 | open: [0x0]; close: [0x0] |
---|
| 1311 | read: [0x0]; write: [0x0] |
---|
| 1312 | SHLL [/] $ |
---|
| 1313 | @end smallexample |
---|
[eb03905] | 1314 | |
---|
| 1315 | @subheading CONFIGURATION: |
---|
| 1316 | |
---|
| 1317 | @findex CONFIGURE_SHELL_NO_COMMAND_DRIVER |
---|
| 1318 | @findex CONFIGURE_SHELL_COMMAND_DRIVER |
---|
| 1319 | |
---|
[b88d9ccf] | 1320 | This command is included in the default shell command set. |
---|
| 1321 | When building a custom command set, define |
---|
| 1322 | @code{CONFIGURE_SHELL_COMMAND_DRIVER} to have this |
---|
| 1323 | command included. |
---|
[eb03905] | 1324 | |
---|
[b88d9ccf] | 1325 | This command can be excluded from the shell command set by |
---|
| 1326 | defining @code{CONFIGURE_SHELL_NO_COMMAND_DRIVER} when all |
---|
[4f973104] | 1327 | shell commands have been configured. |
---|
[eb03905] | 1328 | |
---|
| 1329 | @subheading PROGRAMMING INFORMATION: |
---|
| 1330 | |
---|
| 1331 | @findex rtems_shell_rtems_main_driver |
---|
| 1332 | |
---|
[dc1c4308] | 1333 | The @code{driver} is implemented by a C language function |
---|
[eb03905] | 1334 | which has the following prototype: |
---|
| 1335 | |
---|
| 1336 | @example |
---|
| 1337 | int rtems_shell_rtems_main_driver( |
---|
| 1338 | int argc, |
---|
| 1339 | char **argv |
---|
| 1340 | ); |
---|
| 1341 | @end example |
---|
| 1342 | |
---|
[dc1c4308] | 1343 | The configuration structure for the @code{driver} has the |
---|
[eb03905] | 1344 | following prototype: |
---|
| 1345 | |
---|
| 1346 | @example |
---|
| 1347 | extern rtems_shell_cmd_t rtems_shell_DRIVER_Command; |
---|
| 1348 | @end example |
---|
| 1349 | |
---|
| 1350 | @c |
---|
| 1351 | @c |
---|
| 1352 | @c |
---|
| 1353 | @page |
---|
| 1354 | @subsection dname - displays information about named drivers |
---|
| 1355 | |
---|
| 1356 | @pgindex dname |
---|
| 1357 | |
---|
| 1358 | @subheading SYNOPSYS: |
---|
| 1359 | |
---|
[ea08043] | 1360 | @example |
---|
[eb03905] | 1361 | dname |
---|
[ea08043] | 1362 | @end example |
---|
[eb03905] | 1363 | |
---|
| 1364 | @subheading DESCRIPTION: |
---|
| 1365 | |
---|
| 1366 | This command XXX |
---|
| 1367 | |
---|
[88d2967] | 1368 | WARNING! XXX This command does not appear to work as of 27 February 2008. |
---|
| 1369 | |
---|
[ea08043] | 1370 | @subheading EXIT STATUS: |
---|
| 1371 | |
---|
| 1372 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 1373 | |
---|
[eb03905] | 1374 | @subheading NOTES: |
---|
| 1375 | |
---|
| 1376 | NONE |
---|
| 1377 | |
---|
| 1378 | @subheading EXAMPLES: |
---|
| 1379 | |
---|
[dc1c4308] | 1380 | The following is an example of how to use @code{dname}: |
---|
[eb03905] | 1381 | |
---|
| 1382 | @example |
---|
| 1383 | EXAMPLE_TBD |
---|
| 1384 | @end example |
---|
| 1385 | |
---|
| 1386 | @subheading CONFIGURATION: |
---|
| 1387 | |
---|
| 1388 | @findex CONFIGURE_SHELL_NO_COMMAND_DNAME |
---|
| 1389 | @findex CONFIGURE_SHELL_COMMAND_DNAME |
---|
| 1390 | |
---|
[b88d9ccf] | 1391 | This command is included in the default shell command set. |
---|
| 1392 | When building a custom command set, define |
---|
| 1393 | @code{CONFIGURE_SHELL_COMMAND_DNAME} to have this |
---|
| 1394 | command included. |
---|
[eb03905] | 1395 | |
---|
[b88d9ccf] | 1396 | This command can be excluded from the shell command set by |
---|
| 1397 | defining @code{CONFIGURE_SHELL_NO_COMMAND_DNAME} when all |
---|
[4f973104] | 1398 | shell commands have been configured. |
---|
[eb03905] | 1399 | |
---|
| 1400 | @subheading PROGRAMMING INFORMATION: |
---|
| 1401 | |
---|
| 1402 | @findex rtems_shell_rtems_main_dname |
---|
| 1403 | |
---|
[dc1c4308] | 1404 | The @code{dname} is implemented by a C language function |
---|
[eb03905] | 1405 | which has the following prototype: |
---|
| 1406 | |
---|
| 1407 | @example |
---|
| 1408 | int rtems_shell_rtems_main_dname( |
---|
| 1409 | int argc, |
---|
| 1410 | char **argv |
---|
| 1411 | ); |
---|
| 1412 | @end example |
---|
| 1413 | |
---|
[dc1c4308] | 1414 | The configuration structure for the @code{dname} has the |
---|
[eb03905] | 1415 | following prototype: |
---|
| 1416 | |
---|
| 1417 | @example |
---|
| 1418 | extern rtems_shell_cmd_t rtems_shell_DNAME_Command; |
---|
| 1419 | @end example |
---|
| 1420 | |
---|
[75d16dd8] | 1421 | @c |
---|
| 1422 | @c |
---|
| 1423 | @c |
---|
| 1424 | @page |
---|
| 1425 | @subsection pthread - display information about POSIX threads |
---|
| 1426 | |
---|
| 1427 | @pgindex pthread |
---|
| 1428 | |
---|
| 1429 | @subheading SYNOPSYS: |
---|
| 1430 | |
---|
| 1431 | @example |
---|
| 1432 | pthread [id [id ...] ] |
---|
| 1433 | @end example |
---|
| 1434 | |
---|
| 1435 | @subheading DESCRIPTION: |
---|
| 1436 | |
---|
| 1437 | When invoked with no arguments, this command prints information on |
---|
| 1438 | the set of POSIX API threads currently active in the system. |
---|
| 1439 | |
---|
| 1440 | If invoked with a set of ids as arguments, then just |
---|
| 1441 | those objects are included in the information printed. |
---|
| 1442 | |
---|
| 1443 | @subheading EXIT STATUS: |
---|
| 1444 | |
---|
| 1445 | This command returns 0 on success and non-zero if an error is encountered. |
---|
| 1446 | |
---|
| 1447 | @subheading NOTES: |
---|
| 1448 | |
---|
| 1449 | This command is only available when the POSIX API is configured. |
---|
| 1450 | |
---|
| 1451 | @subheading EXAMPLES: |
---|
| 1452 | |
---|
| 1453 | The following is an example of how to use the @code{task} on an |
---|
| 1454 | application with four POSIX threads: |
---|
| 1455 | |
---|
| 1456 | @smallexample |
---|
| 1457 | SHLL [/] $ pthread |
---|
| 1458 | ID NAME PRI STATE MODES EVENTS WAITID WAITARG NOTES |
---|
| 1459 | ------------------------------------------------------------------------------ |
---|
| 1460 | 0b010002 Main 133 READY P:T:nA NONE 43010001 0x7b1148 |
---|
| 1461 | 0b010003 ISR 133 Wcvar P:T:nA NONE 43010003 0x7b1148 |
---|
| 1462 | 0b01000c 133 READY P:T:nA NONE 33010002 0x7b1148 |
---|
| 1463 | 0b01000d 133 Wmutex P:T:nA NONE 33010002 0x7b1148 |
---|
| 1464 | |
---|
| 1465 | @end smallexample |
---|
| 1466 | |
---|
| 1467 | @subheading CONFIGURATION: |
---|
| 1468 | |
---|
| 1469 | This command is part of the monitor commands which are always |
---|
| 1470 | available in the shell. |
---|
| 1471 | |
---|
| 1472 | @subheading PROGRAMMING INFORMATION: |
---|
| 1473 | |
---|
| 1474 | This command is not directly available for invocation. |
---|
| 1475 | |
---|