xref: /illumos-gate/usr/src/cmd/mdb/Makefile.module (revision 5661bb76)
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License (the "License").
6# You may not use this file except in compliance with the License.
7#
8# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9# or http://www.opensolaris.org/os/licensing.
10# See the License for the specific language governing permissions
11# and limitations under the License.
12#
13# When distributing Covered Code, include this CDDL HEADER in each
14# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15# If applicable, add the following below this CDDL HEADER, with the
16# fields enclosed by brackets "[]" replaced with your own identifying
17# information: Portions Copyright [yyyy] [name of copyright owner]
18#
19# CDDL HEADER END
20#
21#
22# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23# Use is subject to license terms.
24#
25# Copyright (c) 2013 by Delphix. All rights reserved.
26# Copyright (c) 2018, Joyent, Inc.
27#
28
29.KEEP_STATE:
30.SUFFIXES:
31
32include $(SRC)/cmd/mdb/Makefile.tools
33
34#
35# Make sure we're getting a consistent execution environment for the
36# embedded scripts.
37#
38SHELL= /usr/bin/ksh93
39
40$(KMOD_SOURCES_DIFFERENT)KMODSRCS = $(MODSRCS)
41$(KMOD_SOURCES_DIFFERENT)KMODASMSRCS = $(MODASMSRCS)
42
43MODOBJS = $(MODSRCS:%.c=dmod/%.o) $(MODASMSRCS:%.s=dmod/%.o)
44KMODOBJS = $(KMODSRCS:%.c=kmod/%.o) $(KMODASMSRCS:%.s=kmod/%.o)
45
46MODNAME_cmd = if [ -n "$(MODULE_NAME)" ]; then print $(MODULE_NAME); else print $(MODULE)| sed -e 's:\.so$$::'; fi
47MODNAME = $(MODNAME_cmd:sh)
48KMODULE = $(MODNAME)
49
50MODFILE = dmod/$(MODULE)
51KMODFILE = kmod/$(KMODULE)
52
53#
54# The mess below is designed to pick the right set of objects to build and/or
55# lint.  We have three flavors:
56#
57#  1. proc and raw modules.  Only $(MODOBJS) are built.
58#  2. kvm modules for systems without kmdb.  Only $(MODOBJS) are built.
59#  3. kvm modules for systems with kmdb.  $(MODOBJS) and $(KMODOBJS) are built.
60#
61# Complicating matters, we'd like to make the distinction between 2 and 3 before
62# this Makefile is loaded.  By default, we'll assume that all kvm modules should
63# be built for kmdb.  If, however, the user sets $(MODULE_BUILD_TYPE) to `mdb',
64# the kmdb variant of the module won't be built.
65#
66
67# Which flavors are to be built?
68TARGETS_kvm_type_	= both	# Build both if $(MODULE_BUILD_TYPE) is unset
69TARGETS_kvm_type_kmdb	= both
70TARGETS_kvm_type_mdb	= mdb
71TARGETS_kvm_type	= $(TARGETS_kvm_type_$(MODULE_BUILD_TYPE))
72
73# What should we build?
74TARGETS_kvm_kmdb	= $(KMODFILE)
75TARGETS_kvm_mdb		= $(MODFILE)
76TARGETS_kvm_both	= $(TARGETS_kvm_mdb) $(TARGETS_kvm_kmdb)
77TARGETS_kvm		= $(TARGETS_kvm_$(TARGETS_kvm_type))
78TARGETS_proc		= $(MODFILE)
79TARGETS_raw		= $(MODFILE)
80TARGETS			= $(TARGETS_$(MDBTGT))
81
82# Where should we install that which we've built?
83ROOTTGTS_kvm_type	= $(TARGETS_kvm_type)	# overridden by mdb_ks
84ROOTTGTS_kvm_kmdb	= $(ROOTKMOD)/$(KMODULE)
85ROOTTGTS_kvm_mdb	= $(ROOTMOD)/$(MODULE)
86ROOTTGTS_kvm_both	= $(ROOTTGTS_kvm_mdb) $(ROOTTGTS_kvm_kmdb)
87ROOTTGTS_kvm		= $(ROOTTGTS_kvm_$(ROOTTGTS_kvm_type))
88ROOTTGTS_proc		= $(ROOTMOD)/$(MODULE)
89ROOTTGTS_raw		= $(ROOTMOD)/$(MODULE)
90ROOTTGTS		= $(ROOTTGTS_$(MDBTGT))
91
92# What should we lint?
93KLINTOBJS		= $(KMODOBJS:%.o=%.ln)
94LINTOBJS		= $(MODOBJS:%.o=%.ln)
95
96LINTFILES_kvm_type	= $(TARGETS_kvm_type)
97LINTFILES_kvm_both	= $(KLINTOBJS) $(LINTOBJS)
98LINTFILES_kvm_mdb	= $(LINTOBJS)
99LINTFILES_kvm		= $(LINTFILES_kvm_$(LINTFILES_kvm_type))
100LINTFILES_proc		= $(LINTOBJS)
101LINTFILES_raw		= $(LINTOBJS)
102LINTFILES		= $(LINTFILES_$(MDBTGT))
103
104#
105# Python specific flags. To try and make life easier for folks how are
106# building with an LFS python, we attempt to use -isystem when it's
107# available.
108#
109PYCPPFLAGS		= -_gcc=-isystem -_gcc=$(ADJUNCT_PROTO)/usr/include/python$(PYTHON_VERSION)
110PYCPPFLAGS		+= -_cc=-I$(ADJUNCT_PROTO)/usr/include/python$(PYTHON_VERSION)
111PYLNFLAGS		= -I$(ADJUNCT_PROTO)/usr/include/python$(PYTHON_VERSION)
112
113kvm_TGTFLAGS		= -D_KERNEL
114proc_TGTFLAGS		= -D_USER
115
116CSTD			= $(CSTD_GNU99)
117
118CFLAGS			+= $(CCVERBOSE)
119CFLAGS64		+= $(CCVERBOSE)
120CPPFLAGS		+= $($(MDBTGT)_TGTFLAGS) -I../../../common
121LDFLAGS			+= $(ZTEXT)
122LDFLAGS64		+= $(ZTEXT)
123ASFLAGS			+= -P
124AS_CPPFLAGS		+= -D_ASM
125
126SMOFF += all_func_returns,index_overflow
127
128# Module type-specific compiler flags
129$(MODOBJS) :=			CFLAGS += $(C_BIGPICFLAGS) $(XREGSFLAG)
130$(MODOBJS) :=			CFLAGS64 += $(C_BIGPICFLAGS) $(XREGSFLAG)
131$(KMODOBJS) $(KLINTOBJS) :=	CPPFLAGS += -D_KMDB
132$(KMODOBJS) :=			V9CODESIZE = $(CCABS32)
133$(KMODOBJS) :=			DTS_ERRNO =
134
135# Modules aren't allowed to export symbols
136MAPFILE		= $(SRC)/cmd/mdb/common/modules/conf/mapfile
137
138# Modules typically make external references.  To provide for -zdefs use
139# and clean ldd(1) processing, explicitly define all external references.
140MAPFILE-EXT	= $(SRC)/cmd/mdb/common/modules/conf/mapfile-extern
141
142#
143# kmdb is a kernel module, so we'll use the kernel's build flags.
144$(KMODOBJS) := CFLAGS64 += $(STAND_FLAGS_64)
145
146#
147# Override this to pull source files from another directory
148#
149MODSRCS_DIR = ../../../common/modules/genunix
150
151all: $$(TARGETS)
152
153install: all $$(ROOTTGTS)
154
155dmods: install
156
157clean.lint:
158	$(RM) $(LINTFILES) $(MODSRCS:.c=.ln)
159
160clean:
161	$(RM) $(MODOBJS) $(KMODOBJS) $(CLEANFILES)
162
163clobber: clean clean.lint
164	$(RM) $(MODFILE) $(KMODFILE) $(CLOBBERFILES)
165
166lint: $$(LINTFILES)
167
168.NO_PARALLEL:
169.PARALLEL: $(MODOBJS) $(KMODOBJS) mdb_tgt kmdb_tgt dmod kmod \
170	$(TARGETS) $(LINTFILES)
171
172$(MODFILE): dmod .WAIT $(MODOBJS) $$(MAPFILE-EXT)
173	$(LINK.c) $(ZDEFS) $(ZIGNORE) $(MAPFILE-EXT:%=-M%) $(GSHARED) \
174	    $(MODOBJS) -o $@ $(LDLIBS) -lc
175	$(CTFMERGE) -L VERSION -o $@ $(MODOBJS)
176	$(POST_PROCESS_SO)
177
178#
179# kmdb dmods must *not* stray from the module API.  To ensure that they don't,
180# we try to link them, at build time, against an object that exports the symbols
181# that they can legally use.  The link test object is, however, only built when
182# kmdb itself is built.  Requiring module developers to build kmdb first would
183# be painful, so by default, module-level builds don't do the link test (the
184# $(POUND_SIGN) assignment below takes care of that).  Builds of the entire
185# tree can, however, guarantee the construction of kmdb first, and as such can
186# override the setting of $(KMDB_LINKTEST_ENABLE).  This override causes the
187# link test to be run.
188#
189# Developers wanting to force a link test for a single module can use the
190# `linktest' target from within a module directory.
191#
192LINKTESTOBJ = $(KMDBDIR)/kmdb_modlinktest.o
193
194KMDB_LINKTEST = \
195	$(LD) $(ZDEFS) -dy -r -o $@.linktest $(KMODOBJS) \
196	$(STANDOBJS) $(LINKTESTOBJ) && \
197	$(RM) $@.linktest
198
199KMDB_LINKTEST_ENABLE=$(POUND_SIGN)
200$(KMDB_LINKTEST_ENABLE)KMDB_LINKTEST_CMD = $(KMDB_LINKTEST)
201
202#
203# Ensure that dmods don't use floating point
204#
205KMDB_FPTEST_CMD = $(KMDB_FPTEST)
206
207$(KMODFILE): kmod .WAIT $(KMODOBJS) $(MAPFILE)
208	$(LD) -dy -r $(MAPFILE:%=-M%) -Nmisc/kmdbmod -o $@ $(KMODOBJS) \
209	$(STANDOBJS)
210	$(KMDB_LINKTEST_CMD)
211	$(KMDB_FPTEST_CMD)
212	$(CTFMERGE) -f -L VERSION -o $@ $(KMODOBJS)
213	$(POST_PROCESS)
214	$(SETDYNFLAG) -f DF_1_NOKSYMS $@
215
216linktest: linktest_check .WAIT kmod .WAIT $(KMODOBJS)
217	$(KMDB_LINKTEST)
218
219linktest_check:
220	@if [ "$(MDBTGT)" != "kvm" ] ; then \
221		echo "ERROR: linktest is not supported non-kvm/disasm dmods" \
222		    >&2 ; \
223		exit 1 ; \
224	fi
225
226#
227# Dynamic rules for object construction
228#
229dmod/%.o kmod/%.o: %.c
230	$(COMPILE.c) -o $@ $<
231	$(CTFCONVERT_O)
232
233dmod/%.o kmod%.o: %.s
234	$(COMPILE.s) -o $@ $<
235	$(CTFCONVERT_O)
236
237dmod/%.o kmod/%.o: ../%.c
238	$(COMPILE.c) -o $@ $<
239	$(CTFCONVERT_O)
240
241dmod/%.o kmod%.o: ../%.s
242	$(COMPILE.s) -o $@ $<
243	$(CTFCONVERT_O)
244
245dmod/%.o kmod/%.o: ../../../common/modules/$(MODNAME)/%.c
246	$(COMPILE.c) -o $@ $<
247	$(CTFCONVERT_O)
248
249dmod/%.o kmod%.o: ../../../common/modules/$(MODNAME)/%.s
250	$(COMPILE.s) -o $@ $<
251	$(CTFCONVERT_O)
252
253dmod/%.o kmod/%.o: $$(MODSRCS_DIR)/%.c
254	$(COMPILE.c) -o $@ $<
255	$(CTFCONVERT_O)
256
257dmod/%.o kmod%.o: $$(MODSRCS_DIR)/%.s
258	$(COMPILE.s) -o $@ $<
259	$(CTFCONVERT_O)
260
261#
262# Lint
263#
264dmod/%.ln kmod/%.ln: %.c
265	$(LINT.c) -dirout=$(@D) -c $<
266
267dmod/%.ln kmod/%.ln: %.s
268	$(LINT.s) -dirout=$(@D) -c $<
269
270dmod/%.ln kmod/%.ln: ../%.c
271	$(LINT.c) -dirout=$(@D) -c $<
272
273dmod/%.ln kmod/%.ln: ../%.s
274	$(LINT.s) -dirout=$(@D) -c $<
275
276dmod/%.ln kmod/%.ln: ../../../common/modules/$(MODNAME)/%.c
277	$(LINT.c) -dirout=$(@D) -c $<
278
279dmod/%.ln kmod/%.ln: ../../../common/modules/$(MODNAME)/%.s
280	$(LINT.s) -dirout=$(@D) -c $<
281
282dmod/%.ln kmod/%.ln: $$(MODSRCS_DIR)/%.c
283	$(LINT.c) -dirout=$(@D) -c $<
284
285dmod/%.ln kmod/%.ln: $$(MODSRCS_DIR)/%.s
286	$(LINT.s) -dirout=$(@D) -c $<
287
288#
289# Installation targets
290#
291
292$(ROOT)/usr/lib/mdb/$(MDBTGT): $(ROOT)/usr/lib/mdb
293	$(INS.dir)
294
295$(ROOT)/usr/lib/mdb:
296	$(INS.dir)
297
298$(ROOT)/kernel/kmdb:
299	$(INS.dir)
300
301$(ROOTMOD)/$(MODULE): $(ROOTMOD)
302
303$(ROOTKMOD)/$(KMODULE): $(ROOTKMOD)
304
305kmod dmod:
306	-@mkdir -p $@
307