mirror of
https://github.com/mirror/make.git
synced 2026-09-01 04:08:10 +08:00
4da2055a10
Some POSIX systems do not allow locks to be taken on non-files, such as pipes. This is a problem since very often make is invoked with its stdout redirected to a pipe. Also, if stdout is redirected to a file that already has a lock on it for some other reason (perhaps a shared file such as /dev/null) it can cause a hang. This means our previous method of locking stdout, although it had some nice advantages, is not portable enough. Instead, use a temporary file and take the lock on that. We pass the name of the file to child make processes. On Windows we continue to use a shared mutex for output sync. Remove POSIX emulation functions like fcntl from Windows; instead follow the lead of the jobserver and create an interface in os.h for output sync, and move the OS-specific content to posixos.c and w32os.c. * NEWS: Add a note. * src/makeint.h (ALL_SET): Check that all bits are set. * src/os.h: Add bits for checking the state of stdin/stdout/stderr. Add prototypes for OS-specific output sync methods. * src/posixos.c (check_io_state): Determine the status of stdin, stdout, stderr an return a suite of bits describing them. (osync_enabled): If the global variable holding the FD of the lock file (osync_handle) is valid return true. (osync_setup): Create a temporary file and remember its name in a global variable (osync_tmpfile), and set osync_handle. (osync_get_mutex): If output sync is enabled, return the filename of the lock file prefixed with "fnm:" to denote a filename. (osync_parse_mutex): If the provided filename has the wrong format disable output sync. Else open the lock file and set osync_handle. (osync_clear): Close osync_handle. If we're the parent make, then also unlink the temporary file. (osync_acquire): Take a lock on the osync_handle descriptor. (osync_release): Release the lock on the osync_handle descriptor. (fd_set_append): Add APPEND mode to a file descriptor. * src/w32/w32os.c: Perform the same actions as posixos.c, copying the details from src/w32/compat/posixfcn.c. Use a mutex rather than locking a temporary file. * src/output.h: Remove all the OS-specific content. * src/output.c: Remove all the OS-specific content. (set_append_mode): Remove and replace with fd_set_append(). (sync_init): Remove and replace with check_io_state(). (acquire_semaphore): Remove and replace with osync_acquire(). (release_semaphore): Remove and replace with osync_release(). (setup_tmpfile): If the IO state is not obtained, get it. If stdout and/or stderr are valid, set up a tempfile to capture them. (output_init): Set io_state if not set already, and check it when deciding whether to close stdout on exit. * src/main.c (main): If we're syncing, set up the mutex using the new osync_setup() / osync_parse_mutex() methods. (prepare_mutex_handl_string): Replace with osync_parse_mutex(). (die): Call osync_clear(). * src/w32/compat/posixfcn.c: Remove implementations of fcntl(), record_sync_mutex(), create_mutex(), and same_stream().
160 lines
5.2 KiB
C
160 lines
5.2 KiB
C
/* Declarations for operating system interfaces for GNU Make.
|
|
Copyright (C) 2016-2022 Free Software Foundation, Inc.
|
|
This file is part of GNU Make.
|
|
|
|
GNU Make is free software; you can redistribute it and/or modify it under the
|
|
terms of the GNU General Public License as published by the Free Software
|
|
Foundation; either version 3 of the License, or (at your option) any later
|
|
version.
|
|
|
|
GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with
|
|
this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
|
|
|
#define IO_UNKNOWN 0x0001
|
|
#define IO_COMBINED_OUTERR 0x0002
|
|
#define IO_STDIN_OK 0x0004
|
|
#define IO_STDOUT_OK 0x0008
|
|
#define IO_STDERR_OK 0x0010
|
|
|
|
#if defined(VMS) || defined(_AMIGA) || defined(__MSDOS__)
|
|
# define check_io_state() (IO_STDIN_OK|IO_STDOUT_OK|IO_STDERR_OK)
|
|
# define fd_inherit(_i) (0)
|
|
# define fd_noinherit(_i) (0)
|
|
# define fd_set_append(_i) (void)(0)
|
|
#else
|
|
|
|
/* Determine the state of stdin/stdout/stderr. */
|
|
unsigned int check_io_state ();
|
|
|
|
/* Set a file descriptor to close/not close in a subprocess. */
|
|
void fd_inherit (int);
|
|
void fd_noinherit (int);
|
|
|
|
/* If the file descriptor is for a file put it into append mode. */
|
|
void fd_set_append (int);
|
|
#endif
|
|
|
|
/* Return a file descriptor for a new anonymous temp file, or -1. */
|
|
#if defined(WINDOWS32)
|
|
int os_anontmp ();
|
|
#else
|
|
# define os_anontmp() (-1)
|
|
#endif
|
|
|
|
/* This section provides OS-specific functions to support the jobserver. */
|
|
|
|
#ifdef MAKE_JOBSERVER
|
|
|
|
/* Returns 1 if the jobserver is enabled, else 0. */
|
|
unsigned int jobserver_enabled ();
|
|
|
|
/* Called in the parent make to set up the jobserver initially. */
|
|
unsigned int jobserver_setup (int job_slots, const char *style);
|
|
|
|
/* Called in a child instance to connect to the jobserver.
|
|
Return 1 if we got a valid auth, else 0. */
|
|
unsigned int jobserver_parse_auth (const char* auth);
|
|
|
|
/* Returns an allocated buffer used to pass to child instances. */
|
|
char *jobserver_get_auth ();
|
|
|
|
/* Returns a pointer to a static string used to indicate that the child
|
|
cannot access the jobserver, or NULL if it always can. */
|
|
const char *jobserver_get_invalid_auth ();
|
|
|
|
/* Clear this instance's jobserver configuration. */
|
|
void jobserver_clear ();
|
|
|
|
/* Recover all the jobserver tokens and return the number we got. */
|
|
unsigned int jobserver_acquire_all ();
|
|
|
|
/* Release a jobserver token. If it fails and is_fatal is 1, fatal. */
|
|
void jobserver_release (int is_fatal);
|
|
|
|
/* Notify the jobserver that a child exited. */
|
|
void jobserver_signal ();
|
|
|
|
/* Get ready to start a non-recursive child. */
|
|
void jobserver_pre_child (int);
|
|
|
|
/* Complete starting a non-recursive child. */
|
|
void jobserver_post_child (int);
|
|
|
|
/* Set up to acquire a new token. */
|
|
void jobserver_pre_acquire ();
|
|
|
|
/* Wait until we can acquire a jobserver token.
|
|
TIMEOUT is 1 if we have other jobs waiting for the load to go down;
|
|
in this case we won't wait forever, so we can check the load.
|
|
Returns 1 if we got a token, or 0 if we stopped waiting due to a child
|
|
exiting or a timeout. */
|
|
unsigned int jobserver_acquire (int timeout);
|
|
|
|
#else
|
|
|
|
#define jobserver_enabled() (0)
|
|
#define jobserver_setup(_slots, _style) (0)
|
|
#define jobserver_parse_auth(_auth) (0)
|
|
#define jobserver_get_auth() (NULL)
|
|
#define jobserver_get_invalid_auth() (NULL)
|
|
#define jobserver_clear() (void)(0)
|
|
#define jobserver_release(_fatal) (void)(0)
|
|
#define jobserver_acquire_all() (0)
|
|
#define jobserver_signal() (void)(0)
|
|
#define jobserver_pre_child(_r) (void)(0)
|
|
#define jobserver_post_child(_r) (void)(0)
|
|
#define jobserver_pre_acquire() (void)(0)
|
|
#define jobserver_acquire(_tmout) (0)
|
|
|
|
#endif /* MAKE_JOBSERVER */
|
|
|
|
#ifndef NO_OUTPUT_SYNC
|
|
|
|
/* Returns 1 if output sync is enabled, else 0. */
|
|
unsigned int osync_enabled ();
|
|
|
|
/* Called in the parent make to set up output sync initially. */
|
|
void osync_setup ();
|
|
|
|
/* Returns an allocated buffer containing output sync info to pass to child
|
|
instances, or NULL if not needed. */
|
|
char *osync_get_mutex ();
|
|
|
|
/* Called in a child instance to obtain info on the output sync mutex.
|
|
Return 1 if we got a valid mutex, else 0. */
|
|
unsigned int osync_parse_mutex (const char *mutex);
|
|
|
|
/* Clean up this instance's output sync facilities. */
|
|
void osync_clear ();
|
|
|
|
/* Acquire the output sync lock. This will wait until available.
|
|
Returns 0 if there was an error getting the semaphore. */
|
|
unsigned int osync_acquire ();
|
|
|
|
/* Release the output sync lock. */
|
|
void osync_release ();
|
|
|
|
#else
|
|
|
|
#define osync_enabled() (0)
|
|
#define osync_setup() (void)(0)
|
|
#define osync_get_mutex() (0)
|
|
#define osync_parse_mutex(_s) (0)
|
|
#define osync_clear() (void)(0)
|
|
#define osync_acquire() (1)
|
|
#define osync_release() (void)(0)
|
|
|
|
#endif /* NO_OUTPUT_SYNC */
|
|
|
|
/* Create a "bad" file descriptor for stdin when parallel jobs are run. */
|
|
#if defined(VMS) || defined(WINDOWS32) || defined(_AMIGA) || defined(__MSDOS__)
|
|
# define get_bad_stdin() (-1)
|
|
#else
|
|
int get_bad_stdin ();
|
|
#endif
|