src/rx/rx_stats.c

   1 /*
   2  * Copyright (c) 2010 Your File System Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 /*!
  26  * @file rx_stats.c
  27  *
  28  * Code for handling statistics gathering within RX, and for mapping the
  29  * internal representation into an external one
  30  */
  31 #include <afsconfig.h>
  32 #include <afs/param.h>
  33
  34 #include <string.h>
  35
  36 #include "rx.h"
  37 #include "rx_atomic.h"
  38 #include "rx_stats.h"
  39
  40 /* Globals */
  41
  42 /*!
  43  * rx_stats_mutex protects the non-atomic members of the rx_stats structure
  44  */
  45 #if defined(RX_ENABLE_LOCKS)
  46 afs_kmutex_t rx_stats_mutex;
  47 #endif
  48
  49 struct rx_statisticsAtomic rx_stats;
  50
  51 /*!
  52  * Return the internal statistics collected by rx
  53  *
  54  * @return
  55  *      A statistics structure which must be freed using rx_FreeStatistics
  56  * @notes
  57  *      Takes, and releases rx_stats_mutex
  58  */
  59 struct rx_statistics *
  60 rx_GetStatistics(void) {
  61     struct rx_statistics *stats = rxi_Alloc(sizeof(struct rx_statistics));
  62     MUTEX_ENTER(&rx_stats_mutex);
  63     memcpy(stats, &rx_stats, sizeof(struct rx_statistics));
  64     MUTEX_EXIT(&rx_stats_mutex);
  65
  66     return stats;
  67 }
  68
  69 /*!
  70  * Free a statistics block allocated by rx_GetStatistics
  71  *
  72  * @param stats
  73  *      The statistics block to free
  74  */
  75 void
  76 rx_FreeStatistics(struct rx_statistics **stats) {
  77     if (*stats) {
  78         rxi_Free(*stats, sizeof(struct rx_statistics));
  79         *stats = NULL;
  80     }
  81 }
  82
  83 /*!
  84  * Zero the internal statistics structure
  85  *
  86  * @private
  87  */
  88
  89 void
  90 rxi_ResetStatistics(void) {
  91     memset(&rx_stats, 0, sizeof(struct rx_statisticsAtomic));
  92 }