lib/sat-math.h

   1 /*
   2  * Copyright (c) 2008 Nicira Networks.
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef SAT_MATH_H
  18 #define SAT_MATH_H 1
  19
  20 #include <assert.h>
  21 #include <limits.h>
  22
  23 /* Saturating addition: overflow yields UINT_MAX. */
  24 static inline unsigned int
  25 sat_add(unsigned int x, unsigned int y)
  26 {
  27     return x + y >= x ? x + y : UINT_MAX;
  28 }
  29
  30 /* Saturating subtraction: underflow yields 0. */
  31 static inline unsigned int
  32 sat_sub(unsigned int x, unsigned int y)
  33 {
  34     return x >= y ? x - y : 0;
  35 }
  36
  37 /* Saturating multiplication: overflow yields UINT_MAX. */
  38 static inline unsigned int
  39 sat_mul(unsigned int x, unsigned int y)
  40 {
  41     return (!y ? 0
  42             : x <= UINT_MAX / y ? x * y
  43             : UINT_MAX);
  44 }
  45
  46 #endif /* sat-math.h */