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