lib/libhammer/libhammer_stats.3

   1 .\"
   2 .\" Copyright (c) 2013 The DragonFly Project.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to The DragonFly Project
   5 .\" by Antonio Huete Jimenez <tuxillo@quantumachine.net>
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in
  15 .\"    the documentation and/or other materials provided with the
  16 .\"    distribution.
  17 .\" 3. Neither the name of The DragonFly Project nor the names of its
  18 .\"    contributors may be used to endorse or promote products derived
  19 .\"    from this software without specific, prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .Dd September 9, 2013
  35 .Dt LIBHAMMER 3
  36 .Os
  37 .Sh NAME
  38 .Nm libhammer_stats_redo ,
  39 .Nm libhammer_stats_undo ,
  40 .Nm libhammer_stats_commits ,
  41 .Nm libhammer_stats_inode_flushes ,
  42 .Nm libhammer_stats_disk_write ,
  43 .Nm libhammer_stats_disk_read ,
  44 .Nm libhammer_stats_file_iopsw ,
  45 .Nm libhammer_stats_file_iopsr ,
  46 .Nm libhammer_stats_file_write ,
  47 .Nm libhammer_stats_file_read ,
  48 .Nm libhammer_stats_record_iterations ,
  49 .Nm libhammer_stats_root_iterations ,
  50 .Nm libhammer_stats_btree_iterations ,
  51 .Nm libhammer_stats_btree_splits ,
  52 .Nm libhammer_stats_btree_elements ,
  53 .Nm libhammer_stats_btree_deletes ,
  54 .Nm libhammer_stats_btree_inserts ,
  55 .Nm libhammer_stats_btree_lookups ,
  56 .Nm libhammer_stats_btree_searches ,
  57 .Nm libhammer_btree_stats ,
  58 .Nm libhammer_io_stats
  59 .Nd libhammer statistics functions
  60 .Sh LIBRARY
  61 .Lb libhammer
  62 .Sh SYNOPSIS
  63 .In libhammer.h
  64 .Ft int
  65 .Fn libhammer_stats_redo "int64_t *value"
  66 .Ft int
  67 .Fn libhammer_stats_undo "int64_t *value"
  68 .Ft int
  69 .Fn libhammer_stats_commits "int64_t *value"
  70 .Ft int
  71 .Fn libhammer_stats_inode_flushes "int64_t *value"
  72 .Ft int
  73 .Fn libhammer_stats_disk_write "int64_t *value"
  74 .Ft int
  75 .Fn libhammer_stats_disk_read "int64_t *value"
  76 .Ft int
  77 .Fn libhammer_stats_file_iopsw "int64_t *value"
  78 .Ft int
  79 .Fn libhammer_stats_file_iopsr "int64_t *value"
  80 .Ft int
  81 .Fn libhammer_stats_file_write "int64_t *value"
  82 .Ft int
  83 .Fn libhammer_stats_file_read "int64_t *value"
  84 .Ft int
  85 .Fn libhammer_stats_record_iterations "int64_t *value"
  86 .Ft int
  87 .Fn libhammer_stats_root_iterations "int64_t *value"
  88 .Ft int
  89 .Fn libhammer_stats_btree_iterations "int64_t *value"
  90 .Ft int
  91 .Fn libhammer_stats_btree_splits "int64_t *value"
  92 .Ft int
  93 .Fn libhammer_stats_btree_elements "int64_t *value"
  94 .Ft int
  95 .Fn libhammer_stats_btree_deletes "int64_t *value"
  96 .Ft int
  97 .Fn libhammer_stats_btree_inserts "int64_t *value"
  98 .Ft int
  99 .Fn libhammer_stats_btree_lookups "int64_t *value"
 100 .Ft int
 101 .Fn libhammer_stats_btree_searches "int64_t *value"
 102 .Ft int
 103 .Fn libhammer_btree_stats "struct libhammer_btree_stats *bstats"
 104 .Ft int
 105 .Fn libhammer_io_stats "struct libhammer_io_stats *iostats"
 106 .Sh DESCRIPTION
 107 The set of functions described above will help to gather
 108 statistics of the mounted
 109 .Nm HAMMER
 110 filesystems in the system.
 111 .Pp
 112 All the functions will take argument
 113 .Ar value
 114 to store the value for the sysctl requested, except for
 115 .Fn libhammer_btree_stats
 116 and
 117 .Fn libhammer_io_stats
 118 which will take structures to store groups of values.
 119 .Sh RETURN VALUES
 120 .Rv -std
 121 .Sh SEE ALSO
 122 .Xr HAMMER 5 ,
 123 .Xr hammer 8 ,
 124 .Sh AUTHORS
 125 This manpage was written by
 126 .An Antonio Huete Jimenez.