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 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 <string.h>
  48 #include <rte_common.h>
  49
  50 /**
  51  * String that appears before the version number
  52  */
  53 #define RTE_VER_PREFIX "DPDK"
  54
  55 /**
  56  * Major version/year number i.e. the yy in yy.mm.z
  57  */
  58 #define RTE_VER_YEAR 16
  59
  60 /**
  61  * Minor version/month number i.e. the mm in yy.mm.z
  62  */
  63 #define RTE_VER_MONTH 4
  64
  65 /**
  66  * Patch level number i.e. the z in yy.mm.z
  67  */
  68 #define RTE_VER_MINOR 0
  69
  70 /**
  71  * Extra string to be appended to version number
  72  */
  73 #define RTE_VER_SUFFIX ""
  74
  75 /**
  76  * Patch release number
  77  *   0-15 = release candidates
  78  *   16   = release
  79  */
  80 #define RTE_VER_RELEASE 16
  81
  82 /**
  83  * Macro to compute a version number usable for comparisons
  84  */
  85 #define RTE_VERSION_NUM(a,b,c,d) ((a) << 24 | (b) << 16 | (c) << 8 | (d))
  86
  87 /**
  88  * All version numbers in one to compare with RTE_VERSION_NUM()
  89  */
  90 #define RTE_VERSION RTE_VERSION_NUM( \
  91                         RTE_VER_YEAR, \
  92                         RTE_VER_MONTH, \
  93                         RTE_VER_MINOR, \
  94                         RTE_VER_RELEASE)
  95
  96 /**
  97  * Function returning version string
  98  * @return
  99  *     string
 100  */
 101 static inline const char *
 102 rte_version(void)
 103 {
 104         static char version[32];
 105         if (version[0] != 0)
 106                 return version;
 107         if (strlen(RTE_VER_SUFFIX) == 0)
 108                 snprintf(version, sizeof(version), "%s %d.%02d.%d",
 109                         RTE_VER_PREFIX,
 110                         RTE_VER_YEAR,
 111                         RTE_VER_MONTH,
 112                         RTE_VER_MINOR);
 113         else
 114                 snprintf(version, sizeof(version), "%s %d.%02d.%d%s%d",
 115                         RTE_VER_PREFIX,
 116                         RTE_VER_YEAR,
 117                         RTE_VER_MONTH,
 118                         RTE_VER_MINOR,
 119                         RTE_VER_SUFFIX,
 120                         RTE_VER_RELEASE < 16 ?
 121                                 RTE_VER_RELEASE :
 122                                 RTE_VER_RELEASE - 16);
 123         return version;
 124 }
 125
 126 #ifdef __cplusplus
 127 }
 128 #endif
 129
 130 #endif /* RTE_VERSION_H */