lib/librte_eal/common/eal_filesystem.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2018 Intel Corporation
   3  */
   4
   5 /**
   6  * @file
   7  * Stores functions and path defines for files and directories
   8  * on the filesystem for Linux, that are used by the Linux EAL.
   9  */
  10
  11 #ifndef EAL_FILESYSTEM_H
  12 #define EAL_FILESYSTEM_H
  13
  14 /** Path of rte config file. */
  15
  16 #include <stdint.h>
  17 #include <limits.h>
  18 #include <unistd.h>
  19 #include <stdlib.h>
  20
  21 #include <rte_string_fns.h>
  22 #include "eal_internal_cfg.h"
  23
  24 /* sets up platform-specific runtime data dir */
  25 int
  26 eal_create_runtime_dir(void);
  27
  28 #define RUNTIME_CONFIG_FNAME "config"
  29 static inline const char *
  30 eal_runtime_config_path(void)
  31 {
  32         static char buffer[PATH_MAX]; /* static so auto-zeroed */
  33
  34         snprintf(buffer, sizeof(buffer) - 1, "%s/%s", rte_eal_get_runtime_dir(),
  35                         RUNTIME_CONFIG_FNAME);
  36         return buffer;
  37 }
  38
  39 /** Path of primary/secondary communication unix socket file. */
  40 #define MP_SOCKET_FNAME "mp_socket"
  41 static inline const char *
  42 eal_mp_socket_path(void)
  43 {
  44         static char buffer[PATH_MAX]; /* static so auto-zeroed */
  45
  46         snprintf(buffer, sizeof(buffer) - 1, "%s/%s", rte_eal_get_runtime_dir(),
  47                         MP_SOCKET_FNAME);
  48         return buffer;
  49 }
  50
  51 #define FBARRAY_NAME_FMT "%s/fbarray_%s"
  52 static inline const char *
  53 eal_get_fbarray_path(char *buffer, size_t buflen, const char *name) {
  54         snprintf(buffer, buflen, FBARRAY_NAME_FMT, rte_eal_get_runtime_dir(),
  55                         name);
  56         return buffer;
  57 }
  58
  59 /** Path of hugepage info file. */
  60 #define HUGEPAGE_INFO_FNAME "hugepage_info"
  61 static inline const char *
  62 eal_hugepage_info_path(void)
  63 {
  64         static char buffer[PATH_MAX]; /* static so auto-zeroed */
  65
  66         snprintf(buffer, sizeof(buffer) - 1, "%s/%s", rte_eal_get_runtime_dir(),
  67                         HUGEPAGE_INFO_FNAME);
  68         return buffer;
  69 }
  70
  71 /** Path of hugepage data file. */
  72 #define HUGEPAGE_DATA_FNAME "hugepage_data"
  73 static inline const char *
  74 eal_hugepage_data_path(void)
  75 {
  76         static char buffer[PATH_MAX]; /* static so auto-zeroed */
  77
  78         snprintf(buffer, sizeof(buffer) - 1, "%s/%s", rte_eal_get_runtime_dir(),
  79                         HUGEPAGE_DATA_FNAME);
  80         return buffer;
  81 }
  82
  83 /** String format for hugepage map files. */
  84 #define HUGEFILE_FMT "%s/%smap_%d"
  85 static inline const char *
  86 eal_get_hugefile_path(char *buffer, size_t buflen, const char *hugedir, int f_id)
  87 {
  88         snprintf(buffer, buflen, HUGEFILE_FMT, hugedir,
  89                         internal_config.hugefile_prefix, f_id);
  90         buffer[buflen - 1] = '\0';
  91         return buffer;
  92 }
  93
  94 /** String format for hugepage map lock files. */
  95 #define HUGEFILE_LOCK_FMT "%s/map_%d.lock"
  96 static inline const char *
  97 eal_get_hugefile_lock_path(char *buffer, size_t buflen, int f_id)
  98 {
  99         snprintf(buffer, buflen, HUGEFILE_LOCK_FMT, rte_eal_get_runtime_dir(),
 100                         f_id);
 101         buffer[buflen - 1] = '\0';
 102         return buffer;
 103 }
 104
 105 /** define the default filename prefix for the %s values above */
 106 #define HUGEFILE_PREFIX_DEFAULT "rte"
 107
 108 /** Function to read a single numeric value from a file on the filesystem.
 109  * Used to read information from files on /sys */
 110 int eal_parse_sysfs_value(const char *filename, unsigned long *val);
 111
 112 #endif /* EAL_FILESYSTEM_H */