make/tests/scripts/functions
Paul Smith 7ad2593b2d Support implementing the jobserver using named pipes
Using anonymous pipes for jobserver support has some advantages:
for example there is nothing on disk that needs to be cleaned up.
However it has many obscure problems, related to the fact that in
order for it to work we need to ensure these resources are properly
passed through to child processes that want to use the jobserver.
At the same time we don't want to pass the pipe to process which
DON'T know about the jobserver.

Other processes can open file descriptors which we then think are
our jobserver, but aren't.  And, we open the pipe file descriptors
in blocking mode which doesn't work for all users.

See issues such as SV 57178, SV 57242, and SV 62397

To avoid these issues, use named pipes (on systems where they are
available) instead of anonoymous pipes.  This simplifies many things:
we never need to pass open file descriptors to our children; they
can open the jobserver named pipe.  We don't need to worry about
recursive vs. non-recursive children.  Users don't have to "pass
through" the resources if they are invoking sub-makes.  Each child
can open its own file descriptor and set blocking as needed.

The downside is the named pipe exists on disk and so must be cleaned
up when the "top-level" make instance exits.

In order to allow make to continue to be used in build systems where
older versions of GNU make, or other tools that want to use the
jobserver, but don't understand named pipes, introduce a new option
--jobserver-style that allows the user to choose anonymous pipes.

* NEWS: Announce the change and the --jobserver-style option.
* doc/make.1: Add --jobserver-style documentation.
* doc/make.texi (Special Variables): Add missing items to .FEATURES.
(Options Summary): Add --jobserver-style.
(POSIX Jobserver): Named pipes, changes to --jobserver-auth, and the
--jobserver-style option.
(Windows Jobserver): Document --jobserver-style for Windows.
* configure.ac: Check for mkfifo.
* src/config.h-vms.template: Undefined HAVE_MKFIFO.
* src/config.h.W32.template: Ditto.
* src/main.c: Add jobserver-style as a new command line option.
(main): Add jobserver-fifo to .FEATURES if supported.  Pass the style
option to jobserver_setup().
* src/os.h (jobserver_setup): Accept a style string option.
* src/posixos.c (enum js_type): Enumeration of the jobserver style.
(js_type): Which style we are currently using.
(fifo_name): The path to the named pipe (if in use).
(jobserver_setup): If no style is given, or "fifo" is given, set up a
named pipe: get a temporary file and use mkfifo() on it, then open it
for reading and writing.  If something fails fall back to anonymous
pipes.
(jobserver_parse_auth): Parse jobserver-auth to determine the style.
If we are using a named pipe, open it.  If we're using anonymous pipes
ensure they're valid as before.
(jobserver_get_invalid_auth): Don't invalidate the jobserver when
using named pipes.
(jobserver_clear): Clean up memory used for named pipes.
(jobserver_acquire_all): Unlink the named pipe when done.
* src/w32/w32os.c (jobserver_setup): Check the style argument.
* tests/scripts/features/jobserver: Use --jobserver-style to test
the anonymous pipe behavior, and also test named pipe/semaphore
behavior.  Check invalid jobserver-style options.
* tests/scripts/functions/shell: Use --jobserver-style to test the
anonymous pipe behavior, and also test named pipe/semaphore
behavior.
2022-08-02 23:36:35 -04:00
..
abspath Add test suite support to Windows 2017-06-04 18:37:20 -04:00
addprefix * Added the test suite to the main distribution. 1999-09-14 02:03:19 +00:00
addsuffix * Various fixes for problems in the 3.79.0.1 pretest. 2000-06-19 21:22:44 +00:00
andor - New code capability: a read-only string cache. Start of solution for 2006-02-10 05:29:00 +00:00
basename * Added the test suite to the main distribution. 1999-09-14 02:03:19 +00:00
call [SV 46995] Strip leading/trailing space from variable names 2016-03-23 01:25:51 -04:00
dir * Added the test suite to the main distribution. 1999-09-14 02:03:19 +00:00
error [SV 46433] Show recipe line offsets in line number messages. 2016-04-11 07:51:05 -04:00
eval tests: Simplify customization of %ENV 2020-04-01 02:02:57 -04:00
file Fix build and test issues on Windows 2021-03-28 16:25:52 -04:00
filter-out [SV 59093] Rewrite filter/filter-out to avoid large stack usage 2020-11-13 00:44:24 -05:00
findstring * Added the test suite to the main distribution. 1999-09-14 02:03:19 +00:00
flavor Implemented the flavor function which returns the flavor of 2005-11-17 07:27:28 +00:00
foreach tests: Simplify customization of %ENV 2020-04-01 02:02:57 -04:00
guile * tests/scripts/function/guile: Valgrind doesn't work with Guile. 2019-09-21 15:38:52 -04:00
if Fix bugs 5798 and 6195. 2003-11-04 07:40:29 +00:00
intcmp * src/function.c (parse_textint): Handle ints without 0 properly. 2022-01-17 19:11:59 -05:00
join * Added the test suite to the main distribution. 1999-09-14 02:03:19 +00:00
let Create $(let ...) providing lexically scoped variables 2020-12-06 18:30:58 -05:00
notdir * Added the test suite to the main distribution. 1999-09-14 02:03:19 +00:00
origin tests: Simplify customization of %ENV 2020-04-01 02:02:57 -04:00
realpath Add test suite support to Windows 2017-06-04 18:37:20 -04:00
shell Support implementing the jobserver using named pipes 2022-08-02 23:36:35 -04:00
sort [SV 46995] Strip leading/trailing space from variable names 2016-03-23 01:25:51 -04:00
strip * Various bug fixes. 2000-04-22 02:11:17 +00:00
substitution Fix some bugs in variable pattern substitution (e.g. $(VAR:A=B)), 2004-09-21 04:00:31 +00:00
suffix * Added the test suite to the main distribution. 1999-09-14 02:03:19 +00:00
value Major updates in preparation for 3.80. 2002-07-08 02:26:47 +00:00
warning [SV 46433] Show recipe line offsets in line number messages. 2016-04-11 07:51:05 -04:00
wildcard * tests/scripts/functions/wildcard: Skip slash tests for local glob. 2019-10-05 17:48:19 -04:00
word Use a well-known error string for out-of-bound function arguments 2021-12-19 16:34:19 -05:00