Branch data Line data Source code
1 : : /* Utility to update paths from internal to external forms.
2 : : Copyright (C) 1997-2024 Free Software Foundation, Inc.
3 : :
4 : : This file is part of GCC.
5 : :
6 : : GCC is free software; you can redistribute it and/or modify it under
7 : : the terms of the GNU Library General Public License as published by
8 : : the Free Software Foundation; either version 3 of the License, or (at
9 : : your option) any later version.
10 : :
11 : : GCC is distributed in the hope that it will be useful,
12 : : but WITHOUT ANY WARRANTY; without even the implied warranty of
13 : : MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 : : Library General Public License for more details.
15 : :
16 : : You should have received a copy of the GNU Library General Public
17 : : License along with GCC; see the file COPYING3. If not see
18 : : <http://www.gnu.org/licenses/>. */
19 : :
20 : : /* This file contains routines to update a path, both to canonicalize
21 : : the directory format and to handle any prefix translation.
22 : :
23 : : This file must be compiled with -DPREFIX= to specify the "prefix"
24 : : value used by configure. If a filename does not begin with this
25 : : prefix, it will not be affected other than by directory canonicalization.
26 : :
27 : : Each caller of 'update_path' may specify both a filename and
28 : : a translation prefix and consist of the name of the package that contains
29 : : the file ("@GCC", "@BINUTIL", "@GNU", etc).
30 : :
31 : : If the prefix is not specified, the filename will only undergo
32 : : directory canonicalization.
33 : :
34 : : If it is specified, the string given by PREFIX will be replaced
35 : : by the specified prefix (with a '@' in front unless the prefix begins
36 : : with a '$') and further translation will be done as follows
37 : : until none of the two conditions below are met:
38 : :
39 : : 1) If the filename begins with '@', the string between the '@' and
40 : : the end of the name or the first '/' or directory separator will
41 : : be considered a "key" and looked up as follows:
42 : :
43 : : -- If this is a Win32 OS, then the Registry will be examined for
44 : : an entry of "key" in
45 : :
46 : : HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\<KEY>
47 : :
48 : : if found, that value will be used. <KEY> defaults to GCC version
49 : : string, but can be overridden at configuration time.
50 : :
51 : : -- If not found (or not a Win32 OS), the environment variable
52 : : key_ROOT (the value of "key" concatenated with the constant "_ROOT")
53 : : is tried. If that fails, then PREFIX (see above) is used.
54 : :
55 : : 2) If the filename begins with a '$', the rest of the string up
56 : : to the end or the first '/' or directory separator will be used
57 : : as an environment variable, whose value will be returned.
58 : :
59 : : Once all this is done, any '/' will be converted to DIR_SEPARATOR,
60 : : if they are different.
61 : :
62 : : NOTE: using resolve_keyed_path under Win32 requires linking with
63 : : advapi32.dll. */
64 : :
65 : :
66 : : #include "config.h"
67 : : #include "system.h"
68 : : #include "coretypes.h"
69 : : #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
70 : : #define WIN32_LEAN_AND_MEAN
71 : : #include <windows.h>
72 : : #endif
73 : : #include "prefix.h"
74 : : #include "common/common-target.h"
75 : :
76 : : static const char *std_prefix = PREFIX;
77 : :
78 : : static const char *get_key_value (char *);
79 : : static char *translate_name (char *);
80 : : static char *save_string (const char *, int);
81 : : static void tr (char *, int, int);
82 : :
83 : : #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
84 : : static char *lookup_key (char *);
85 : : static HKEY reg_key = (HKEY) INVALID_HANDLE_VALUE;
86 : : #endif
87 : :
88 : : /* Given KEY, as above, return its value. */
89 : :
90 : : static const char *
91 : 1207584 : get_key_value (char *key)
92 : : {
93 : 1207584 : const char *prefix = 0;
94 : 1207584 : char *temp = 0;
95 : :
96 : : #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
97 : : prefix = lookup_key (key);
98 : : #endif
99 : :
100 : 1207584 : if (prefix == 0)
101 : 1207584 : prefix = getenv (temp = concat (key, "_ROOT", NULL));
102 : :
103 : 1207584 : if (prefix == 0)
104 : 1207584 : prefix = std_prefix;
105 : :
106 : 1207584 : free (temp);
107 : :
108 : 1207584 : return prefix;
109 : : }
110 : :
111 : : /* Return a copy of a string that has been placed in the heap. */
112 : :
113 : : static char *
114 : 302037 : save_string (const char *s, int len)
115 : : {
116 : 302037 : char *result = XNEWVEC (char, len + 1);
117 : :
118 : 302037 : memcpy (result, s, len);
119 : 302037 : result[len] = 0;
120 : 302037 : return result;
121 : : }
122 : :
123 : : #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
124 : :
125 : : #ifndef WIN32_REGISTRY_KEY
126 : : # define WIN32_REGISTRY_KEY BASEVER
127 : : #endif
128 : :
129 : : /* Look up "key" in the registry, as above. */
130 : :
131 : : static char *
132 : : lookup_key (char *key)
133 : : {
134 : : char *dst;
135 : : DWORD size;
136 : : DWORD type;
137 : : LONG res;
138 : :
139 : : if (reg_key == (HKEY) INVALID_HANDLE_VALUE)
140 : : {
141 : : res = RegOpenKeyExA (HKEY_LOCAL_MACHINE, "SOFTWARE", 0,
142 : : KEY_READ, ®_key);
143 : :
144 : : if (res == ERROR_SUCCESS)
145 : : res = RegOpenKeyExA (reg_key, "Free Software Foundation", 0,
146 : : KEY_READ, ®_key);
147 : :
148 : : if (res == ERROR_SUCCESS)
149 : : res = RegOpenKeyExA (reg_key, WIN32_REGISTRY_KEY, 0,
150 : : KEY_READ, ®_key);
151 : :
152 : : if (res != ERROR_SUCCESS)
153 : : {
154 : : reg_key = (HKEY) INVALID_HANDLE_VALUE;
155 : : return 0;
156 : : }
157 : : }
158 : :
159 : : size = 32;
160 : : dst = XNEWVEC (char, size);
161 : :
162 : : res = RegQueryValueExA (reg_key, key, 0, &type, (LPBYTE) dst, &size);
163 : : if (res == ERROR_MORE_DATA && type == REG_SZ)
164 : : {
165 : : dst = XRESIZEVEC (char, dst, size);
166 : : res = RegQueryValueExA (reg_key, key, 0, &type, (LPBYTE) dst, &size);
167 : : }
168 : :
169 : : if (type != REG_SZ || res != ERROR_SUCCESS)
170 : : {
171 : : free (dst);
172 : : dst = 0;
173 : : }
174 : :
175 : : return dst;
176 : : }
177 : : #endif
178 : :
179 : : /* If NAME, a malloc-ed string, starts with a '@' or '$', apply the
180 : : translation rules above and return a newly malloc-ed name.
181 : : Otherwise, return the given name. */
182 : :
183 : : static char *
184 : 1207584 : translate_name (char *name)
185 : : {
186 : 2415168 : char code;
187 : 2415168 : char *key, *old_name;
188 : 2415168 : const char *prefix;
189 : 2415168 : int keylen;
190 : :
191 : 3622752 : for (;;)
192 : : {
193 : 2415168 : code = name[0];
194 : 2415168 : if (code != '@' && code != '$')
195 : : break;
196 : :
197 : 6640302 : for (keylen = 0;
198 : 7847886 : (name[keylen + 1] != 0 && !IS_DIR_SEPARATOR (name[keylen + 1]));
199 : : keylen++)
200 : : ;
201 : :
202 : 1207584 : key = (char *) alloca (keylen + 1);
203 : 1207584 : memcpy (key, &name[1], keylen);
204 : 1207584 : key[keylen] = 0;
205 : :
206 : 1207584 : if (code == '@')
207 : : {
208 : 1207584 : prefix = get_key_value (key);
209 : 1207584 : if (prefix == 0)
210 : 0 : prefix = std_prefix;
211 : : }
212 : : else
213 : 0 : prefix = getenv (key);
214 : :
215 : 0 : if (prefix == 0)
216 : 0 : prefix = PREFIX;
217 : :
218 : : /* We used to strip trailing DIR_SEPARATORs here, but that can
219 : : sometimes yield a result with no separator when one was coded
220 : : and intended by the user, causing two path components to run
221 : : together. */
222 : :
223 : 1207584 : old_name = name;
224 : 1207584 : name = concat (prefix, &name[keylen + 1], NULL);
225 : 1207584 : free (old_name);
226 : : }
227 : :
228 : 1207584 : return name;
229 : : }
230 : :
231 : : /* In a NUL-terminated STRING, replace character C1 with C2 in-place. */
232 : : static void
233 : 0 : tr (char *string, int c1, int c2)
234 : : {
235 : 0 : do
236 : : {
237 : 0 : if (*string == c1)
238 : 0 : *string = c2;
239 : : }
240 : 0 : while (*string++);
241 : 0 : }
242 : :
243 : : /* Update PATH using KEY if PATH starts with PREFIX as a directory.
244 : : The returned string is always malloc-ed, and the caller is
245 : : responsible for freeing it. */
246 : :
247 : : char *
248 : 5544954 : update_path (const char *path, const char *key)
249 : : {
250 : 5544954 : char *result, *p;
251 : 5544954 : const int len = strlen (std_prefix);
252 : :
253 : 5544954 : if (! filename_ncmp (path, std_prefix, len)
254 : 2063662 : && (IS_DIR_SEPARATOR (path[len])
255 : 0 : || path[len] == '\0')
256 : 7608616 : && key != 0)
257 : : {
258 : 1207584 : bool free_key = false;
259 : :
260 : 1207584 : if (key[0] != '$')
261 : : {
262 : 1207584 : key = concat ("@", key, NULL);
263 : 1207584 : free_key = true;
264 : : }
265 : :
266 : 1207584 : result = concat (key, &path[len], NULL);
267 : 1207584 : if (free_key)
268 : 1207584 : free (CONST_CAST (char *, key));
269 : 1207584 : result = translate_name (result);
270 : : }
271 : : else
272 : 4337370 : result = xstrdup (path);
273 : :
274 : 5544954 : p = result;
275 : 10467436 : while (1)
276 : : {
277 : 10467436 : char *src, *dest;
278 : :
279 : 10467436 : p = strchr (p, '.');
280 : 10467436 : if (p == NULL)
281 : : break;
282 : : /* Look for `/../' */
283 : 6212722 : if (p[1] == '.'
284 : 3843798 : && IS_DIR_SEPARATOR (p[2])
285 : 3843798 : && (p != result && IS_DIR_SEPARATOR (p[-1])))
286 : : {
287 : 3843798 : *p = 0;
288 : 3843798 : if (!targetm_common.always_strip_dotdot
289 : 3843798 : && access (result, X_OK) == 0)
290 : : {
291 : 1290240 : *p = '.';
292 : 1290240 : break;
293 : : }
294 : : else
295 : : {
296 : : /* We can't access the dir, so we won't be able to
297 : : access dir/.. either. Strip out `dir/../'. If `dir'
298 : : turns out to be `.', strip one more path component. */
299 : : dest = p;
300 : 2553558 : do
301 : : {
302 : 2553558 : --dest;
303 : 5107116 : while (dest != result && IS_DIR_SEPARATOR (*dest))
304 : 2553558 : --dest;
305 : 23833208 : while (dest != result && !IS_DIR_SEPARATOR (dest[-1]))
306 : 21279650 : --dest;
307 : : }
308 : 2553558 : while (dest != result && *dest == '.');
309 : : /* If we have something like `./..' or `/..', don't
310 : : strip anything more. */
311 : 2553558 : if (*dest == '.' || IS_DIR_SEPARATOR (*dest))
312 : : {
313 : 0 : *p = '.';
314 : 0 : break;
315 : : }
316 : 2553558 : src = p + 3;
317 : 2553558 : while (IS_DIR_SEPARATOR (*src))
318 : 0 : ++src;
319 : 58127520 : p = dest;
320 : 58127520 : while ((*dest++ = *src++) != 0)
321 : : ;
322 : : }
323 : : }
324 : : else
325 : 2368924 : ++p;
326 : : }
327 : :
328 : : #ifdef UPDATE_PATH_HOST_CANONICALIZE
329 : : /* Perform host dependent canonicalization when needed. */
330 : : UPDATE_PATH_HOST_CANONICALIZE (result);
331 : : #endif
332 : :
333 : : #ifdef DIR_SEPARATOR_2
334 : : /* Convert DIR_SEPARATOR_2 to DIR_SEPARATOR. */
335 : : if (DIR_SEPARATOR_2 != DIR_SEPARATOR)
336 : : tr (result, DIR_SEPARATOR_2, DIR_SEPARATOR);
337 : : #endif
338 : :
339 : : #if defined (DIR_SEPARATOR) && !defined (DIR_SEPARATOR_2)
340 : 5544954 : if (DIR_SEPARATOR != '/')
341 : : tr (result, '/', DIR_SEPARATOR);
342 : : #endif
343 : :
344 : 5544954 : return result;
345 : : }
346 : :
347 : : /* Reset the standard prefix. */
348 : : void
349 : 302037 : set_std_prefix (const char *prefix, int len)
350 : : {
351 : 302037 : std_prefix = save_string (prefix, len);
352 : 302037 : }
|
