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