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