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