xref: /illumos-gate/usr/src/cmd/make/bin/pmake.cc (revision 3ba944265c4ae1fcf23ef758537c2e4f4feec16e)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 
27 /*
28  * Included files
29  */
30 #include <arpa/inet.h>
31 #include <mk/defs.h>
32 #include <mksh/misc.h>
33 #include <netdb.h>
34 #include <netinet/in.h>
35 #include <sys/socket.h>
36 #include <sys/stat.h>
37 #include <sys/types.h>
38 #include <sys/utsname.h>
39 #include <rpc/rpc.h>		/* host2netname(), netname2host() */
40 #include <libintl.h>
41 
42 /*
43  * Defined macros
44  */
45 
46 /*
47  * typedefs & structs
48  */
49 
50 /*
51  * Static variables
52  */
53 
54 /*
55  * File table of contents
56  */
57 static int		get_max(wchar_t **ms_address, wchar_t *hostname);
58 static Boolean		pskip_comment(wchar_t **cp_address);
59 static void		pskip_till_next_word(wchar_t **cp);
60 static Boolean		pskip_white_space(wchar_t **cp_address);
61 
62 
63 /*
64  *	read_make_machines(Name make_machines_name)
65  *
66  *	For backwards compatibility w/ PMake 1.x, when DMake 2.x is
67  *	being run in parallel mode, DMake should parse the PMake startup
68  *	file $(HOME)/.make.machines to get the PMake max jobs.
69  *
70  *	Return value:
71  *		int of PMake max jobs
72  *
73  *	Parameters:
74  *		make_machines_name	Name of .make.machines file
75  *
76  */
77 int
78 read_make_machines(Name make_machines_name)
79 {
80 	wchar_t 		c;
81 	Boolean			default_make_machines;
82 	struct hostent		*hp;
83 	wchar_t			local_host[MAX_HOSTNAMELEN + 1];
84 	char			local_host_mb[MAX_HOSTNAMELEN + 1] = "";
85 	int			local_host_wslen;
86 	wchar_t			full_host[MAXNETNAMELEN + 1];
87 	int			full_host_wslen = 0;
88 	char			*homedir;
89 	Name			MAKE_MACHINES;
90 	struct stat		make_machines_buf;
91 	FILE			*make_machines_file;
92 	wchar_t			*make_machines_list = NULL;
93 	char			*make_machines_list_mb = NULL;
94 	wchar_t			make_machines_path[MAXPATHLEN];
95 	char			mb_make_machines_path[MAXPATHLEN];
96 	wchar_t			*mp;
97 	wchar_t			*ms;
98 	int			pmake_max_jobs = 0;
99 	struct utsname		uts_info;
100 
101 
102 	MBSTOWCS(wcs_buffer, "MAKE_MACHINES");
103 	MAKE_MACHINES = GETNAME(wcs_buffer, FIND_LENGTH);
104 	/* Did the user specify a .make.machines file on the command line? */
105 	default_make_machines = false;
106 	if (make_machines_name == NULL) {
107 		/* Try reading the default .make.machines file, in $(HOME). */
108 		homedir = getenv("HOME");
109 		if ((homedir != NULL) && (strlen(homedir) < (sizeof(mb_make_machines_path) - 16))) {
110 			sprintf(mb_make_machines_path,
111 			 "%s/.make.machines", homedir);
112 			MBSTOWCS(make_machines_path, mb_make_machines_path);
113 			make_machines_name = GETNAME(make_machines_path, FIND_LENGTH);
114 			default_make_machines = true;
115 		}
116 		if (make_machines_name == NULL) {
117 			/*
118 			 * No $(HOME)/.make.machines file.
119 			 * Return 0 for PMake max jobs.
120 			 */
121 			return(0);
122 		}
123 	}
124 /*
125 	make_machines_list_mb = getenv(MAKE_MACHINES->string_mb);
126  */
127 	/* Open the .make.machines file. */
128 	if ((make_machines_file = fopen(make_machines_name->string_mb, "r")) == NULL) {
129 		if (!default_make_machines) {
130 			/* Error opening .make.machines file. */
131 			fatal(gettext("Open of %s failed: %s"),
132 			      make_machines_name->string_mb,
133 			      errmsg(errno));
134 		} else {
135 			/*
136 			 * No $(HOME)/.make.machines file.
137 			 * Return 0 for PMake max jobs.
138 			 */
139 			return(0);
140 		}
141 	/* Stat the .make.machines file to get the size of the file.  */
142 	} else if (fstat(fileno(make_machines_file), &make_machines_buf) < 0) {
143 		/* Error stat'ing .make.machines file. */
144 		fatal(gettext("Stat of %s failed: %s"),
145 		      make_machines_name->string_mb,
146 		      errmsg(errno));
147 	} else {
148 		/* Allocate memory for "MAKE_MACHINES=<contents of .m.m>" */
149 		make_machines_list_mb =
150 		  (char *) getmem((int) (strlen(MAKE_MACHINES->string_mb) +
151 		                         2 +
152 		                         make_machines_buf.st_size));
153 		sprintf(make_machines_list_mb,
154 			"%s=",
155 			MAKE_MACHINES->string_mb);
156 		/* Read in the .make.machines file. */
157 		if (fread(make_machines_list_mb + strlen(MAKE_MACHINES->string_mb) + 1,
158 			  sizeof(char),
159 			  (int) make_machines_buf.st_size,
160 			  make_machines_file) != make_machines_buf.st_size) {
161 			/*
162 			 * Error reading .make.machines file.
163 			 * Return 0 for PMake max jobs.
164 			 */
165 			warning(gettext("Unable to read %s"),
166 				make_machines_name->string_mb);
167 			(void) fclose(make_machines_file);
168 			retmem_mb((caddr_t) make_machines_list_mb);
169 			return(0);
170 		} else {
171 			(void) fclose(make_machines_file);
172 			/* putenv "MAKE_MACHINES=<contents of .m.m>" */
173 			*(make_machines_list_mb +
174 			  strlen(MAKE_MACHINES->string_mb) +
175 			  1 +
176 			  make_machines_buf.st_size) = (int) nul_char;
177 			if (putenv(make_machines_list_mb) != 0) {
178 				warning(gettext("Couldn't put contents of %s in environment"),
179 					make_machines_name->string_mb);
180 			} else {
181 				make_machines_list_mb += strlen(MAKE_MACHINES->string_mb) + 1;
182 				make_machines_list = ALLOC_WC(strlen(make_machines_list_mb) + 1);
183 				(void) mbstowcs(make_machines_list,
184 				                make_machines_list_mb,
185 				                (strlen(make_machines_list_mb) + 1));
186 			}
187 		}
188 	}
189 
190 	uname(&uts_info);
191 	strcpy(local_host_mb, &uts_info.nodename[0]);
192 	MBSTOWCS(local_host, local_host_mb);
193 	local_host_wslen = wcslen(local_host);
194 
195 	// There is no getdomainname() function on Solaris.
196 	// And netname2host() function does not work on Linux.
197 	// So we have to use different APIs.
198 	if (host2netname(mbs_buffer, NULL, NULL) &&
199 	    netname2host(mbs_buffer, mbs_buffer2, MAXNETNAMELEN+1)) {
200 		MBSTOWCS(full_host, mbs_buffer2);
201 		full_host_wslen = wcslen(full_host);
202 	}
203 
204 	for (ms = make_machines_list;
205 	     (ms) && (*ms );
206 	     ) {
207 		/*
208 		 * Skip white space and comments till you reach
209 		 * a machine name.
210 		 */
211 		pskip_till_next_word(&ms);
212 
213 		/*
214 		 * If we haven't reached the end of file, process the
215 		 * machine name.
216 		 */
217 		if (*ms) {
218 			/*
219 			 * If invalid machine name decrement counter
220 			 * and skip line.
221 			 */
222 			mp = ms;
223 			SKIPWORD(ms);
224 			c = *ms;
225 			*ms++ = '\0'; /* Append null to machine name. */
226 			/*
227 			 * If this was the beginning of a comment
228 			 * (we overwrote a # sign) and it's not
229 			 * end of line yet, shift the # sign.
230 			 */
231 			if ((c == '#') && (*ms != '\n') && (*ms)) {
232 				*ms = '#';
233 			}
234 			WCSTOMBS(mbs_buffer, mp);
235 			/*
236 			 * Print "Ignoring unknown host" if:
237 			 * 1) hostname is longer than MAX_HOSTNAMELEN, or
238 			 * 2) hostname is unknown
239 			 */
240 			if ((wcslen(mp) > MAX_HOSTNAMELEN) ||
241 			    ((hp = gethostbyname(mbs_buffer)) == NULL)) {
242 				warning(gettext("Ignoring unknown host %s"),
243 					mbs_buffer);
244 				SKIPTOEND(ms);
245 				/* Increment ptr if not end of file. */
246 				if (*ms) {
247 					ms++;
248 				}
249 			} else {
250 				/* Compare current hostname with local_host. */
251 				if (wcslen(mp) == local_host_wslen &&
252 				    IS_WEQUALN(mp, local_host, local_host_wslen)) {
253 					/*
254 					 * Bingo, local_host is in .make.machines.
255 					 * Continue reading.
256 					 */
257 					pmake_max_jobs = PMAKE_DEF_MAX_JOBS;
258 				/* Compare current hostname with full_host. */
259 				} else if (wcslen(mp) == full_host_wslen &&
260 					   IS_WEQUALN(mp, full_host, full_host_wslen)) {
261 					/*
262 					 * Bingo, full_host is in .make.machines.
263 					 * Continue reading.
264 					 */
265 					pmake_max_jobs = PMAKE_DEF_MAX_JOBS;
266 				} else {
267 					if (c != '\n') {
268 					    SKIPTOEND(ms);
269 					    if (*ms) {
270 						ms++;
271 					    }
272 					}
273 					continue;
274 				}
275 				/* If we get here, local_host is in .make.machines. */
276 				if (c != '\n')  {
277 					/* Now look for keyword 'max'. */
278 					MBSTOWCS(wcs_buffer, "max");
279 					SKIPSPACE(ms);
280 					while ((*ms != '\n') && (*ms)) {
281 						if (*ms == '#') {
282 							pskip_comment(&ms);
283 						} else if (IS_WEQUALN(ms, wcs_buffer, 3)) {
284 							/* Skip "max". */
285 							ms += 3;
286 							pmake_max_jobs = get_max(&ms, mp);
287 							SKIPSPACE(ms);
288 						} else {
289 							warning(gettext("unknown option for host %s"), mbs_buffer);
290 							SKIPTOEND(ms);
291 							break;
292 						}
293 					}
294 				}
295 				break; /* out of outermost for() loop. */
296 			}
297 		}
298 	}
299 	retmem(make_machines_list);
300 	return(pmake_max_jobs);
301 }
302 
303 /*
304  *	pskip_till_next_word(cp)
305  *
306  *	Parameters:
307  *		cp		the address of the string pointer.
308  *
309  *	On return:
310  *		cp		points to beginning of machine name.
311  *
312  */
313 static void
314 pskip_till_next_word(wchar_t **cp)
315 {
316 	/*
317 	 * Keep recursing until all combinations of white spaces
318 	 * and comments have been skipped.
319 	 */
320 	if (pskip_white_space(cp) || pskip_comment(cp)) {
321 		pskip_till_next_word(cp);
322 	}
323 }
324 
325 /*
326  *	pskip_white_space(cp_address)
327  *
328  *	Advances the string pointer so that it points to the first
329  *	non white character (space/tab/linefeed).
330  *
331  *	Parameters:
332  *		cp_address	the address of the string pointer.
333  *
334  *	Return Value:
335  *				True if the pointer was changed.
336  *
337  */
338 static Boolean
339 pskip_white_space(wchar_t **cp_address)
340 {
341 	wchar_t		*cp = *cp_address;
342 
343 	while (*cp && iswspace(*cp)) {
344 		cp++;
345 	}
346 	/* Have we skipped any characters? */
347 	if (cp != *cp_address) {
348 		*cp_address = cp;
349 		return(true);
350 	} else {
351 		return(false);
352 	}
353 }
354 
355 /*
356  *	pskip_comment(cp_address)
357  *
358  *	If cp_address is pointing to '#' (the beginning of a comment),
359  *	increment the pointer till you reach end of line.
360  *
361  *	Parameters:
362  *		cp_address	the address of the string pointer.
363  *
364  *	Return Value:
365  *				True if the pointer was changed.
366  *
367  */
368 static Boolean
369 pskip_comment(wchar_t **cp_address)
370 {
371 	wchar_t		*cp = *cp_address;
372 
373 	/* Is this the beginning of a comment? Skip till end of line. */
374 	if (*cp == '#') {
375 		SKIPTOEND(cp);
376 	}
377 	/* Have we skipped a comment line? */
378 	if (cp != *cp_address)	{
379 		*cp_address = cp;
380 		return(true);
381 	} else {
382 		return(false);
383 	}
384 }
385 
386 static int
387 get_max(wchar_t **ms_address, wchar_t *hostname)
388 {
389 	wchar_t 	*ms = *ms_address;
390 	int		limit = PMAKE_DEF_MAX_JOBS; /* Default setting. */
391 
392 	WCSTOMBS(mbs_buffer, hostname);
393 	/* Look for `='. */
394 	SKIPSPACE(ms);
395 	if ((!*ms) || (*ms == '\n') || (*ms != '=')) {
396 		SKIPTOEND(ms);
397 		warning(gettext("expected `=' after max, ignoring rest of line for host %s"),
398 			mbs_buffer);
399 		*ms_address = ms;
400 		return((int) limit);
401 	} else {
402 		ms++;
403 		SKIPSPACE(ms);
404 		if ((*ms != '\n') && (*ms != '\0')) {
405 			/* We've found, hopefully, a valid "max" value. */
406 			limit = (int) wcstol(ms, &ms, 10);
407 			if (limit < 1) {
408 				limit = PMAKE_DEF_MAX_JOBS;
409 				warning(gettext("max value cannot be less than or equal to zero for host %s"), mbs_buffer);
410 			}
411 		} else {
412 			/* No "max" value after "max=". */
413 			warning(gettext("no max value specified for host %s"), mbs_buffer);
414 		}
415 		*ms_address = ms;
416 		return(limit);
417 	}
418 }
419 
420 
421