usrlib.html

Vxworks API操作系统和驱动程序设计API。压缩的HTML文件

<dt>
EOF
<dd>
Do not change this register, and quit.
</dl>

<p>
All numbers are entered and displayed in hexadecimal, except
floating-point values, which may be entered in double precision.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, or ERROR if the task or register does not exist.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./usrLib.html#m">m</a>(&nbsp;)</b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>
<b><a href="../../tornado/tools/windsh.html#top" >windsh</a></b>,  
<i>Tornado User's Guide: Shell</i>

<hr>
<a name="pc"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>pc(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>pc(&nbsp;)</strong> - return the contents of the program counter</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>int pc
    (
    int task                  /* task ID */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This command extracts the contents of the program counter for a specified
task from the task's TCB.  If <i>task</i> is omitted or 0, 
the current task is used.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
The contents of the program counter.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./usrLib.html#ti">ti</a>(&nbsp;)</b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>

<hr>
<a name="printErrno"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>printErrno(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>printErrno(&nbsp;)</strong> - print the definition of a specified error status value</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void printErrno
    (
    int errNo                 /* status code whose name is to be printed */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This command displays the error-status string, corresponding to a
specified error-status value.  It is only useful if the error-status
symbol table has been built and included in the system.  If <i>errNo</i> is
zero, then the current task status is used by calling <b><a href="./errnoLib.html#errnoGet">errnoGet</a>(&nbsp;)</b>.
<p>
This facility is described in <b><a href="./errnoLib.html#top">errnoLib</a></b>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./errnoLib.html#top">errnoLib</a></b>, <b><a href="./errnoLib.html#errnoGet">errnoGet</a>(&nbsp;)</b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>
<b><a href="../../tornado/tools/windsh.html#top" >windsh</a></b>,  
<i>Tornado User's Guide: Shell</i>

<hr>
<a name="printLogo"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>printLogo(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>printLogo(&nbsp;)</strong> - print the VxWorks logo</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void printLogo (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This command displays the VxWorks banner seen at boot time.  It also
displays the VxWorks version number and kernel version number.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <i>VxWorks Programmer's Guide: Target Shell,  </i>
<b><a href="../../tornado/tools/windsh.html#top" >windsh</a></b>,  
<i>Tornado User's Guide: Shell</i>

<hr>
<a name="logout"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>logout(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>logout(&nbsp;)</strong> - log out of the VxWorks system</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void logout (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This command logs out of the VxWorks shell.  If a remote login is active
(via <b><a href="../../bspkit/valTest/rlogin.html#top" >rlogin</a></b> or <b>telnet</b>), it is stopped, and standard I/O is restored to
the console.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./rlogLib.html#rlogin">rlogin</a>(&nbsp;)</b>, <b>telnet(&nbsp;)</b>, <b>shellLogout(&nbsp;)</b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>

<hr>
<a name="h"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>h(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>h(&nbsp;)</strong> - display or set the size of shell history</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void h
    (
    int size                  /* 0 = display, >0 = set history to new size */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This command displays or sets the size of VxWorks shell history.  If no
argument is specified, shell history is displayed.  If <i>size</i> is
specified, that number of the most recent commands is saved for display.
The value of <i>size</i> is initially 20.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./shellLib.html#shellHistory">shellHistory</a>(&nbsp;)</b>, <b><a href="./ledLib.html#top">ledLib</a></b>,  
<i>VxWorks Programmer's Guide: Target Shell,  </i>
<b><a href="../../tornado/tools/windsh.html#top" >windsh</a></b>,  
<i>Tornado User's Guide: Shell</i>

<hr>
<a name="spyReport"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>spyReport(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>spyReport(&nbsp;)</strong> - display task activity data</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void spyReport (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine reports on data gathered at interrupt level for the amount of
CPU time utilized by each task, the amount of time spent at interrupt level,
the amount of time spent in the kernel, and the amount of idle time.  Time
is displayed in ticks and as a percentage, and the data is shown since both
the last call to <b><a href="./usrLib.html#spyClkStart">spyClkStart</a>(&nbsp;)</b> and the last <b><a href="./usrLib.html#spyReport">spyReport</a>(&nbsp;)</b>.  If no interrupts
have occurred since the last <b><a href="./usrLib.html#spyReport">spyReport</a>(&nbsp;)</b>, nothing is displayed.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./spyLib.html#top">spyLib</a></b>, <b><a href="./usrLib.html#spyClkStart">spyClkStart</a>(&nbsp;)</b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>

<hr>
<a name="spyTask"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>spyTask(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>spyTask(&nbsp;)</strong> - run periodic task activity reports</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void spyTask
    (
    int freq                  /* reporting frequency, in seconds */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine is spawned as a task by <b><a href="./usrLib.html#spy">spy</a>(&nbsp;)</b> to provide periodic task
activity reports.  It prints a report, delays for the specified number of
seconds, and repeats.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./spyLib.html#top">spyLib</a></b>, <b><a href="./usrLib.html#spy">spy</a>(&nbsp;)</b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>

<hr>
<a name="spy"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>spy(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>spy(&nbsp;)</strong> - begin periodic task activity reports</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void spy
    (
    int freq,                 /* reporting freq in sec, 0 = default of 5 */
    int ticksPerSec           /* interrupt clock freq, 0 = default of 100 */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine collects task activity data and periodically runs <b><a href="./usrLib.html#spyReport">spyReport</a>(&nbsp;)</b>.
Data is gathered <i>ticksPerSec</i> times per second, and a report is made every
<i>freq</i> seconds.  If <i>freq</i> is zero, it defaults to 5 seconds.  If
<i>ticksPerSec</i> is omitted or zero, it defaults to 100.
<p>
This routine spawns <b><a href="./usrLib.html#spyTask">spyTask</a>(&nbsp;)</b> to do the actual reporting.
<p>
It is not necessary to call <b><a href="./usrLib.html#spyClkStart">spyClkStart</a>(&nbsp;)</b> before running <b><a href="./usrLib.html#spy">spy</a>(&nbsp;)</b>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./spyLib.html#top">spyLib</a></b>, <b><a href="./usrLib.html#spyClkStart">spyClkStart</a>(&nbsp;)</b>, <b><a href="./usrLib.html#spyTask">spyTask</a>(&nbsp;)</b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>

<hr>
<a name="spyClkStart"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>spyClkStart(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>spyClkStart(&nbsp;)</strong> - start collecting task activity data</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS spyClkStart
    (
    int intsPerSec            /* timer interrupt freq, 0 = default of 100 */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine begins data collection by enabling the auxiliary clock
interrupts at a frequency of <i>intsPerSec</i> interrupts per second.  If
<i>intsPerSec</i> is omitted or zero, the frequency will be 100.  Data from
previous collections is cleared.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
<p>
OK, or ERROR if the CPU has no auxiliary clock, or if task create and
delete hooks cannot be installed.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./spyLib.html#top">spyLib</a></b>, <b><a href="./sysLib.html#sysAuxClkConnect">sysAuxClkConnect</a>(&nbsp;)</b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>

<hr>
<a name="spyClkStop"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>spyClkStop(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>spyClkStop(&nbsp;)</strong> - stop collecting task activity data</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void spyClkStop (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine disables the auxiliary clock interrupts.
Data collected remains valid until the next <b><a href="./usrLib.html#spyClkStart">spyClkStart</a>(&nbsp;)</b> call.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./spyLib.html#top">spyLib</a></b>, <b><a href="./usrLib.html#spyClkStart">spyClkStart</a>(&nbsp;)</b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>

<hr>
<a name="spyStop"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>spyStop(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>spyStop(&nbsp;)</strong> - stop spying and reporting</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void spyStop (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine calls <b><a href="./usrLib.html#spyClkStop">spyClkStop</a>(&nbsp;)</b>.  Any periodic reporting by <b><a href="./usrLib.html#spyTask">spyTask</a>(&nbsp;)</b>
is terminated.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./spyLib.html#top">spyLib</a></b>, <b><a href="./usrLib.html#spyClkStop">spyClkStop</a>(&nbsp;)</b>, <b><a href="./usrLib.html#spyTask">spyTask</a>(&nbsp;)</b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>

<hr>
<a name="spyHelp"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>spyHelp(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>spyHelp(&nbsp;)</strong> - display task monitoring help menu</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void spyHelp (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine displays a summary of <b><a href="./spyLib.html#top">spyLib</a></b> utilities:
<pre>
spyHelp                       Print this list
spyClkStart [ticksPerSec]     Start task activity monitor running
                                at ticksPerSec ticks per second
spyClkStop                    Stop collecting data
spyReport                     Prints display of task activity
                                statistics
spyStop                       Stop collecting data and reports
spy     [freq[,ticksPerSec]]  Start spyClkStart and do a report
                                every freq seconds

ticksPerSec defaults to 100.  freq defaults to 5 seconds.
</pre>

</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./usrLib.html#top">usrLib</a></b>, <b><a href="./spyLib.html#top">spyLib</a></b>,  
<i>VxWorks Programmer's Guide: Target Shell</i>

</body>
</html>