Update version after release of v0.6.5.2
[olsrd.git] / src / mantissa.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
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 "mantissa.h"
43
44 /**
45  *Function that converts a double to a mantissa/exponent
46  *product as described in RFC3626:
47  *
48  * value = C*(1+a/16)*2^b [in seconds]
49  *
50  *  where a is the integer represented by the four highest bits of the
51  *  field and b the integer represented by the four lowest bits of the
52  *  field.
53  *
54  *@param interval the time interval to process
55  *
56  *@return a 8-bit mantissa/exponent product
57  */
58 uint8_t
59 reltime_to_me(const olsr_reltime interval)
60 {
61   uint8_t a, b;
62
63   /* It is sufficent to compare the integer part since we test on >=.
64    * So we have now only a floating point division and the rest of the loop
65    * are only integer operations.
66    *
67    * const unsigned int unscaled_interval = interval / VTIME_SCALE_FACTOR;
68    *
69    * VTIME_SCALE_FACTOR = 1/16
70    *
71    * => unscaled_interval = interval(ms) / 1000 * 16
72    *                      = interval(ms) / 125 * 2
73    */
74   const unsigned int unscaled_interval = interval / 125 * 2;
75   b = 0;
76   while (unscaled_interval >= (1U << b)) {
77     b++;
78   }
79
80   if (b == 0) {
81     a = 1;
82     b = 0;
83   } else {
84     b--;
85     if (b > 15) {
86       a = 15;
87       b = 15;
88     } else {
89       /* And again some maths simplification from the former version:
90        *    a = 16 * ((double)interval / (VTIME_SCALE_FACTOR * (double)(1 << b)) - 1)
91        * Since interval is already double:
92        *    a = 16 * (interval / (VTIME_SCALE_FACTOR * (double)(1 << b)) - 1)
93        * first, we can get rid of parentheses and change the * to a /
94        *    a = 16 * (interval / VTIME_SCALE_FACTOR / (double)(1 << b) - 1)
95        * then we make an integer addition from the floating point addition
96        *    a = (int)(16.0 * interval / VTIME_SCALE_FACTOR / (double)(1 << b)) - 16
97        * and we loose an unnecessary cast
98        *    a = (int)(16.0 * interval / VTIME_SCALE_FACTOR / (1 << b)) - 16
99        *
100        * VTIME_SCALE_FACTOR = 1/16
101        *
102        * => a = (16 * interval(ms) / 1000 * 16 / (1 << b)) - 16
103        *      = (interval(ms) * 256 / 1000 / (1 << b)) - 16
104        *      = (interval(ms) * 32 / 125 / (1<<b)) - 16
105        *      = (interval(ms) - 16/32*125*(1<<b)) * 32 / 125 / (1<<b)
106        *      = (interval(ms) - 125*(1<<(b-1))) * 32 / 125 / (1<<b)
107        *
108        * 1. case: b >= 5
109        *      = (interval(ms) - (125 << (b-1))) / 125 / (1 << (b-5))
110        *      = (interval(ms) - (125 << (b-1))) / (125  << (b-5))
111        *
112        * 2. case: b <= 5
113        *      = (interval(ms) - (125 << (b-1))) / 125 * (1 << (5-b))
114        *      = (interval(ms) - (125 << (b-1))) * (1 << (5-b)) / 125
115        */
116
117       if (b >= 5) {
118         a = (interval - (125 << (b - 1))) / (125 << (b - 5));
119       } else {
120         a = (interval - (125 << (b - 1))) * (1 << (5 - b)) / 125;
121       }
122
123       b += a >> 4;
124       a &= 0x0f;
125     }
126   }
127
128   return (a << 4) | (b & 0x0F);
129 }
130
131 /**
132  * Function for converting a mantissa/exponent 8bit value back
133  * to double as described in RFC3626:
134  *
135  * value = C*(1+a/16)*2^b [in seconds]
136  *
137  *  where a is the integer represented by the four highest bits of the
138  *  field and b the integer represented by the four lowest bits of the
139  *  field.
140  *
141  * me is the 8 bit mantissa/exponent value
142  *
143  * To avoid expensive floating maths, we transform the equation:
144  *     value = C * (1 + a / 16) * 2^b
145  * first, we make an int addition from the floating point addition:
146  *     value = C * ((16 + a) / 16) * 2^b
147  * then we get rid of a pair of parentheses
148  *     value = C * (16 + a) / 16 * 2^b
149  * and now we make an int multiplication from the floating point one
150  *     value = C * (16 + a) * 2^b / 16
151  * so that we can make a shift from the multiplication
152  *     value = C * ((16 + a) << b) / 16
153  * and sionce C and 16 are constants
154  *     value = ((16 + a) << b) * C / 16
155  *
156  * VTIME_SCALE_FACTOR = 1/16
157  *
158  * =>  value(ms) = ((16 + a) << b) / 256 * 1000
159  *
160  * 1. case: b >= 8
161  *           = ((16 + a) << (b-8)) * 1000
162  *
163  * 2. case: b <= 8
164  *           = ((16 + a) * 1000) >> (8-b)
165  */
166 olsr_reltime
167 me_to_reltime(const uint8_t me)
168 {
169   const uint8_t a = me >> 4;
170   const uint8_t b = me & 0x0F;
171
172   if (b >= 8) {
173     return ((16 + a) << (b - 8)) * 1000;
174   }
175   return ((16 + a) * 1000) >> (8 - b);
176 }
177
178 /*
179  * Local Variables:
180  * c-basic-offset: 2
181  * indent-tabs-mode: nil
182  * End:
183  */