[thirdparty/glibc.git] / mach / Machrules

# Rules for MiG interfaces that want to go into the C library.
# Copyright (C) 1991-2018 Free Software Foundation, Inc.
# This file is part of the GNU C Library.

# The GNU C Library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.

# The GNU C Library 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
# Lesser General Public License for more details.

# You should have received a copy of the GNU Lesser General Public
# License along with the GNU C Library; if not, see
# <http://www.gnu.org/licenses/>.

# Makefiles may define these variable before including this file:
#	user-interfaces		Names of interfaces to put user stubs in for.
#	server-interfaces	Names of interfaces to put server stubs in for.
#	interface-library	Name of interface library to build and install.
# This file sets:
#	interface-headers	Names of generated interface header files.
#	interface-routines	Names of generated interface routines.
# All user stubs are put in individual files, prefixed with RPC_; header
# for both __ and non-__ names is put in foo.h.  Server interfaces are
# written to foo_server.c and foo_server.h; the server functions are called
# _S_rpcname.

# Includers can also add to or modify `migdefines' to set MiG flags.
# They can also set `migheaderpipe' to mangle the MiG header output.

all:

# Make sure no value comes from the environment, since we append to it.
# This is done also in ../Rules, but we append to the value before
# including Rules, which changes the origin.
ifneq	"$(findstring env,$(origin generated))" ""
generated :=
endif


include ../Makeconfig

# This makefile contains a lot of implicit rules that get optimized
# away if the target directory does not exist.
ifndef no_deps
-include $(objpfx)dummy.mk
endif
$(objpfx)dummy.mk:
	$(make-target-directory)
	echo '# Empty' > $@

MIGFLAGS = -DSTANDALONE -DTypeCheck=0 \
	   $(+includes) $(migdefines) -subrprefix __
# Putting CC in the enivronment makes the mig wrapper script
# use the same compiler setup we are using to run cpp.
MIG := CC='${CC}' CPP='${CPP} -x c' $(MIG)

.SUFFIXES: .defs	# Just to set specified_rule_matched.

define nl	# This is needed by *.ir.


endef
ifdef user-interfaces
*.ir := $(addprefix $(objpfx),$(foreach if,$(user-interfaces),$(if).ir))
ifndef no_deps
ifndef inhibit_interface_rules
-include $(*.ir)
endif
endif
ifneq "$(*.ir)" "$(wildcard $(*.ir))"
# If any .ir file is missing, we will be unable to make all the deps.
no_deps=t
endif
generated += $(*.ir:$(objpfx)%=%)
endif


# %.ir defines a variable `%-calls', which lists the RPCs defined by
# %.defs, and a rule to build $(%-calls:%=RPC_$(%-userprefix)%.c) from
# %.defs, where $(%-userprefix) is the user prefix given in %.defs.  We use
# the kludgificacious method of defining a pattern rule to build files
# matching patterns we are pretty damn sure will only match the particular
# files we have in mind.  To be so damn sure, we use the silly names
# RPC_*.c and the pattern R%C_*.c because using __*.c and _%*.c (or any
# other useful pattern) causes the rule for `host_info' to also match
# `xxx_host_info', and analogous lossage.
#
# Depend on %.h just so they will be built from %.uh in the
# makefile-rebuilding run which builds %.ir; otherwise, %.uh is built as an
# intermediate in order to make %.ir and then removed before re-exec, when
# %.uh is built all over again to build %.h.
$(objpfx)%.ir: $(objpfx)%.uh $(objpfx)%.h
	($(AWK) "NF == 4 && (\$$2 == \"Routine\" || \$$2 == \"SimpleRoutine\")\
	        { printf \"$*-calls += %s\\n\", \$$3 }" $<	;\
	 echo '$$($*-calls:%=$$(objpfx)R\%C_%.c): $$(objpfx)$*.ustamp ;';\
	) > $@-new
	mv -f $@-new $@
