lib/librte_eal/common/include/rte_version.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /**
  35  * @file
  36  * Definitions of Intel(R) DPDK version numbers
  37  */
  38
  39 #ifndef _RTE_VERSION_H_
  40 #define _RTE_VERSION_H_
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 #include <stdint.h>
  47 #include <rte_common.h>
  48
  49 /**
  50  * String that appears before the version number
  51  */
  52 #define RTE_VER_PREFIX "RTE"
  53
  54 /**
  55  * Major version number i.e. the x in x.y.z
  56  */
  57 #define RTE_VER_MAJOR 1
  58
  59 /**
  60  * Minor version number i.e. the y in x.y.z
  61  */
  62 #define RTE_VER_MINOR 7
  63
  64 /**
  65  * Patch level number i.e. the z in x.y.z
  66  */
  67 #define RTE_VER_PATCH_LEVEL 0
  68
  69 /**
  70  * Extra string to be appended to version number
  71  */
  72 #define RTE_VER_SUFFIX "-rc"
  73
  74 /**
  75  * Patch release number
  76  *   0-15 = release candidates
  77  *   16   = release
  78  */
  79 #define RTE_VER_PATCH_RELEASE 0
  80
  81 /**
  82  * Macro to compute a version number usable for comparisons
  83  */
  84 #define RTE_VERSION_NUM(a,b,c,d) ((a) << 24 | (b) << 16 | (c) << 8 | (d))
  85
  86 /**
  87  * All version numbers in one to compare with RTE_VERSION_NUM()
  88  */
  89 #define RTE_VERSION RTE_VERSION_NUM( \
  90                         RTE_VER_MAJOR, \
  91                         RTE_VER_MINOR, \
  92                         RTE_VER_PATCH_LEVEL, \
  93                         RTE_VER_PATCH_RELEASE)
  94
  95 /**
  96  * Function returning version string
  97  * @return
  98  *     string
  99  */
 100 static inline const char *
 101 rte_version(void)
 102 {
 103         static char version[32];
 104         if (version[0] != 0)
 105                 return version;
 106         if (strlen(RTE_VER_SUFFIX) == 0)
 107                 sprintf(version, "%s %d.%d.%d",
 108                         RTE_VER_PREFIX,
 109                         RTE_VER_MAJOR,
 110                         RTE_VER_MINOR,
 111                         RTE_VER_PATCH_LEVEL);
 112         else
 113                 sprintf(version, "%s %d.%d.%d%s%d",
 114                         RTE_VER_PREFIX,
 115                         RTE_VER_MAJOR,
 116                         RTE_VER_MINOR,
 117                         RTE_VER_PATCH_LEVEL,
 118                         RTE_VER_SUFFIX,
 119                         RTE_VER_PATCH_RELEASE < 16 ?
 120                                 RTE_VER_PATCH_RELEASE :
 121                                 RTE_VER_PATCH_RELEASE - 16);
 122         return version;
 123 }
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif
 128
 129 #endif /* RTE_VERSION_H */