501b2676d95b6661966b85eadc9ba2b849285f99
[rrdtool.git] / src / rrd_format.c
1 /*****************************************************************************
2  * RRDtool 1.4.3  Copyright by Tobi Oetiker, 1997-2010
3  *****************************************************************************
4  * rrd_format.c  RRD Database Format helper functions
5  *****************************************************************************
6  * $Id$
7  * $Log$
8  * Revision 1.5  2004/05/18 18:53:03  oetiker
9  * big spell checking patch -- slif@bellsouth.net
10  *
11  * Revision 1.4  2003/02/13 07:05:27  oetiker
12  * Find attached the patch I promised to send to you. Please note that there
13  * are three new source files (src/rrd_is_thread_safe.h, src/rrd_thread_safe.c
14  * and src/rrd_not_thread_safe.c) and the introduction of librrd_th. This
15  * library is identical to librrd, but it contains support code for per-thread
16  * global variables currently used for error information only. This is similar
17  * to how errno per-thread variables are implemented.  librrd_th must be linked
18  * alongside of libpthred
19  *
20  * There is also a new file "THREADS", holding some documentation.
21  *
22  * -- Peter Stamfest <peter@stamfest.at>
23  *
24  * Revision 1.3  2002/02/01 20:34:49  oetiker
25  * fixed version number and date/time
26  *
27  * Revision 1.2  2001/03/10 23:54:39  oetiker
28  * Support for COMPUTE data sources (CDEF data sources). Removes the RPN
29  * parser and calculator from rrd_graph and puts then in a new file,
30  * rrd_rpncalc.c. Changes to core files rrd_create and rrd_update. Some
31  * clean-up of aberrant behavior stuff, including a bug fix.
32  * Documentation update (rrdcreate.pod, rrdupdate.pod). Change xml format.
33  * -- Jake Brutlag <jakeb@corp.webtv.net>
34  *
35  * Revision 1.1.1.1  2001/02/25 22:25:05  oetiker
36  * checkin
37  *
38  * Revision 1.3  1998/03/08 12:35:11  oetiker
39  * checkpointing things because the current setup seems to work
40  * according to the things said in the manpages
41  *
42  * Revision 1.2  1998/02/26 22:58:22  oetiker
43  * fixed define
44  *
45  * Revision 1.1  1998/02/21 16:14:41  oetiker
46  * Initial revision
47  *
48  *
49  *****************************************************************************/
50 #include "rrd_tool.h"
51
52 #define converter(VV,VVV) \
53    if (strcmp(#VV, string) == 0) return VVV;
54
55 /* conversion functions to allow symbolic entry of enumerations */
56 enum dst_en dst_conv(
57     char *string)
58 {
59     converter(COUNTER, DST_COUNTER)
60         converter(ABSOLUTE, DST_ABSOLUTE)
61         converter(GAUGE, DST_GAUGE)
62         converter(DERIVE, DST_DERIVE)
63         converter(COMPUTE, DST_CDEF)
64         rrd_set_error("unknown data acquisition function '%s'", string);
65     return (enum dst_en)(-1);
66 }
67
68
69 enum cf_en cf_conv(
70     const char *string)
71 {
72
73     converter(AVERAGE, CF_AVERAGE)
74         converter(MIN, CF_MINIMUM)
75         converter(MAX, CF_MAXIMUM)
76         converter(LAST, CF_LAST)
77         converter(HWPREDICT, CF_HWPREDICT)
78         converter(MHWPREDICT, CF_MHWPREDICT)
79         converter(DEVPREDICT, CF_DEVPREDICT)
80         converter(SEASONAL, CF_SEASONAL)
81         converter(DEVSEASONAL, CF_DEVSEASONAL)
82         converter(FAILURES, CF_FAILURES)
83         rrd_set_error("unknown consolidation function '%s'", string);
84     return (enum cf_en)(-1);
85 }
86
87 const char *cf_to_string (enum cf_en cf)
88 {
89     switch (cf)
90     {
91         case CF_AVERAGE:     return "AVERAGE";
92         case CF_MINIMUM:     return "MIN";
93         case CF_MAXIMUM:     return "MAX";
94         case CF_LAST:        return "LAST";
95         case CF_HWPREDICT:   return "HWPREDICT";
96         case CF_SEASONAL:    return "SEASONAL";
97         case CF_DEVPREDICT:  return "DEVPREDICT";
98         case CF_DEVSEASONAL: return "DEVSEASONAL";
99         case CF_FAILURES:    return "FAILURES";
100         case CF_MHWPREDICT:  return "MHWPREDICT";
101
102         default:
103             return NULL;
104     }
105 } /* char *cf_to_string */
106
107 #undef converter
108
109 long ds_match(
110     rrd_t *rrd,
111     char *ds_nam)
112 {
113     unsigned long i;
114
115     for (i = 0; i < rrd->stat_head->ds_cnt; i++)
116         if ((strcmp(ds_nam, rrd->ds_def[i].ds_nam)) == 0)
117             return i;
118     rrd_set_error("unknown data source name '%s'", ds_nam);
119     return -1;
120 }
121
122 off_t rrd_get_header_size(
123     rrd_t *rrd)
124 {
125     return sizeof(stat_head_t) + \
126         sizeof(ds_def_t) * rrd->stat_head->ds_cnt + \
127         sizeof(rra_def_t) * rrd->stat_head->rra_cnt + \
128         sizeof(time_t) + \
129         sizeof(live_head_t) + \
130         sizeof(pdp_prep_t) * rrd->stat_head->ds_cnt + \
131         sizeof(cdp_prep_t) * rrd->stat_head->ds_cnt * rrd->stat_head->rra_cnt + \
132         sizeof(rra_ptr_t) * rrd->stat_head->rra_cnt;
133 }