vpath Machrules ../mach	# Find ourselves.

ifndef transform-user-stub-output
transform-user-stub-output = tmp
define transform-user-stub
echo "weak_alias (__$$call, $$call)" >> $(objpfx)tmp_$${call}.c;
endef
endif


# Generate `#include <NAME.defs>', taking $* for NAME.
# If $(NAME.defs) is defined use its value in place of `NAME.defs'.
define include-%.defs
echo '#include <$(firstword $($*.defs) $*.defs)>'
endef

ifndef no_deps
# Not an implicit rule so the stamps are never removed as intermediates!
$(patsubst %,$(objpfx)%.ustamp,$(user-interfaces)): $(objpfx)%.ustamp:
	rm -f $@
	$(include-%.defs) | \
	$(MIG) - /dev/null -prefix __ \
	       $(MIGFLAGS) $(user-MIGFLAGS) $(MIGFLAGS-$*) \
	       -i $(objpfx)tmp_ \
	       -server /dev/null -user /dev/null -header /dev/null
	for call in $($*-calls); do \
	  $(transform-user-stub) \
	  $(move-if-change) $(objpfx)$(transform-user-stub-output)_$${call}.c \
			    $(objpfx)RPC_$${call}.c; \
	done
	touch $@
-include $(patsubst %,$(objpfx)%.udeps,$(user-interfaces))
$(patsubst %,$(objpfx)%.udeps,$(user-interfaces)):
  $(objpfx)%.udeps: $(..)mach/Machrules
	$(make-target-directory)
# We must use $(CFLAGS) to get -O flags that affect #if's in header files.
	$(include-%.defs) | \
	$(CC) $(CFLAGS) $(CPPFLAGS) -M -x c - | \
	sed -e 's,- *:,$(.udeps-targets):,' \
	    $(sed-remove-objpfx) > $@.new
	mv -f $@.new $@
.udeps-targets = $@ $(@:.udeps=.ustamp) $(@:.udeps=.uh) $(@:.udeps=.__h) \
		 $(@:.udeps=_server.c) $(@:.udeps=_server.h)
endif

# Look for the server stub files where they will be written.
vpath %_server.c $(addprefix $(objpfx),$(sort $(dir $(server-interfaces))))

# Build the server stubs in $(objdir).
$(objpfx)%_server.c $(objpfx)%_server.h:
	$(make-target-directory)
	$(include-%.defs) | \
	$(MIG) - /dev/null -prefix _S_ \
	       $(MIGFLAGS) $(server-MIGFLAGS) $(MIGFLAGS-$*) \
	       -user /dev/null -header /dev/null \
	       -server $(@:.h=.c) -sheader $(@:.c=.h)

# To get header files that declare both the straight and __ functions,
# we generate two files and paste them together.
$(patsubst %,$(objpfx)%.uh,$(user-interfaces)): $(objpfx)%.uh:; $(mig.uh)
define mig.uh
$(make-target-directory)
$(include-%.defs) | \
$(MIG) - /dev/null $(MIGFLAGS) $(MIGFLAGS-$*) \
       -header $@ -server /dev/null -user /dev/null
endef
$(patsubst %,$(objpfx)%.__h,$(user-interfaces)): $(objpfx)%.__h:; $(mig.__h)
define mig.__h
$(make-target-directory)
$(include-%.defs) | \
$(MIG) - /dev/null $(MIGFLAGS) $(MIGFLAGS-$*) -prefix __ \
       -header $@ -server /dev/null -user /dev/null
endef

$(patsubst %,$(objpfx)%.h,$(user-interfaces)): $(objpfx)%.h: $(objpfx)%.__h \
							     $(objpfx)%.uh
# The last line of foo.__h is "#endif _foo_user_".
# The first two lines of foo.uh are "#ifndef _foo_user_"/"#define _foo_user_".
	(sed -e '$$d' $<; sed -e '1,2d' $(word 2,$^)) $(migheaderpipe) > $@-new
	mv -f $@-new $@

