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