Changeset 80bfb601 in mainline for uspace/lib/c/generic/stats.c


Ignore:
Timestamp:
2010-04-18T09:57:19Z (15 years ago)
Author:
Martin Decky <martin@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
d869398
Parents:
fce3536
Message:

improve sysinfo and stats documentation (no change in functionality)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/lib/c/generic/stats.c

    rfce3536 r80bfb601  
    4343#define SYSINFO_STATS_MAX_PATH  64
    4444
     45/** Get CPUs statistics
     46 *
     47 * @param count Number of records returned.
     48 *
     49 * @return Array of stats_cpu_t structures.
     50 *         If non-NULL then it should be eventually freed
     51 *         by free().
     52 *
     53 */
    4554stats_cpu_t *get_stats_cpus(size_t *count)
    4655{
    … …  
    5564}
    5665
     66/** Get physical memory statistics
     67 *
     68 *
     69 * @return Pointer to the stats_physmem_t structure.
     70 *         If non-NULL then it should be eventually freed
     71 *         by free().
     72 *
     73 */
    5774stats_physmem_t *get_stats_physmem(void)
    5875{
    … …  
    6683}
    6784
     85/** Get task IDs
     86 *
     87 * @param count Number of IDs returned.
     88 *
     89 * @return Array of IDs (task_id_t).
     90 *         If non-NULL then it should be eventually freed
     91 *         by free().
     92 *
     93 */
    6894task_id_t *get_stats_tasks(size_t *count)
    6995{
    … …  
    78104}
    79105
     106/** Get single task statistics
     107 *
     108 * @param task_id Task ID we are interested in.
     109 *
     110 * @return Pointer to the stats_task_t structure.
     111 *         If non-NULL then it should be eventually freed
     112 *         by free().
     113 *
     114 */
    80115stats_task_t *get_stats_task(task_id_t task_id)
    81116{
    … …  
    92127}
    93128
     129/** Get system load
     130 *
     131 * @param count Number of load records returned.
     132 *
     133 * @return Array of load records (load_t).
     134 *         If non-NULL then it should be eventually freed
     135 *         by free().
     136 *
     137 */
    94138load_t *get_stats_load(size_t *count)
    95139{
    … …  
    104148}
    105149
     150/** Get system uptime
     151 *
     152 * @return System uptime (in seconds).
     153 *
     154 */
    106155sysarg_t get_stats_uptime(void)
    107156{
    … …  
    113162}
    114163
     164/** Print load fixed-point value
     165 *
     166 * Print the load record fixed-point value in decimal
     167 * representation on stdout.
     168 *
     169 * @param upper      Load record.
     170 * @param dec_length Number of decimal digits to print.
     171 *
     172 */
    115173void print_load_fragment(load_t upper, unsigned int dec_length)
    116174{
Note: See TracChangeset for help on using the changeset viewer.