interface-routines := $(foreach if,$(user-interfaces),			\
				$(addprefix RPC_,$($(if)-calls)))	\
		      $(server-interfaces:%=%_server)
interface-headers := $(user-interfaces:%=%.h) \
		     $(server-interfaces:%=%_server.h)

# Remove the generated user stub source and header files,
# and don't distribute them.
mach-generated = $(interface-routines:%=%.c) $(interface-headers) \
		 $(foreach h,$(user-interfaces),$h.uh $h.__h)
generated += $(mach-generated)

# These are needed to generate the dependencies.
before-compile += $(interface-headers:%=$(objpfx)%)

# Don't let these be intermediate files and get removed.
$(foreach h,$(interface-headers:%.h=$(objpfx)%),$h.h $h.__h $h.uh) :
$(interface-routines:%=$(objpfx)%.c) :

# Convenient target to generate all the headers.
.PHONY: interface-headers
interface-headers: $(interface-headers)

# Don't automatically generate dependencies for the sources we generate.
# There are likely to be a whole lot of them, and we know their
# dependencies ahead of time anyway because they're boilerplate.
omit-deps += $(interface-routines)

# Choose any single module generated by MiG.  We will compute this module's
# dependencies and then assume all other MiG-generated modules depend on the
# same headers.
some-if-rtn := $(firstword $(interface-routines))
ifdef some-if-rtn
$(foreach o,$(object-suffixes),$(interfaces-routines:%=%$o)): $(some-if-rtn).d
generated += $(some-if-rtn).d
endif
\f
# If defined, $(interface-library) is `libNAME'.  It is to be a library
# containing all the MiG-generated functions for the specified interfaces.

ifdef interface-library

$(interface-library)-routines = $(interface-routines) stack_chk_fail_local
extra-libs += $(interface-library)
extra-libs-others += $(interface-library)

ifeq (yes,$(build-shared))
interface.so = $(interface-library:=.so)

# Depend on libc.so so a DT_NEEDED is generated in the shared objects.
$(objpfx)$(interface.so): $(common-objpfx)libc.so
endif

endif
Commit	Line	Data
28f540f4	1	# Rules for MiG interfaces that want to go into the C library.
688903eb	2	# Copyright (C) 1991-2018 Free Software Foundation, Inc.
28f540f4 RM	3	# This file is part of the GNU C Library.
	4
	5	# The GNU C Library is free software; you can redistribute it and/or
41bdb6e2 AJ	6	# modify it under the terms of the GNU Lesser General Public
	7	# License as published by the Free Software Foundation; either
	8	# version 2.1 of the License, or (at your option) any later version.
28f540f4 RM	9
	10	# The GNU C Library is distributed in the hope that it will be useful,
	11	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41bdb6e2	13	# Lesser General Public License for more details.
28f540f4	14
41bdb6e2	15	# You should have received a copy of the GNU Lesser General Public
59ba27a6 PE	16	# License along with the GNU C Library; if not, see
59ba27a6 PE	17	# <http://www.gnu.org/licenses/>.
28f540f4 RM	18
	19	# Makefiles may define these variable before including this file:
	20	# user-interfaces Names of interfaces to put user stubs in for.
	21	# server-interfaces Names of interfaces to put server stubs in for.
	22	# interface-library Name of interface library to build and install.
	23	# This file sets:
	24	# interface-headers Names of generated interface header files.
	25	# interface-routines Names of generated interface routines.
	26	# All user stubs are put in individual files, prefixed with RPC_; header
	27	# for both __ and non-__ names is put in foo.h. Server interfaces are
	28	# written to foo_server.c and foo_server.h; the server functions are called
	29	# _S_rpcname.
	30
	31	# Includers can also add to or modify `migdefines' to set MiG flags.
