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