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 defined(MAKEOBJDIRPREFIX)
  46 CANONICALOBJDIR:=${MAKEOBJDIRPREFIX}${.CURDIR}
  47 .elif defined(MAKEOBJDIR) && ${MAKEOBJDIR:M/*} != ""
  48 CANONICALOBJDIR:=${MAKEOBJDIR}
  49 .else
  50 CANONICALOBJDIR:=/usr/obj${.CURDIR}
  51 .endif
  52
  53 .if defined(.PARSEDIR) && !defined(NO_OBJ) && !defined(NO_AUTO_OBJ)
  54 .if ${MK_AUTO_OBJ} == "yes"
  55 __objdir?= ${CANONICALOBJDIR}
  56 # this is what auto.obj.mk wants to see
  57 MKOBJDIRS=auto
  58 .include "auto.obj.mk"
  59 .endif
  60 .endif
  61
  62 #
  63 # Warn of unorthodox object directory.
  64 #
  65 # The following directories are tried in order for ${.OBJDIR}:
  66 #
  67 # 1.  ${MAKEOBJDIRPREFIX}/`pwd`
  68 # 2.  ${MAKEOBJDIR}
  69 # 3.  obj.${MACHINE}
  70 # 4.  obj
  71 # 5.  /usr/obj/`pwd`
  72 # 6.  ${.CURDIR}
  73 #
  74 # If ${.OBJDIR} is constructed using canonical cases 1 or 5, or
  75 # case 2 (using MAKEOBJDIR), don't issue a warning.  Otherwise,
  76 # issue a warning differentiating between cases 6 and (3 or 4).
  77 #
  78 objwarn:
  79 .if !defined(NO_OBJ) && ${.OBJDIR} != ${CANONICALOBJDIR} && \
  80     !(defined(MAKEOBJDIRPREFIX) && exists(${CANONICALOBJDIR}/)) && \
  81     !(defined(MAKEOBJDIR) && exists(${MAKEOBJDIR}/))
  82 .if ${.OBJDIR} == ${.CURDIR}
  83         @${ECHO} "Warning: Object directory not changed from original ${.CURDIR}"
  84 .elif exists(${.CURDIR}/obj.${MACHINE}/) || exists(${.CURDIR}/obj/)
  85         @${ECHO} "Warning: Using ${.OBJDIR} as object directory instead of\
  86                 canonical ${CANONICALOBJDIR}"
  87 .endif
  88 .endif
  89
  90 .if !defined(NO_OBJ)
  91 .if !target(obj)
  92 obj: .PHONY
  93         @if ! test -d ${CANONICALOBJDIR}/; then \
  94                 mkdir -p ${CANONICALOBJDIR}; \
  95                 if ! test -d ${CANONICALOBJDIR}/; then \
  96                         ${ECHO} "Unable to create ${CANONICALOBJDIR}."; \
  97                         exit 1; \
  98                 fi; \
  99                 ${ECHO} "${CANONICALOBJDIR} created for ${.CURDIR}"; \
 100         fi
 101 .endif
 102
 103 .if !target(objlink)
 104 objlink:
 105         @if test -d ${CANONICALOBJDIR}/; then \
 106                 rm -f ${.CURDIR}/obj; \
 107                 ln -s ${CANONICALOBJDIR} ${.CURDIR}/obj; \
 108         else \
 109                 echo "No ${CANONICALOBJDIR} to link to - do a make obj."; \
 110         fi
 111 .endif
 112 .endif # !defined(NO_OBJ)
 113
 114 #
 115 # where would that obj directory be?
 116 #
 117 .if !target(whereobj)
 118 whereobj:
 119         @echo ${.OBJDIR}
 120 .endif
 121
 122 .if ${CANONICALOBJDIR} != ${.CURDIR} && exists(${CANONICALOBJDIR}/)
 123 cleanobj:
 124         @-rm -rf ${CANONICALOBJDIR}
 125 .else
 126 cleanobj: clean cleandepend
 127 .endif
 128         @if [ -L ${.CURDIR}/obj ]; then rm -f ${.CURDIR}/obj; fi
 129
 130 # Tell bmake not to look for generated files via .PATH
 131 NOPATH_FILES+=  ${CLEANFILES}
 132 .if !empty(NOPATH_FILES)
 133 .NOPATH: ${NOPATH_FILES}
 134 .endif
 135
 136 .if !target(clean)
 137 clean:
 138 .if defined(CLEANFILES) && !empty(CLEANFILES)
 139         rm -f ${CLEANFILES}
 140 .endif
 141 .if defined(CLEANDIRS) && !empty(CLEANDIRS)
 142         -rm -rf ${CLEANDIRS}
 143 .endif
 144 .endif
 145
 146 cleandir: cleanobj
 147
 148 .include <bsd.subdir.mk>
 149
 150 .if make(destroy*) && defined(OBJROOT)
 151 # this is much faster and more reliable than cleaning.
 152
 153 # just in case we are playing games with these...
 154 _OBJDIR?= ${.OBJDIR}
 155 _CURDIR?= ${.CURDIR}
 156
 157 # destroy almost everything
 158 destroy: destroy-all
 159 destroy-all:
 160
 161 # just remove our objdir
 162 destroy-arch: .NOMETA
 163 .if ${_OBJDIR} != ${_CURDIR}
 164         cd ${_CURDIR} && rm -rf ${_OBJDIR}
 165 .endif
 166
 167 .if defined(HOST_OBJTOP)
 168 destroy-host: destroy.host
 169 destroy.host: .NOMETA
 170         cd ${_CURDIR} && rm -rf ${HOST_OBJTOP}/${RELDIR:N.}
 171 .endif
 172
 173 .if make(destroy-all) && ${RELDIR} == "."
 174 destroy-all: destroy-stage
 175 .endif
 176
 177 # remove the stage tree
 178 destroy-stage: .NOMETA
 179 .if defined(STAGE_ROOT)
 180         cd ${_CURDIR} && rm -rf ${STAGE_ROOT}
 181 .endif
 182
 183 # allow parallel destruction
 184 _destroy_machine_list = common host ${ALL_MACHINE_LIST}
 185 .for m in ${_destroy_machine_list:O:u}
 186 destroy-all: destroy.$m
 187 .if !target(destroy.$m)
 188 destroy.$m: .NOMETA
 189 .if ${_OBJDIR} != ${_CURDIR}
 190         cd ${_CURDIR} && rm -rf ${OBJROOT}$m*/${RELDIR:N.}
 191 .endif
 192 .endif
 193 .endfor
 194
 195 .endif
 196
 197 .endif # !target(__<bsd.obj.mk>__)