5324 .comment section on kmdb kmods is not set properly
[illumos-gate.git] / usr / src / cmd / mdb / Makefile.module
bloba1b66e05fb4ace4061343303861216eb4c0d2731
2 # CDDL HEADER START
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.
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.
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]
19 # CDDL HEADER END
22 # Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23 # Use is subject to license terms.
25 # Copyright (c) 2013 by Delphix. All rights reserved.
28 .KEEP_STATE:
29 .SUFFIXES:
31 include $(SRC)/cmd/mdb/Makefile.tools
33 $(KMOD_SOURCES_DIFFERENT)KMODSRCS = $(MODSRCS)
35 MODOBJS = $(MODSRCS:%.c=dmod/%.o)
36 KMODOBJS = $(KMODSRCS:%.c=kmod/%.o)
38 MODNAME = $(MODULE:%.so=%)
39 KMODULE = $(MODNAME)
41 MODFILE = dmod/$(MODULE)
42 KMODFILE = kmod/$(KMODULE)
45 # The mess below is designed to pick the right set of objects to build and/or
46 # lint.  We have three flavors:
48 #  1. proc and raw modules.  Only $(MODOBJS) are built.
49 #  2. kvm modules for systems without kmdb.  Only $(MODOBJS) are built.
50 #  3. kvm modules for systems with kmdb.  $(MODOBJS) and $(KMODOBJS) are built.
52 # Complicating matters, we'd like to make the distinction between 2 and 3 before
53 # this Makefile is loaded.  By default, we'll assume that all kvm modules should
54 # be built for kmdb.  If, however, the user sets $(MODULE_BUILD_TYPE) to `mdb',
55 # the kmdb variant of the module won't be built.
58 # Which flavors are to be built?
59 TARGETS_kvm_type_       = both  # Build both if $(MODULE_BUILD_TYPE) is unset
60 TARGETS_kvm_type_kmdb   = both
61 TARGETS_kvm_type_mdb    = mdb
62 TARGETS_kvm_type        = $(TARGETS_kvm_type_$(MODULE_BUILD_TYPE))
64 # What should we build?
65 TARGETS_kvm_kmdb        = $(KMODFILE)
66 TARGETS_kvm_mdb         = $(MODFILE)
67 TARGETS_kvm_both        = $(TARGETS_kvm_mdb) $(TARGETS_kvm_kmdb)
68 TARGETS_kvm             = $(TARGETS_kvm_$(TARGETS_kvm_type))
69 TARGETS_proc            = $(MODFILE)
70 TARGETS_raw             = $(MODFILE)
71 TARGETS                 = $(TARGETS_$(MDBTGT))
73 # Where should we install that which we've built?
74 ROOTTGTS_kvm_type       = $(TARGETS_kvm_type)   # overridden by mdb_ks
75 ROOTTGTS_kvm_kmdb       = $(ROOTKMOD)/$(KMODULE)
76 ROOTTGTS_kvm_mdb        = $(ROOTMOD)/$(MODULE)
77 ROOTTGTS_kvm_both       = $(ROOTTGTS_kvm_mdb) $(ROOTTGTS_kvm_kmdb)
78 ROOTTGTS_kvm            = $(ROOTTGTS_kvm_$(ROOTTGTS_kvm_type))
79 ROOTTGTS_proc           = $(ROOTMOD)/$(MODULE)
80 ROOTTGTS_raw            = $(ROOTMOD)/$(MODULE)
81 ROOTTGTS                = $(ROOTTGTS_$(MDBTGT))
83 # What should we lint?
84 KLINTOBJS               = $(KMODOBJS:%.o=%.ln)
85 LINTOBJS                = $(MODOBJS:%.o=%.ln)
87 LINTFILES_kvm_type      = $(TARGETS_kvm_type)
88 LINTFILES_kvm_both      = $(KLINTOBJS) $(LINTOBJS)
89 LINTFILES_kvm_mdb       = $(LINTOBJS)
90 LINTFILES_kvm           = $(LINTFILES_kvm_$(LINTFILES_kvm_type))
91 LINTFILES_proc          = $(LINTOBJS)
92 LINTFILES_raw           = $(LINTOBJS)
93 LINTFILES               = $(LINTFILES_$(MDBTGT))
95 kvm_TGTFLAGS            = -D_KERNEL
96 proc_TGTFLAGS           = -D_USER
98 C99MODE                 = $(C99_ENABLE)
100 CFLAGS                  += $(CCVERBOSE)
101 CFLAGS64                += $(CCVERBOSE)
102 CPPFLAGS                += $($(MDBTGT)_TGTFLAGS) -I../../../common
103 LDFLAGS                 += $(ZTEXT)
104 LDFLAGS64               += $(ZTEXT)
106 # Module type-specific compiler flags
107 $(MODOBJS) :=                   CFLAGS += $(C_BIGPICFLAGS) $(XREGSFLAG)
108 $(MODOBJS) :=                   CFLAGS64 += $(C_BIGPICFLAGS) $(XREGSFLAG)
109 $(KMODOBJS) $(KLINTOBJS) :=     CPPFLAGS += -D_KMDB
110 $(KMODOBJS) :=                  V9CODESIZE = $(CCABS32)
111 $(KMODOBJS) :=                  DTS_ERRNO =
113 # Modules aren't allowed to export symbols
114 MAPFILE         = $(SRC)/cmd/mdb/common/modules/conf/mapfile
116 # Modules typically make external references.  To provide for -zdefs use
117 # and clean ldd(1) processing, explicitly define all external references.
118 MAPFILE-EXT     = $(SRC)/cmd/mdb/common/modules/conf/mapfile-extern
121 # kmdb is a kernel module, so we'll use the kernel's build flags.
122 $(KMODOBJS) := CFLAGS += $(STAND_FLAGS_32)
123 $(KMODOBJS) := CFLAGS64 += $(STAND_FLAGS_64)
126 # Override this to pull source files from another directory
128 MODSRCS_DIR = ../../../common/modules/genunix
130 all: $$(TARGETS)
132 install: all $$(ROOTTGTS)
134 dmods: install
136 clean.lint:
137         $(RM) $(LINTFILES) $(MODSRCS:.c=.ln)
139 clean:
140         $(RM) $(MODOBJS) $(KMODOBJS) $(CLEANFILES)
142 clobber: clean clean.lint
143         $(RM) $(MODFILE) $(KMODFILE) $(CLOBBERFILES)
145 lint: $$(LINTFILES)
147 .NO_PARALLEL:
148 .PARALLEL: $(MODOBJS) $(KMODOBJS) mdb_tgt kmdb_tgt dmod kmod \
149         $(TARGETS) $(LINTFILES)
151 $(MODFILE): dmod .WAIT $(MODOBJS) $$(MAPFILE-EXT)
152         $(LINK.c) $(ZDEFS) $(ZIGNORE) $(MAPFILE-EXT:%=-M%) $(GSHARED) \
153             $(MODOBJS) -o $@ $(LDLIBS) -lc
154         $(CTFMERGE) -L VERSION -o $@ $(MODOBJS)
155         $(POST_PROCESS_SO)
158 # kmdb dmods must *not* stray from the module API.  To ensure that they don't,
159 # we try to link them, at build time, against an object that exports the symbols
160 # that they can legally use.  The link test object is, however, only built when
161 # kmdb itself is built.  Requiring module developers to build kmdb first would
162 # be painful, so by default, module-level builds don't do the link test (the
163 # $(POUND_SIGN) assignment below takes care of that).  Builds of the entire
164 # tree can, however, guarantee the construction of kmdb first, and as such can
165 # override the setting of $(KMDB_LINKTEST_ENABLE).  This override causes the
166 # link test to be run.
168 # Developers wanting to force a link test for a single module can use the
169 # `linktest' target from within a module directory.
171 LINKTESTOBJ = $(KMDBDIR)/kmdb_modlinktest.o
173 KMDB_LINKTEST = \
174         $(LD) $(ZDEFS) -dy -r -o $@.linktest $(KMODOBJS) \
175         $(STANDOBJS) $(LINKTESTOBJ) && \
176         $(RM) $@.linktest
178 KMDB_LINKTEST_ENABLE=$(POUND_SIGN)
179 $(KMDB_LINKTEST_ENABLE)KMDB_LINKTEST_CMD = $(KMDB_LINKTEST)
182 # Ensure that dmods don't use floating point
184 KMDB_FPTEST_CMD = $(KMDB_FPTEST)
186 $(KMODFILE): kmod .WAIT $(KMODOBJS) $(MAPFILE)
187         $(LD) -dy -r $(MAPFILE:%=-M%) -Nmisc/kmdbmod -o $@ $(KMODOBJS) \
188         $(STANDOBJS)
189         $(KMDB_LINKTEST_CMD)
190         $(KMDB_FPTEST_CMD)
191         $(CTFMERGE) -f -L VERSION -o $@ $(KMODOBJS)
192         $(POST_PROCESS)
193         $(SETDYNFLAG) -f DF_1_NOKSYMS $@
195 linktest: linktest_check .WAIT kmod .WAIT $(KMODOBJS)
196         $(KMDB_LINKTEST)
198 linktest_check:
199         @if [ "$(MDBTGT)" != "kvm" ] ; then \
200                 echo "ERROR: linktest is not supported non-kvm/disasm dmods" \
201                     >&2 ; \
202                 exit 1 ; \
203         fi
206 # Dynamic rules for object construction
208 dmod/%.o kmod/%.o: %.c
209         $(COMPILE.c) -o $@ $<
210         $(CTFCONVERT_O)
212 dmod/%.o kmod/%.o: ../%.c
213         $(COMPILE.c) -o $@ $<
214         $(CTFCONVERT_O)
216 dmod/%.o kmod/%.o: ../../../common/modules/$(MODNAME)/%.c
217         $(COMPILE.c) -o $@ $<
218         $(CTFCONVERT_O)
220 dmod/%.o kmod/%.o: $$(MODSRCS_DIR)/%.c
221         $(COMPILE.c) -o $@ $<
222         $(CTFCONVERT_O)
225 # Lint
227 dmod/%.ln kmod/%.ln: %.c
228         $(LINT.c) -dirout=$(@D) -c $<
230 dmod/%.ln kmod/%.ln: ../%.c
231         $(LINT.c) -dirout=$(@D) -c $<
233 dmod/%.ln kmod/%.ln: ../../../common/modules/$(MODNAME)/%.c
234         $(LINT.c) -dirout=$(@D) -c $<
236 dmod/%.ln kmod/%.ln: $$(MODSRCS_DIR)/%.c
237         $(LINT.c) -dirout=$(@D) -c $<
240 # Installation targets
243 $(ROOT)/usr/lib/mdb/$(MDBTGT): $(ROOT)/usr/lib/mdb
244         $(INS.dir)
246 $(ROOT)/usr/lib/mdb:
247         $(INS.dir)
249 $(ROOT)/kernel/kmdb:
250         $(INS.dir)
252 $(ROOTMOD)/$(MODULE): $(ROOTMOD)
254 $(ROOTKMOD)/$(KMODULE): $(ROOTKMOD)
256 kmod dmod:
257         -@mkdir -p $@