lib/librte_eal/linuxapp/eal/include/eal_filesystem.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  * Stores functions and path defines for files and directories
  38  * on the filesystem for Linux, that are used by the Linux EAL.
  39  */
  40
  41 #ifndef _EAL_LINUXAPP_FILESYSTEM_H
  42 #define _EAL_LINUXAPP_FILESYSTEM_H
  43
  44 /** Path of rte config file. */
  45 #define RUNTIME_CONFIG_FMT "%s/.%s_config"
  46
  47 #include <stdint.h>
  48 #include <limits.h>
  49 #include <unistd.h>
  50 #include <rte_string_fns.h>
  51 #include "eal_internal_cfg.h"
  52
  53 static const char *default_config_dir = "/var/run";
  54
  55 static inline const char *
  56 eal_runtime_config_path(void)
  57 {
  58         static char buffer[PATH_MAX]; /* static so auto-zeroed */
  59         const char *directory = default_config_dir;
  60         const char *home_dir = getenv("HOME");
  61
  62         if (getuid() != 0 && home_dir != NULL)
  63                 directory = home_dir;
  64         rte_snprintf(buffer, sizeof(buffer) - 1, RUNTIME_CONFIG_FMT, directory,
  65                         internal_config.hugefile_prefix);
  66         return buffer;
  67 }
  68
  69 /** Path of hugepage info file. */
  70 #define HUGEPAGE_INFO_FMT "%s/.%s_hugepage_info"
  71
  72 static inline const char *
  73 eal_hugepage_info_path(void)
  74 {
  75         static char buffer[PATH_MAX]; /* static so auto-zeroed */
  76         const char *directory = default_config_dir;
  77         const char *home_dir = getenv("HOME");
  78
  79         if (getuid() != 0 && home_dir != NULL)
  80                 directory = home_dir;
  81         rte_snprintf(buffer, sizeof(buffer) - 1, HUGEPAGE_INFO_FMT, directory,
  82                         internal_config.hugefile_prefix);
  83         return buffer;
  84 }
  85
  86 /** String format for hugepage map files. */
  87 #define HUGEFILE_FMT "%s/%smap_%d"
  88
  89 static inline const char *
  90 eal_get_hugefile_path(char *buffer, size_t buflen, const char *hugedir, int f_id)
  91 {
  92         rte_snprintf(buffer, buflen, HUGEFILE_FMT, hugedir,
  93                         internal_config.hugefile_prefix, f_id);
  94         buffer[buflen - 1] = '\0';
  95         return buffer;
  96 }
  97
  98 /** define the default filename prefix for the %s values above */
  99 #define HUGEFILE_PREFIX_DEFAULT "rte"
 100
 101 /** Function to read a single numeric value from a file on the filesystem.
 102  * Used to read information from files on /sys */
 103 int eal_parse_sysfs_value(const char *filename, unsigned long *val);
 104
 105 #endif /* _EAL_LINUXAPP_FILESYSTEM_H */