ofproto: Update documentation
[sliver-openvswitch.git] / lib / sat-math.h
1 /*
2  * Copyright (c) 2008, 2012 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef SAT_MATH_H
18 #define SAT_MATH_H 1
19
20 #include <limits.h>
21
22 /* Saturating addition: overflow yields UINT_MAX. */
23 static inline unsigned int
24 sat_add(unsigned int x, unsigned int y)
25 {
26     return x + y >= x ? x + y : UINT_MAX;
27 }
28
29 /* Saturating subtraction: underflow yields 0. */
30 static inline unsigned int
31 sat_sub(unsigned int x, unsigned int y)
32 {
33     return x >= y ? x - y : 0;
34 }
35
36 /* Saturating multiplication of "unsigned int"s: overflow yields UINT_MAX. */
37 #define SAT_MUL(X, Y)                                                   \
38     ((Y) == 0 ? 0                                                       \
39      : (X) <= UINT_MAX / (Y) ? (unsigned int) (X) * (unsigned int) (Y)  \
40      : UINT_MAX)
41 static inline unsigned int
42 sat_mul(unsigned int x, unsigned int y)
43 {
44     return SAT_MUL(x, y);
45 }
46
47 #endif /* sat-math.h */