Port all olsrd 0.6.0 OS specific files and adapt them to the new interface.
[olsrd.git] / src / olsr_time.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #include <assert.h>
43 #include <ctype.h>
44
45 #include "olsr_time.h"
46
47 /**
48  *Function that converts a double to a mantissa/exponent
49  *product as described in RFC3626:
50  *
51  * value = C*(1+a/16)*2^b [in seconds]
52  *
53  *  where a is the integer represented by the four highest bits of the
54  *  field and b the integer represented by the four lowest bits of the
55  *  field.
56  *
57  *@param interval the time interval to process
58  *
59  *@return a 8-bit mantissa/exponent product
60  */
61 uint8_t
62 reltime_to_me(const uint32_t interval)
63 {
64   uint8_t a = 0, b = 0;                /* Underflow defaults */
65
66   /* It is sufficent to compare the integer part since we test on >=.
67    * So we have now only a floating point division and the rest of the loop
68    * are only integer operations.
69    *
70    * const unsigned int unscaled_interval = interval / VTIME_SCALE_FACTOR;
71    *
72    * VTIME_SCALE_FACTOR = 1/16
73    *
74    * => unscaled_interval = interval(ms) / 1000 * 16
75    *                      = interval(ms) / 125 * 2
76    */
77
78   unsigned unscaled_interval = interval;
79   while (unscaled_interval >= 62) {
80     unscaled_interval >>= 1;
81     b++;
82   }
83
84   if (0 < b) {
85     if (15 < --b) {
86       a = 15;                   /* Overflow defaults */
87       b = 15;
88     } else {
89       a = (interval >> (b + 2)) - 15;
90     }
91   }
92
93   return (a << 4) + b;
94 }
95
96 /**
97  * Function for converting a mantissa/exponent 8bit value back
98  * to double as described in RFC3626:
99  *
100  * value = C*(1+a/16)*2^b [in seconds]
101  *
102  *  where a is the integer represented by the four highest bits of the
103  *  field and b the integer represented by the four lowest bits of the
104  *  field.
105  *
106  * me is the 8 bit mantissa/exponent value
107  *
108  * To avoid expensive floating maths, we transform the equation:
109  *     value = C * (1 + a / 16) * 2^b
110  * first, we make an int addition from the floating point addition:
111  *     value = C * ((16 + a) / 16) * 2^b
112  * then we get rid of a pair of parentheses
113  *     value = C * (16 + a) / 16 * 2^b
114  * and now we make an int multiplication from the floating point one
115  *     value = C * (16 + a) * 2^b / 16
116  * so that we can make a shift from the multiplication
117  *     value = C * ((16 + a) << b) / 16
118  * and sionce C and 16 are constants
119  *     value = ((16 + a) << b) * C / 16
120  *
121  * VTIME_SCALE_FACTOR = 1/16
122  *
123  * =>  value(ms) = ((16 + a) << b) / 256 * 1000
124  *
125  * 1. case: b >= 8
126  *           = ((16 + a) << (b-8)) * 1000
127  *
128  * 2. case: b <= 8
129  *           = ((16 + a) * 1000) >> (8-b)
130  */
131 uint32_t
132 me_to_reltime(const uint8_t me)
133 {
134   const uint8_t a = me >> 4;
135   const uint8_t b = me & 0x0F;
136
137   if (b >= 8) {
138     return ((16 + a) << (b - 8)) * 1000;
139   }
140   assert(me == reltime_to_me(((16 + a) * 1000) >> (8 - b)));
141   return ((16 + a) * 1000) >> (8 - b);
142 }
143
144 /**
145  * converts an unsigned integer value into a string representation
146  * (divided by 1000)
147  */
148 char *
149 olsr_milli_to_txt(struct millitxt_buf *buffer, uint32_t t) {
150   sprintf(buffer->buf, "%u.%03u", t/1000, t%1000);
151   return buffer->buf;
152 }
153
154 /**
155  * converts a floating point text into a unsigned integer representation
156  * (multiplied by 1000)
157  */
158 uint32_t olsr_txt_to_milli(char *txt) {
159   uint32_t t = 0;
160   int fractionDigits = 0;
161   bool frac = false;
162
163   while (fractionDigits < 3 && *txt) {
164     if (*txt == '.' && !frac) {
165       frac = true;
166       txt++;
167     }
168
169     if (!isdigit(*txt)) {
170       break;
171     }
172
173     t = t * 10 + (*txt++ - '0');
174     if (frac) {
175       fractionDigits++;
176     }
177   }
178
179   while (fractionDigits++ < 3) {
180     t *= 10;
181   }
182   return t;
183 }
184
185 /*
186  * Local Variables:
187  * c-basic-offset: 2
188  * indent-tabs-mode: nil
189  * End:
190  */