share/mk/bsd.obj.mk

   1 # $FreeBSD$
   2 #
   3 # The include file <bsd.obj.mk> handles creating the 'obj' directory
   4 # and cleaning up object files, etc.
   5 #
   6 # +++ variables +++
   7 #
   8 # CLEANDIRS     Additional directories to remove for the clean target.
   9 #
  10 # CLEANFILES    Additional files to remove for the clean target.
  11 #
  12 # MAKEOBJDIR    A pathname for the directory where the targets
  13 #               are built.  Note: MAKEOBJDIR is an *environment* variable
  14 #               and works properly only if set as an environment variable,
  15 #               not as a global or command line variable!
  16 #
  17 #               E.g. use `env MAKEOBJDIR=temp-obj make'
  18 #
  19 # MAKEOBJDIRPREFIX  Specifies somewhere other than /usr/obj to root the object
  20 #               tree.  Note: MAKEOBJDIRPREFIX is an *environment* variable
  21 #               and works properly only if set as an environment variable,
  22 #               not as a global or command line variable!
  23 #
  24 #               E.g. use `env MAKEOBJDIRPREFIX=/somewhere/obj make'
  25 #
  26 # NO_OBJ        Do not create object directories.  This should not be set
  27 #               if anything is built.
  28 #
  29 # +++ targets +++
  30 #
  31 #       clean:
  32 #               remove ${CLEANFILES}; remove ${CLEANDIRS} and all contents.
  33 #
  34 #       cleandir:
  35 #               remove the build directory (and all its contents) created by obj
  36 #
  37 #       obj:
  38 #               create build directory.
  39 #
  40
  41 .if !target(__<bsd.obj.mk>__)
  42 __<bsd.obj.mk>__:
  43 .include <bsd.own.mk>
  44
  45 .if ${MK_AUTO_OBJ} == "yes"
  46 # it is done by now
  47 objwarn:
  48 obj:
  49 CANONICALOBJDIR= ${.OBJDIR}
  50 .if defined(NO_OBJ)
  51 # but this makefile does not want it!
  52 .OBJDIR: ${.CURDIR}
  53 .endif
  54 # Handle special case where SRCS is full-pathed and requires
  55 # nested objdirs.  This duplicates some auto.obj.mk logic.
  56 .if (!empty(SRCS:M*/*) || !empty(DPSRCS:M*/*)) && \
  57     (${.TARGETS} == "" || ${.TARGETS:Nclean*:N*clean:Ndestroy*} != "")
  58 _wantdirs=      ${SRCS:M*/*:H} ${DPSRCS:M*/*:H}
  59 .if !empty(_wantdirs)
  60 _wantdirs:=     ${_wantdirs:O:u}
  61 _needdirs=
  62 .for _dir in ${_wantdirs}
  63 .if !exists(${.OBJDIR}/${_dir}/)
  64 _needdirs+=     ${_dir}
  65 .endif
  66 .endfor
  67 .endif
  68 .if !empty(_needdirs)
  69 #_mkneededdirs!=        umask ${OBJDIR_UMASK:U002}; ${Mkdirs} ${_needdirs}
  70 __objdir_made != umask ${OBJDIR_UMASK:U002}; ${Mkdirs}; \
  71         for dir in ${_needdirs}; do \
  72           dir=${.OBJDIR}/$${dir}; \
  73           ${ECHO_TRACE} "[Creating nested objdir $${dir}...]" >&2; \
  74           Mkdirs $${dir}; \
  75         done
  76 .endif
  77 .endif  # !empty(SRCS:M*/*) || !empty(DPSRCS:M*/*)
  78 .elif defined(MAKEOBJDIRPREFIX)
  79 CANONICALOBJDIR:=${MAKEOBJDIRPREFIX}${.CURDIR}
  80 .elif defined(MAKEOBJDIR) && ${MAKEOBJDIR:M/*} != ""
  81 CANONICALOBJDIR:=${MAKEOBJDIR}
  82 OBJTOP?= ${MAKEOBJDIR}
  83 .else
  84 CANONICALOBJDIR:=/usr/obj${.CURDIR}
  85 .endif
  86
  87 OBJTOP?= ${.OBJDIR:S,${.CURDIR},,}${SRCTOP}
  88
  89 #
  90 # Warn of unorthodox object directory.
  91 #
  92 # The following directories are tried in order for ${.OBJDIR}:
  93 #
  94 # 1.  ${MAKEOBJDIRPREFIX}/`pwd`
  95 # 2.  ${MAKEOBJDIR}
  96 # 3.  obj.${MACHINE}
  97 # 4.  obj
  98 # 5.  /usr/obj/`pwd`
  99 # 6.  ${.CURDIR}
 100 #
 101 # If ${.OBJDIR} is constructed using canonical cases 1 or 5, or
 102 # case 2 (using MAKEOBJDIR), don't issue a warning.  Otherwise,
 103 # issue a warning differentiating between cases 6 and (3 or 4).
 104 #
 105 objwarn:
 106 .if !defined(NO_OBJ) && ${.OBJDIR} != ${CANONICALOBJDIR} && \
 107     !(defined(MAKEOBJDIRPREFIX) && exists(${CANONICALOBJDIR}/)) && \
 108     !(defined(MAKEOBJDIR) && exists(${MAKEOBJDIR}/))
 109 .if ${.OBJDIR} == ${.CURDIR}
 110         @${ECHO} "Warning: Object directory not changed from original ${.CURDIR}"
 111 .elif exists(${.CURDIR}/obj.${MACHINE}/) || exists(${.CURDIR}/obj/)
 112         @${ECHO} "Warning: Using ${.OBJDIR} as object directory instead of\
 113                 canonical ${CANONICALOBJDIR}"
 114 .endif
 115 .endif
 116 beforebuild: objwarn
 117
 118 .if !defined(NO_OBJ)
 119 .if !target(obj)
 120 obj: .PHONY
 121         @if ! test -d ${CANONICALOBJDIR}/; then \
 122                 mkdir -p ${CANONICALOBJDIR}; \
 123                 if ! test -d ${CANONICALOBJDIR}/; then \
 124                         ${ECHO} "Unable to create ${CANONICALOBJDIR}."; \
 125                         exit 1; \
 126                 fi; \
 127                 ${ECHO} "${CANONICALOBJDIR} created for ${.CURDIR}"; \
 128         fi
 129 .for dir in ${SRCS:H:O:u} ${DPSRCS:H:O:u}
 130         @if ! test -d ${CANONICALOBJDIR}/${dir}/; then \
 131                 mkdir -p ${CANONICALOBJDIR}/${dir}; \
 132                 if ! test -d ${CANONICALOBJDIR}/${dir}/; then \
 133                         ${ECHO} "Unable to create ${CANONICALOBJDIR}/${dir}."; \
 134                         exit 1; \
 135                 fi; \
 136                 ${ECHO} "${CANONICALOBJDIR}/${dir} created for ${.CURDIR}"; \
 137         fi
 138 .endfor
 139 .endif
 140
 141 .if !target(objlink)
 142 objlink:
 143         @if test -d ${CANONICALOBJDIR}/; then \
 144                 rm -f ${.CURDIR}/obj; \
 145                 ln -s ${CANONICALOBJDIR} ${.CURDIR}/obj; \
 146         else \
 147                 echo "No ${CANONICALOBJDIR} to link to - do a make obj."; \
 148         fi
 149 .endif
 150 .endif # !defined(NO_OBJ)
 151
 152 #
 153 # where would that obj directory be?
 154 #
 155 .if !target(whereobj)
 156 whereobj:
 157         @echo ${.OBJDIR}
 158 .endif
 159
 160 .if ${CANONICALOBJDIR} != ${.CURDIR} && exists(${CANONICALOBJDIR}/)
 161 cleanobj:
 162         @-rm -rf ${CANONICALOBJDIR}
 163 .else
 164 cleanobj: clean cleandepend
 165 .endif
 166         @if [ -L ${.CURDIR}/obj ]; then rm -f ${.CURDIR}/obj; fi
 167
 168 # Tell bmake not to look for generated files via .PATH
 169 NOPATH_FILES+=  ${CLEANFILES}
 170 .if !empty(NOPATH_FILES)
 171 .NOPATH: ${NOPATH_FILES}
 172 .endif
 173
 174 .if !target(clean)
 175 clean:
 176 .if defined(CLEANFILES) && !empty(CLEANFILES)
 177         rm -f ${CLEANFILES}
 178 .endif
 179 .if defined(CLEANDIRS) && !empty(CLEANDIRS)
 180         -rm -rf ${CLEANDIRS}
 181 .endif
 182 .endif
 183 .ORDER: clean all
 184
 185 cleandir: cleanobj
 186
 187 .include <bsd.subdir.mk>
 188
 189 .if make(destroy*) && defined(OBJROOT)
 190 # this (rm -rf objdir) is much faster and more reliable than cleaning.
 191
 192 # just in case we are playing games with these...
 193 _OBJDIR?= ${.OBJDIR}
 194 _CURDIR?= ${.CURDIR}
 195
 196 # destroy almost everything
 197 destroy: destroy-all
 198 destroy-all:
 199
 200 # just remove our objdir
 201 destroy-arch: .NOMETA
 202 .if ${_OBJDIR} != ${_CURDIR}
 203         cd ${_CURDIR} && rm -rf ${_OBJDIR}
 204 .endif
 205
 206 .if defined(HOST_OBJTOP)
 207 destroy-host: destroy.host
 208 destroy.host: .NOMETA
 209         cd ${_CURDIR} && rm -rf ${HOST_OBJTOP}/${RELDIR:N.}
 210 .endif
 211
 212 .if make(destroy-all) && ${RELDIR} == "."
 213 destroy-all: destroy-stage
 214 .endif
 215
 216 # remove the stage tree
 217 destroy-stage: .NOMETA
 218 .if defined(STAGE_ROOT)
 219         cd ${_CURDIR} && rm -rf ${STAGE_ROOT}
 220 .endif
 221
 222 # allow parallel destruction
 223 _destroy_machine_list = common host ${ALL_MACHINE_LIST}
 224 .for m in ${_destroy_machine_list:O:u}
 225 destroy-all: destroy.$m
 226 .if !target(destroy.$m)
 227 destroy.$m: .NOMETA
 228 .if ${_OBJDIR} != ${_CURDIR}
 229         cd ${_CURDIR} && rm -rf ${OBJROOT}$m*/${RELDIR:N.}
 230 .endif
 231 .endif
 232 .endfor
 233
 234 .endif
 235
 236 .endif # !target(__<bsd.obj.mk>__)