1# Rules for MiG interfaces that want to go into the C library.
2# Copyright (C) 1991-2021 Free Software Foundation, Inc.
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
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.
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
13# Lesser General Public License for more details.
14
15# You should have received a copy of the GNU Lesser General Public
16# License along with the GNU C Library; if not, see
17# <https://www.gnu.org/licenses/>.
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.
32# They can also set `migheaderpipe' to mangle the MiG header output.
33
34all:
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.
39ifneq	"$(findstring env,$(origin generated))" ""
40generated :=
41endif
42
43
44include ../Makeconfig
45
46# This makefile contains a lot of implicit rules that get optimized
47# away if the target directory does not exist.
48ifndef no_deps
49-include $(objpfx)dummy.mk
50endif
51$(objpfx)dummy.mk:
52	$(make-target-directory)
53	echo '# Empty' > $@
54
55MIGFLAGS = -DSTANDALONE -DTypeCheck=0 \
56	   $(+includes) $(migdefines) -subrprefix __
57# Putting CC in the enivronment makes the mig wrapper script
58# use the same compiler setup we are using to run cpp.
59MIG := CC='${CC}' CPP='${CPP} -x c' $(MIG)
60
61.SUFFIXES: .defs	# Just to set specified_rule_matched.
62
63define nl	# This is needed by *.ir.
64
65
66endef
67ifdef user-interfaces
68*.ir := $(addprefix $(objpfx),$(foreach if,$(user-interfaces),$(if).ir))
69ifndef no_deps
70ifndef inhibit_interface_rules
71-include $(*.ir)
72endif
73endif
74ifneq "$(*.ir)" "$(wildcard $(*.ir))"
75# If any .ir file is missing, we will be unable to make all the deps.
76no_deps=t
77endif
78generated += $(*.ir:$(objpfx)%=%)
79endif
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#
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
97	($(AWK) "NF == 4 && (\$$2 == \"Routine\" || \$$2 == \"SimpleRoutine\")\
98	        { printf \"$*-calls += %s\\n\", \$$3 }" $<	;\
99	 echo '$$($*-calls:%=$$(objpfx)R\%C_%.c): $$(objpfx)$*.ustamp ;';\
100	) > $@-new
101	mv -f $@-new $@
102vpath Machrules ../mach	# Find ourselves.
103
104ifndef transform-user-stub-output
105transform-user-stub-output = tmp
106define transform-user-stub
107echo "weak_alias (__$$call, $$call)" >> $(objpfx)tmp_$${call}.c;
108endef
109endif
110
111
112# Generate `#include <NAME.defs>', taking $* for NAME.
113# If $(NAME.defs) is defined use its value in place of `NAME.defs'.
114define include-%.defs
115echo '#include <$(firstword $($*.defs) $*.defs)>'
116endef
117
118ifndef no_deps
119# Not an implicit rule so the stamps are never removed as intermediates!
120$(patsubst %,$(objpfx)%.ustamp,$(user-interfaces)): $(objpfx)%.ustamp:
121	rm -f $@
122	$(include-%.defs) | \
123	$(MIG) - /dev/null -prefix __ \
124	       $(MIGFLAGS) $(user-MIGFLAGS) $(MIGFLAGS-$*) \
125	       -i $(objpfx)tmp_ \
126	       -server /dev/null -user /dev/null -header /dev/null
127	for call in $($*-calls); do \
128	  $(transform-user-stub) \
129	  $(move-if-change) $(objpfx)$(transform-user-stub-output)_$${call}.c \
130			    $(objpfx)RPC_$${call}.c; \
131	done
132	touch $@
133-include $(patsubst %,$(objpfx)%.udeps,$(user-interfaces))
134$(patsubst %,$(objpfx)%.udeps,$(user-interfaces)):
135  $(objpfx)%.udeps: $(..)mach/Machrules
136	$(make-target-directory)
137# We must use $(CFLAGS) to get -O flags that affect #if's in header files.
138	$(include-%.defs) | \
139	$(CC) $(CFLAGS) $(CPPFLAGS) -M -x c - | \
140	sed -e 's,- *:,$(.udeps-targets):,' \
141	    $(sed-remove-objpfx) > $@.new
142	mv -f $@.new $@
143.udeps-targets = $@ $(@:.udeps=.ustamp) $(@:.udeps=.uh) $(@:.udeps=.__h) \
144		 $(@:.udeps=_server.c) $(@:.udeps=_server.h)
145endif
146
147# Look for the server stub files where they will be written.
148vpath %_server.c $(addprefix $(objpfx),$(sort $(dir $(server-interfaces))))
149
150# Build the server stubs in $(objdir).
151$(objpfx)%_server.c $(objpfx)%_server.h:
152	$(make-target-directory)
153	$(include-%.defs) | \
154	$(MIG) - /dev/null -prefix _S_ \
155	       $(MIGFLAGS) $(server-MIGFLAGS) $(MIGFLAGS-$*) \
156	       -user /dev/null -header /dev/null \
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.
161$(patsubst %,$(objpfx)%.uh,$(user-interfaces)): $(objpfx)%.uh:; $(mig.uh)
162define mig.uh
163$(make-target-directory)
164$(include-%.defs) | \
165$(MIG) - /dev/null $(MIGFLAGS) $(MIGFLAGS-$*) \
166       -header $@ -server /dev/null -user /dev/null
167endef
168$(patsubst %,$(objpfx)%.__h,$(user-interfaces)): $(objpfx)%.__h:; $(mig.__h)
169define mig.__h
170$(make-target-directory)
171$(include-%.defs) | \
172$(MIG) - /dev/null $(MIGFLAGS) $(MIGFLAGS-$*) -prefix __ \
173       -header $@ -server /dev/null -user /dev/null
174endef
175
176$(patsubst %,$(objpfx)%.h,$(user-interfaces)): $(objpfx)%.h: $(objpfx)%.__h \
177							     $(objpfx)%.uh
178# The last line of foo.__h is "#endif _foo_user_".
179# The first two lines of foo.uh are "#ifndef _foo_user_"/"#define _foo_user_".
180	(sed -e '$$d' $<; sed -e '1,2d' $(word 2,$^)) $(migheaderpipe) > $@-new
181	mv -f $@-new $@
182
183interface-routines := $(foreach if,$(user-interfaces),			\
184				$(addprefix RPC_,$($(if)-calls)))	\
185		      $(server-interfaces:%=%_server)
186interface-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.
191mach-generated = $(interface-routines:%=%.c) $(interface-headers) \
192		 $(foreach h,$(user-interfaces),$h.uh $h.__h)
193generated += $(mach-generated)
194
195# These are needed to generate the dependencies.
196before-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
204interface-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.
209omit-deps += $(interface-routines)
210
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.
214some-if-rtn := $(firstword $(interface-routines))
215ifdef some-if-rtn
216$(foreach o,$(object-suffixes),$(interfaces-routines:%=%$o)): $(some-if-rtn).d
217generated += $(some-if-rtn).d
218endif
219
220# If defined, $(interface-library) is `libNAME'.  It is to be a library
221# containing all the MiG-generated functions for the specified interfaces.
222
223ifdef interface-library
224
225$(interface-library)-routines = $(interface-routines) stack_chk_fail_local
226$(interface-library)-shared-only-routines = stack_chk_fail_local
227extra-libs += $(interface-library)
228extra-libs-others += $(interface-library)
229
230ifeq (yes,$(build-shared))
231interface.so = $(interface-library:=.so)
232
233# Depend on libc.so so a DT_NEEDED is generated in the shared objects.
234$(objpfx)$(interface.so): $(common-objpfx)libc.so
235endif
236
237endif
238