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 #if !defined(KERNEL)
  35 #include <string.h>
  36 #endif
  37
  38 #include "rx.h"
  39 #include "rx_atomic.h"
  40 #include "rx_stats.h"
  41
  42 /* Globals */
  43
  44 /*!
  45  * rx_stats_mutex protects the non-atomic members of the rx_stats structure
  46  */
  47 #if defined(RX_ENABLE_LOCKS)
  48 afs_kmutex_t rx_stats_mutex;
  49 #endif
  50
  51 struct rx_statisticsAtomic rx_stats;
  52
  53 /*!
  54  * Return the internal statistics collected by rx
  55  *
  56  * @return
  57  *      A statistics structure which must be freed using rx_FreeStatistics
  58  * @notes
  59  *      Takes, and releases rx_stats_mutex
  60  */
  61 struct rx_statistics *
  62 rx_GetStatistics(void) {
  63     struct rx_statistics *stats = rxi_Alloc(sizeof(struct rx_statistics));
  64     MUTEX_ENTER(&rx_stats_mutex);
  65     memcpy(stats, &rx_stats, sizeof(struct rx_statistics));
  66     MUTEX_EXIT(&rx_stats_mutex);
  67
  68     return stats;
  69 }
  70
  71 /*!
  72  * Free a statistics block allocated by rx_GetStatistics
  73  *
  74  * @param stats
  75  *      The statistics block to free
  76  */
  77 void
  78 rx_FreeStatistics(struct rx_statistics **stats) {
  79     if (*stats) {
  80         rxi_Free(*stats, sizeof(struct rx_statistics));
  81         *stats = NULL;
  82     }
  83 }
  84
  85 /*!
  86  * Zero the internal statistics structure
  87  *
  88  * @private
  89  */
  90
  91 void
  92 rxi_ResetStatistics(void) {
  93     memset(&rx_stats, 0, sizeof(struct rx_statisticsAtomic));
  94 }