lib/librte_eal/common/include/rte_warnings.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 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 warnings for use of various insecure functions
  37  */
  38
  39 #ifndef _RTE_WARNINGS_H_
  40 #define _RTE_WARNINGS_H_
  41
  42 #ifdef RTE_INSECURE_FUNCTION_WARNING
  43
  44 /* we need to include all used standard header files so that they appear
  45  * _before_ we poison the function names.
  46  */
  47
  48 #include <stdio.h>
  49 #include <stdlib.h>
  50 #include <string.h>
  51 #include <stdarg.h>
  52 #include <errno.h>
  53 #ifdef RTE_LIBRTE_EAL_LINUXAPP
  54 #include <dirent.h>
  55 #endif
  56
  57 /* rte_snprintf uses snprintf, so include its definition before we poison the
  58  * functions, otherwise we'll get an error in it. */
  59 #include <rte_string_fns.h>
  60
  61 /* the following function are deemed not fully secure for use e.g. they
  62  * do not always null-terminate arguments */
  63 #pragma GCC poison sprintf strtok snprintf vsnprintf
  64 #pragma GCC poison strlen strcpy strcat
  65 #pragma GCC poison sscanf
  66
  67 /* other unsafe functions may be implemented as macros so just undef them */
  68 #ifdef strsep
  69 #undef strsep
  70 #else
  71 #pragma GCC poison strsep
  72 #endif
  73
  74 #ifdef strncpy
  75 #undef strncpy
  76 #else
  77 #pragma GCC poison strncpy
  78 #endif
  79
  80 #ifdef strncat
  81 #undef strncat
  82 #else
  83 #pragma GCC poison strncat
  84 #endif
  85
  86 #endif
  87
  88 #endif /* RTE_WARNINGS_H */