lib/sat-math.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #ifndef SAT_MATH_H
  35 #define SAT_MATH_H 1
  36
  37 #include <assert.h>
  38 #include <limits.h>
  39
  40 /* Saturating addition: overflow yields UINT_MAX. */
  41 static inline unsigned int
  42 sat_add(unsigned int x, unsigned int y)
  43 {
  44     return x + y >= x ? x + y : UINT_MAX;
  45 }
  46
  47 /* Saturating subtraction: underflow yields 0. */
  48 static inline unsigned int
  49 sat_sub(unsigned int x, unsigned int y)
  50 {
  51     return x >= y ? x - y : 0;
  52 }
  53
  54 /* Saturating multiplication: overflow yields UINT_MAX. */
  55 static inline unsigned int
  56 sat_mul(unsigned int x, unsigned int y)
  57 {
  58     return (!y ? 0
  59             : x <= UINT_MAX / y ? x * y
  60             : UINT_MAX);
  61 }
  62
  63 #endif /* sat-math.h */