95dfdbd2	32	# They can also set `migheaderpipe' to mangle the MiG header output.
28f540f4 RM	33
	34	all:
	35
	36	# Make sure no value comes from the environment, since we append to it.
	37	# This is done also in ../Rules, but we append to the value before
	38	# including Rules, which changes the origin.
	39	ifneq "$(findstring env,$(origin generated))" ""
	40	generated :=
	41	endif
	42
	43
	44	include ../Makeconfig
	45
37eb58de RM	46	# This makefile contains a lot of implicit rules that get optimized
	47	# away if the target directory does not exist.
	48	ifndef no_deps
	49	-include $(objpfx)dummy.mk
	50	endif
	51	$(objpfx)dummy.mk:
	52	$(make-target-directory)
	53	echo '# Empty' > $@
	54
7dab2d00	55	MIGFLAGS = -DSTANDALONE -DTypeCheck=0 \
28f540f4	56	$(+includes) $(migdefines) -subrprefix __
8a0746ae RM	57	# Putting CC in the enivronment makes the mig wrapper script
8a0746ae RM	58	# use the same compiler setup we are using to run cpp.
746f4007	59	MIG := CC='${CC}' CPP='${CPP} -x c' $(MIG)
28f540f4 RM	60
	61	.SUFFIXES: .defs # Just to set specified_rule_matched.
	62
	63	define nl # This is needed by *.ir.
	64
	65
	66	endef
	67	ifdef user-interfaces
	68	*.ir := $(addprefix $(objpfx),$(foreach if,$(user-interfaces),$(if).ir))
a1c46301	69	ifndef no_deps
28f540f4	70	ifndef inhibit_interface_rules
9e3db9cd	71	-include $(*.ir)
28f540f4	72	endif
a1c46301	73	endif
28f540f4 RM	74	ifneq "$(.ir)" "$(wildcard $(.ir))"
	75	# If any .ir file is missing, we will be unable to make all the deps.
	76	no_deps=t
	77	endif
	78	generated += $(*.ir:$(objpfx)%=%)
	79	endif
	80
	81
	82	# %.ir defines a variable `%-calls', which lists the RPCs defined by
	83	# %.defs, and a rule to build $(%-calls:%=RPC_$(%-userprefix)%.c) from
	84	# %.defs, where $(%-userprefix) is the user prefix given in %.defs. We use
	85	# the kludgificacious method of defining a pattern rule to build files
	86	# matching patterns we are pretty damn sure will only match the particular
	87	# files we have in mind. To be so damn sure, we use the silly names
	88	# RPC_.c and the pattern R%C_.c because using __.c and _%.c (or any
	89	# other useful pattern) causes the rule for `host_info' to also match
	90	# `xxx_host_info', and analogous lossage.
	91	#
28f540f4 RM	92	# Depend on %.h just so they will be built from %.uh in the
	93	# makefile-rebuilding run which builds %.ir; otherwise, %.uh is built as an
	94	# intermediate in order to make %.ir and then removed before re-exec, when
	95	# %.uh is built all over again to build %.h.
	96	$(objpfx)%.ir: $(objpfx)%.uh $(objpfx)%.h
19cc96bf	97	($(AWK) "NF == 4 && (\$$2 == \"Routine\" \|\| \$$2 == \"SimpleRoutine\")\
aa1075ea	98	{ printf \"$*-calls += %s\\n\", \$$3 }" $< ;\
28f540f4	99	echo '$$($-calls:%=$$(objpfx)R\%C_%.c): $$(objpfx)$.ustamp ;';\
28f540f4	100	) > $@-new
a53bad16	101	mv -f $@-new $@
28f540f4 RM	102	vpath Machrules ../mach # Find ourselves.
	103
	104	ifndef transform-user-stub-output
	105	transform-user-stub-output = tmp
	106	define transform-user-stub
	107	echo "weak_alias (__$$call, $$call)" >> $(objpfx)tmp_$${call}.c;
	108	endef
	109	endif
	110
