blob: 297794a3ad4643f3c983c37c1ebb6a93d443ff6a [file] [log] [blame]
lh9ed821d2023-04-07 01:36:19 -07001# Rules for MiG interfaces that want to go into the C library.
2# Copyright (C) 1991-2015 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# <http://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
33all:
34
35# Make sure no value comes from the environment, since we append to it.
36# This is done also in ../Rules, but we append to the value before
37# including Rules, which changes the origin.
38ifneq "$(findstring env,$(origin generated))" ""
39generated :=
40endif
41
42
43include ../Makeconfig
44
45# This makefile contains a lot of implicit rules that get optimized
46# away if the target directory does not exist.
47ifndef no_deps
48-include $(objpfx)dummy.mk
49endif
50$(objpfx)dummy.mk:
51 $(make-target-directory)
52 echo '# Empty' > $@
53
54MIGFLAGS = -DMACH_IPC_COMPAT=0 -DSTANDALONE -DTypeCheck=0 \
55 $(+includes) $(migdefines) -subrprefix __
56# Putting CC in the enivronment makes the mig wrapper script
57# use the same compiler setup we are using to run cpp.
58MIG := CC='${CC}' CPP='${CPP} -x c' $(MIG)
59
60.SUFFIXES: .defs # Just to set specified_rule_matched.
61
62define nl # This is needed by *.ir.
63
64
65endef
66ifdef user-interfaces
67*.ir := $(addprefix $(objpfx),$(foreach if,$(user-interfaces),$(if).ir))
68ifndef no_deps
69ifndef inhibit_interface_rules
70-include $(*.ir)
71endif
72endif
73ifneq "$(*.ir)" "$(wildcard $(*.ir))"
74# If any .ir file is missing, we will be unable to make all the deps.
75no_deps=t
76endif
77generated += $(*.ir:$(objpfx)%=%)
78endif
79
80
81# %.ir defines a variable `%-calls', which lists the RPCs defined by
82# %.defs, and a rule to build $(%-calls:%=RPC_$(%-userprefix)%.c) from
83# %.defs, where $(%-userprefix) is the user prefix given in %.defs. We use
84# the kludgificacious method of defining a pattern rule to build files
85# matching patterns we are pretty damn sure will only match the particular
86# files we have in mind. To be so damn sure, we use the silly names
87# RPC_*.c and the pattern R%C_*.c because using __*.c and _%*.c (or any
88# other useful pattern) causes the rule for `host_info' to also match
89# `xxx_host_info', and analogous lossage.
90#
91# Depend on %.h just so they will be built from %.uh in the
92# makefile-rebuilding run which builds %.ir; otherwise, %.uh is built as an
93# intermediate in order to make %.ir and then removed before re-exec, when
94# %.uh is built all over again to build %.h.
95$(objpfx)%.ir: $(objpfx)%.uh $(objpfx)%.h
96 ($(AWK) "NF == 4 && (\$$2 == \"Routine\" || \$$2 == \"SimpleRoutine\")\
97 { printf \"$*-calls += %s\\n\", \$$3 }" $< ;\
98 echo '$$($*-calls:%=$$(objpfx)R\%C_%.c): $$(objpfx)$*.ustamp ;';\
99 ) > $@-new
100 mv -f $@-new $@
101vpath Machrules ../mach # Find ourselves.
102
103ifndef transform-user-stub-output
104transform-user-stub-output = tmp
105define transform-user-stub
106echo "weak_alias (__$$call, $$call)" >> $(objpfx)tmp_$${call}.c;
107endef
108endif
109
110
111# Generate `#include <NAME.defs>', taking $* for NAME.
112# If $(NAME.defs) is defined use its value in place of `NAME.defs'.
113define include-%.defs
114echo '#include <$(firstword $($*.defs) $*.defs)>'
115endef
116
117ifndef no_deps
118# Not an implicit rule so the stamps are never removed as intermediates!
119$(patsubst %,$(objpfx)%.ustamp,$(user-interfaces)): $(objpfx)%.ustamp:
120 rm -f $@
121 $(include-%.defs) | \
122 $(MIG) - /dev/null -prefix __ \
123 $(MIGFLAGS) $(user-MIGFLAGS) $(MIGFLAGS-$*) \
124 -i $(objpfx)tmp_ \
125 -server /dev/null -user /dev/null -header /dev/null
126 for call in $($*-calls); do \
127 $(transform-user-stub) \
128 $(move-if-change) $(objpfx)$(transform-user-stub-output)_$${call}.c \
129 $(objpfx)RPC_$${call}.c; \
130 done
131 touch $@
132-include $(patsubst %,$(objpfx)%.udeps,$(user-interfaces))
133$(patsubst %,$(objpfx)%.udeps,$(user-interfaces)):
134 $(objpfx)%.udeps: $(..)mach/Machrules
135 $(make-target-directory)
136# We must use $(CFLAGS) to get -O flags that affect #if's in header files.
137 $(include-%.defs) | \
138 $(CC) $(CFLAGS) $(CPPFLAGS) -M -x c - | \
139 sed -e 's,- *:,$(.udeps-targets):,' \
140 $(sed-remove-objpfx) > $@.new
141 mv -f $@.new $@
142.udeps-targets = $@ $(@:.udeps=.ustamp) $(@:.udeps=.uh) $(@:.udeps=.__h) \
143 $(@:.udeps=_server.c) $(@:.udeps=_server.h)
144endif
145
146# Look for the server stub files where they will be written.
147vpath %_server.c $(addprefix $(objpfx),$(sort $(dir $(server-interfaces))))
148
149# Build the server stubs in $(objdir).
150$(objpfx)%_server.c $(objpfx)%_server.h:
151 $(make-target-directory)
152 $(include-%.defs) | \
153 $(MIG) - /dev/null -prefix _S_ \
154 $(MIGFLAGS) $(server-MIGFLAGS) $(MIGFLAGS-$*) \
155 -user /dev/null -header /dev/null \
156 -server $(@:.h=.c) -sheader $(@:.c=.h)
157
158# To get header files that declare both the straight and __ functions,
159# we generate two files and paste them together.
160$(patsubst %,$(objpfx)%.uh,$(user-interfaces)): $(objpfx)%.uh:; $(mig.uh)
161define mig.uh
162$(make-target-directory)
163$(include-%.defs) | \
164$(MIG) - /dev/null $(MIGFLAGS) $(MIGFLAGS-$*) \
165 -header $@ -server /dev/null -user /dev/null
166endef
167$(patsubst %,$(objpfx)%.__h,$(user-interfaces)): $(objpfx)%.__h:; $(mig.__h)
168define mig.__h
169$(make-target-directory)
170$(include-%.defs) | \
171$(MIG) - /dev/null $(MIGFLAGS) $(MIGFLAGS-$*) -prefix __ \
172 -header $@ -server /dev/null -user /dev/null
173endef
174
175$(patsubst %,$(objpfx)%.h,$(user-interfaces)): $(objpfx)%.h: $(objpfx)%.__h \
176 $(objpfx)%.uh
177# The last line of foo.__h is "#endif _foo_user_".
178# The first two lines of foo.uh are "#ifndef _foo_user_"/"#define _foo_user_".
179 (sed -e '$$d' $<; sed -e '1,2d' $(word 2,$^)) > $@-new
180 mv -f $@-new $@
181
182interface-routines := $(foreach if,$(user-interfaces), \
183 $(addprefix RPC_,$($(if)-calls))) \
184 $(server-interfaces:%=%_server)
185interface-headers := $(user-interfaces:%=%.h) \
186 $(server-interfaces:%=%_server.h)
187
188# Remove the generated user stub source and header files,
189# and don't distribute them.
190mach-generated = $(interface-routines:%=%.c) $(interface-headers) \
191 $(foreach h,$(user-interfaces),$h.uh $h.__h)
192generated += $(mach-generated)
193
194# These are needed to generate the dependencies.
195before-compile += $(interface-headers:%=$(objpfx)%)
196
197# Don't let these be intermediate files and get removed.
198$(foreach h,$(interface-headers:%.h=$(objpfx)%),$h.h $h.__h $h.uh) :
199$(interface-routines:%=$(objpfx)%.c) :
200
201# Convenient target to generate all the headers.
202.PHONY: interface-headers
203interface-headers: $(interface-headers)
204
205# Don't automatically generate dependencies for the sources we generate.
206# There are likely to be a whole lot of them, and we know their
207# dependencies ahead of time anyway because they're boilerplate.
208omit-deps += $(interface-routines)
209
210# Choose any single module generated by MiG. We will compute this module's
211# dependencies and then assume all other MiG-generated modules depend on the
212# same headers.
213some-if-rtn := $(firstword $(interface-routines))
214ifdef some-if-rtn
215$(foreach o,$(object-suffixes),$(interfaces-routines:%=%$o)): $(some-if-rtn).d
216generated += $(some-if-rtn).d
217endif
218
219# If defined, $(interface-library) is `libNAME'. It is to be a library
220# containing all the MiG-generated functions for the specified interfaces.
221
222ifdef interface-library
223
224$(interface-library)-routines = $(interface-routines)
225extra-libs += $(interface-library)
226extra-libs-others += $(interface-library)
227
228ifeq (yes,$(build-shared))
229interface.so = $(interface-library:=.so)
230
231# Depend on libc.so so a DT_NEEDED is generated in the shared objects.
232$(objpfx)$(interface.so): $(common-objpfx)libc.so
233endif
234
235endif