lib/librte_eal/linuxapp/eal/include/eal_fs_paths.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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 /**
  36  * @file
  37  * Paths used for storing hugepage and config info for multi-process support.
  38  */
  39
  40 #ifndef _EAL_LINUXAPP_FS_PATHS_H
  41 #define _EAL_LINUXAPP_FS_PATHS_H
  42
  43 /** Path of rte config file. */
  44 #define RUNTIME_CONFIG_FMT "%s/.%s_config"
  45
  46 static const char *default_config_dir = "/var/run";
  47
  48 static inline const char *
  49 eal_runtime_config_path(void)
  50 {
  51         static char buffer[PATH_MAX]; /* static so auto-zeroed */
  52         const char *directory = default_config_dir;
  53         const char *home_dir = getenv("HOME");
  54
  55         if (getuid() != 0 && home_dir != NULL)
  56                 directory = home_dir;
  57         rte_snprintf(buffer, sizeof(buffer) - 1, RUNTIME_CONFIG_FMT, directory,
  58                         internal_config.hugefile_prefix);
  59         return buffer;
  60 }
  61
  62 /** Path of hugepage info file. */
  63 #define HUGEPAGE_INFO_FMT "%s/.%s_hugepage_info"
  64
  65 static inline const char *
  66 eal_hugepage_info_path(void)
  67 {
  68         static char buffer[PATH_MAX]; /* static so auto-zeroed */
  69         const char *directory = default_config_dir;
  70         const char *home_dir = getenv("HOME");
  71
  72         if (getuid() != 0 && home_dir != NULL)
  73                 directory = home_dir;
  74         rte_snprintf(buffer, sizeof(buffer) - 1, HUGEPAGE_INFO_FMT, directory,
  75                         internal_config.hugefile_prefix);
  76         return buffer;
  77 }
  78
  79 /** String format for hugepage map files. */
  80 #define HUGEFILE_FMT "%s/%smap_%d"
  81
  82 static inline const char *
  83 eal_get_hugefile_path(char *buffer, size_t buflen, const char *hugedir, int f_id)
  84 {
  85         rte_snprintf(buffer, buflen, HUGEFILE_FMT, hugedir,
  86                         internal_config.hugefile_prefix, f_id);
  87         buffer[buflen - 1] = '\0';
  88         return buffer;
  89 }
  90
  91 /** define the default filename prefix for the %s values above */
  92 #define HUGEFILE_PREFIX_DEFAULT "rte"
  93
  94
  95 #endif /* _EAL_LINUXAPP_FS_PATHS_H */