aa592a63 RM	111
	112	# Generate `#include <NAME.defs>', taking $* for NAME.
	113	# If $(NAME.defs) is defined use its value in place of `NAME.defs'.
	114	define include-%.defs
	115	echo '#include <$(firstword $($.defs) $.defs)>'
	116	endef
	117
71cf0361	118	ifndef no_deps
28f540f4	119	# Not an implicit rule so the stamps are never removed as intermediates!
aa1075ea RM	120	$(patsubst %,$(objpfx)%.ustamp,$(user-interfaces)): $(objpfx)%.ustamp:
aa1075ea RM	121	rm -f $@
aa592a63	122	$(include-%.defs) \| \
aa1075ea RM	123	$(MIG) - /dev/null -prefix __ \
	124	$(MIGFLAGS) $(user-MIGFLAGS) $(MIGFLAGS-$*) \
	125	-i $(objpfx)tmp_ \
28f540f4 RM	126	-server /dev/null -user /dev/null -header /dev/null
	127	for call in $($*-calls); do \
	128	$(transform-user-stub) \
66715f83	129	$(move-if-change) $(objpfx)$(transform-user-stub-output)_$${call}.c \
28f540f4 RM	130	$(objpfx)RPC_$${call}.c; \
	131	done
	132	touch $@
aa1075ea	133	-include $(patsubst %,$(objpfx)%.udeps,$(user-interfaces))
59dd8641 RM	134	$(patsubst %,$(objpfx)%.udeps,$(user-interfaces)):
59dd8641 RM	135	$(objpfx)%.udeps: $(..)mach/Machrules
f8adc70c	136	$(make-target-directory)
ce944fef	137	# We must use $(CFLAGS) to get -O flags that affect #if's in header files.
c337dc4c	138	$(include-%.defs) \| \
ce944fef	139	$(CC) $(CFLAGS) $(CPPFLAGS) -M -x c - \| \
930e5aa1	140	sed -e 's,- *:,$(.udeps-targets):,' \
aa1075ea RM	141	$(sed-remove-objpfx) > $@.new
aa1075ea RM	142	mv -f $@.new $@
930e5aa1 RM	143	.udeps-targets = $@ $(@:.udeps=.ustamp) $(@:.udeps=.uh) $(@:.udeps=.__h) \
930e5aa1 RM	144	$(@:.udeps=_server.c) $(@:.udeps=_server.h)
71cf0361	145	endif
28f540f4 RM	146
	147	# Look for the server stub files where they will be written.
	148	vpath %_server.c $(addprefix $(objpfx),$(sort $(dir $(server-interfaces))))
	149
	150	# Build the server stubs in $(objdir).
aa1075ea	151	$(objpfx)%_server.c $(objpfx)%_server.h:
19cc96bf	152	$(make-target-directory)
aa592a63	153	$(include-%.defs) \| \
aa1075ea RM	154	$(MIG) - /dev/null -prefix _S_ \
aa1075ea RM	155	$(MIGFLAGS) $(server-MIGFLAGS) $(MIGFLAGS-$*) \
a1470b6f	156	-user /dev/null -header /dev/null \
28f540f4 RM	157	-server $(@:.h=.c) -sheader $(@:.c=.h)
	158
	159	# To get header files that declare both the straight and __ functions,
	160	# we generate two files and paste them together.
