5472751e079a8979bef9907b9d3f22c372f6778e
[vpp.git] / src / vlib / unix / util.c
1 /*
2  * Copyright (c) 2016 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  * pci.c: Linux user space PCI bus management.
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39
40 #include <vlib/vlib.h>
41 #include <vlib/unix/unix.h>
42
43 #include <sys/types.h>
44 #include <sys/stat.h>
45 #include <fcntl.h>
46 #include <dirent.h>
47
48 clib_error_t *
49 foreach_directory_file (char *dir_name,
50                         clib_error_t * (*f) (void *arg, u8 * path_name,
51                                              u8 * file_name), void *arg,
52                         int scan_dirs)
53 {
54   DIR *d;
55   struct dirent *e;
56   clib_error_t *error = 0;
57   u8 *s, *t;
58
59   d = opendir (dir_name);
60   if (!d)
61     {
62       if (errno == ENOENT)
63         return 0;
64       return clib_error_return_unix (0, "open `%s'", dir_name);
65     }
66
67   s = t = 0;
68   while (1)
69     {
70       e = readdir (d);
71       if (!e)
72         break;
73       if (scan_dirs)
74         {
75           if (e->d_type == DT_DIR
76               && (!strcmp (e->d_name, ".") || !strcmp (e->d_name, "..")))
77             continue;
78         }
79       else
80         {
81           if (e->d_type == DT_DIR)
82             continue;
83         }
84
85       s = format (s, "%s/%s", dir_name, e->d_name);
86       t = format (t, "%s", e->d_name);
87       error = f (arg, s, t);
88       _vec_len (s) = 0;
89       _vec_len (t) = 0;
90
91       if (error)
92         break;
93     }
94
95   vec_free (s);
96   closedir (d);
97
98   return error;
99 }
100
101 clib_error_t *
102 vlib_unix_recursive_mkdir (char *path)
103 {
104   clib_error_t *error = 0;
105   char *c = 0;
106   int i = 0;
107
108   while (path[i] != 0)
109     {
110       if (c && path[i] == '/')
111         {
112           vec_add1 (c, 0);
113           if ((mkdir (c, 0755)) && (errno != EEXIST))
114             {
115               error = clib_error_return_unix (0, "mkdir '%s'", c);
116               goto done;
117             }
118           _vec_len (c)--;
119         }
120       vec_add1 (c, path[i]);
121       i++;
122     }
123
124   if ((mkdir (path, 0755)) && (errno != EEXIST))
125     {
126       error = clib_error_return_unix (0, "mkdir '%s'", path);
127       goto done;
128     }
129
130 done:
131   vec_free (c);
132
133   return error;
134 }
135
136 clib_error_t *
137 vlib_unix_validate_runtime_file (unix_main_t * um,
138                                  const char *path, u8 ** full_path)
139 {
140   u8 *fp = 0;
141   char *last_slash = 0;
142
143   if (path[0] == '\0')
144     {
145       return clib_error_return (0, "path is an empty string");
146     }
147   else if (strncmp (path, "../", 3) == 0 || strstr (path, "/../"))
148     {
149       return clib_error_return (0, "'..' not allowed in runtime path");
150     }
151   else if (path[0] == '/')
152     {
153       /* Absolute path. Has to start with runtime directory */
154       if (strncmp ((char *) um->runtime_dir, path,
155                    strlen ((char *) um->runtime_dir)))
156         {
157           return clib_error_return (0,
158                                     "file %s is not in runtime directory %s",
159                                     path, um->runtime_dir);
160         }
161       fp = format (0, "%s%c", path, '\0');
162     }
163   else
164     {
165       /* Relative path, just append to runtime */
166       fp = format (0, "%s/%s%c", um->runtime_dir, path, '\0');
167     }
168
169   /* We don't want to create a directory out of the last file */
170   if ((last_slash = strrchr ((char *) fp, '/')) != NULL)
171     *last_slash = '\0';
172
173   clib_error_t *error = vlib_unix_recursive_mkdir ((char *) fp);
174
175   if (last_slash != NULL)
176     *last_slash = '/';
177
178   if (error)
179     vec_free (fp);
180
181   *full_path = fp;
182   return error;
183 }
184
185 /*
186  * fd.io coding-style-patch-verification: ON
187  *
188  * Local Variables:
189  * eval: (c-set-style "gnu")
190  * End:
191  */