include/openvswitch/util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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 OPENVSWITCH_UTIL_H
  18 #define OPENVSWITCH_UTIL_H 1
  19
  20 #include <openvswitch/version.h>
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 void ovs_set_program_name__(const char *name, const char *version,
  27                             const char *date, const char *time);
  28
  29 #define ovs_set_program_name(name, version) \
  30         ovs_set_program_name__(name, version, __DATE__, __TIME__)
  31
  32 const char *ovs_get_program_name(void);
  33 const char *ovs_get_program_version(void);
  34
  35 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
  36  *
  37  * See http://c-faq.com/ansi/stringize.html for an explanation of OVS_STRINGIZE
  38  * and OVS_STRINGIZE2. */
  39 #define OVS_SOURCE_LOCATOR __FILE__ ":" OVS_STRINGIZE(__LINE__)
  40 #define OVS_STRINGIZE(ARG) OVS_STRINGIZE2(ARG)
  41 #define OVS_STRINGIZE2(ARG) #ARG
  42
  43 /* Saturating multiplication of "unsigned int"s: overflow yields UINT_MAX. */
  44 #define OVS_SAT_MUL(X, Y)                                               \
  45     ((Y) == 0 ? 0                                                       \
  46      : (X) <= UINT_MAX / (Y) ? (unsigned int) (X) * (unsigned int) (Y)  \
  47      : UINT_MAX)
  48
  49 #ifdef __cplusplus
  50 }
  51 #endif
  52
  53 #endif