3fd77707	161	$(patsubst %,$(objpfx)%.uh,$(user-interfaces)): $(objpfx)%.uh:; $(mig.uh)
28f540f4 RM	162	define mig.uh
28f540f4 RM	163	$(make-target-directory)
aa592a63	164	$(include-%.defs) \| \
acf51e02	165	$(MIG) - /dev/null $(MIGFLAGS) $(MIGFLAGS-$*) \
28f540f4 RM	166	-header $@ -server /dev/null -user /dev/null
28f540f4 RM	167	endef
3fd77707	168	$(patsubst %,$(objpfx)%.__h,$(user-interfaces)): $(objpfx)%.__h:; $(mig.__h)
28f540f4 RM	169	define mig.__h
28f540f4 RM	170	$(make-target-directory)
aa592a63	171	$(include-%.defs) \| \
acf51e02	172	$(MIG) - /dev/null $(MIGFLAGS) $(MIGFLAGS-$*) -prefix __ \
28f540f4 RM	173	-header $@ -server /dev/null -user /dev/null
	174	endef
	175
3fd77707 RM	176	$(patsubst %,$(objpfx)%.h,$(user-interfaces)): $(objpfx)%.h: $(objpfx)%.__h \
3fd77707 RM	177	$(objpfx)%.uh
28f540f4 RM	178	# The last line of foo.__h is "#endif _foo_user_".
28f540f4 RM	179	# The first two lines of foo.uh are "#ifndef _foo_user_"/"#define _foo_user_".
95dfdbd2	180	(sed -e '$$d' $<; sed -e '1,2d' $(word 2,$^)) $(migheaderpipe) > $@-new
a53bad16	181	mv -f $@-new $@
28f540f4 RM	182
	183	interface-routines := $(foreach if,$(user-interfaces), \
	184	$(addprefix RPC_,$($(if)-calls))) \
	185	$(server-interfaces:%=%_server)
	186	interface-headers := $(user-interfaces:%=%.h) \
	187	$(server-interfaces:%=%_server.h)
	188
	189	# Remove the generated user stub source and header files,
	190	# and don't distribute them.
63b129ed RM	191	mach-generated = $(interface-routines:%=%.c) $(interface-headers) \
63b129ed RM	192	$(foreach h,$(user-interfaces),$h.uh $h.__h)
28f540f4 RM	193	generated += $(mach-generated)
	194
	195	# These are needed to generate the dependencies.
	196	before-compile += $(interface-headers:%=$(objpfx)%)
	197
	198	# Don't let these be intermediate files and get removed.
	199	$(foreach h,$(interface-headers:%.h=$(objpfx)%),$h.h $h.__h $h.uh) :
	200	$(interface-routines:%=$(objpfx)%.c) :
	201
	202	# Convenient target to generate all the headers.
	203	.PHONY: interface-headers
	204	interface-headers: $(interface-headers)
	205
	206	# Don't automatically generate dependencies for the sources we generate.
	207	# There are likely to be a whole lot of them, and we know their
	208	# dependencies ahead of time anyway because they're boilerplate.
	209	omit-deps += $(interface-routines)
	210
aa1075ea RM	211	# Choose any single module generated by MiG. We will compute this module's
	212	# dependencies and then assume all other MiG-generated modules depend on the
	213	# same headers.
	214	some-if-rtn := $(firstword $(interface-routines))
	215	ifdef some-if-rtn
	216	$(foreach o,$(object-suffixes),$(interfaces-routines:%=%$o)): $(some-if-rtn).d
	217	generated += $(some-if-rtn).d
	218	endif
28f540f4	219	\f
f0bf9cb9	220	# If defined, $(interface-library) is `libNAME'. It is to be a library
28f540f4 RM	221	# containing all the MiG-generated functions for the specified interfaces.
	222
	223	ifdef interface-library
	224
97e02ad2	225	$(interface-library)-routines = $(interface-routines) stack_chk_fail_local
f0bf9cb9	226	extra-libs += $(interface-library)
e10cd1dc	227	extra-libs-others += $(interface-library)
28f540f4	228
5407f442 RM	229	ifeq (yes,$(build-shared))
	230	interface.so = $(interface-library:=.so)
	231
	232	# Depend on libc.so so a DT_NEEDED is generated in the shared objects.
	233	$(objpfx)$(interface.so): $(common-objpfx)libc.so
	234	endif
11872325	235
28f540f4	236	endif