883N/A#

883N/A# CDDL HEADER START

883N/A#

883N/A# The contents of this file are subject to the terms of the

883N/A# Common Development and Distribution License (the "License").

883N/A# You may not use this file except in compliance with the License.

883N/A#

883N/A# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

883N/A# or http://www.opensolaris.org/os/licensing.

883N/A# See the License for the specific language governing permissions

883N/A# and limitations under the License.

883N/A#

883N/A# When distributing Covered Code, include this CDDL HEADER in each

883N/A# file and include the License file at usr/src/OPENSOLARIS.LICENSE.

883N/A# If applicable, add the following below this CDDL HEADER, with the

883N/A# fields enclosed by brackets "[]" replaced with your own identifying

883N/A# information: Portions Copyright [yyyy] [name of copyright owner]

883N/A#

883N/A# CDDL HEADER END

883N/A#

883N/A# Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.

883N/A#

3996N/A

883N/A#

883N/A# Rules and Macros for generating an IPS package manifest and publishing an

883N/A# IPS package to a pkg depot.

883N/A#

883N/A# To use these rules, include ../make-rules/ips.mk in your Makefile

883N/A# and define an "install" target appropriate to building your component.

883N/A# Ex:

883N/A#

883N/A# install: $(BUILD_DIR)/build/$(MACH32)/.installed \

1273N/A# $(BUILD_DIR)/build/$(MACH64)/.installed

883N/A#

4561N/A# This set of rules makes the "publish" target the default target for make(1)

4561N/A#

4561N/A

4561N/APKGDEPEND = /usr/bin/pkgdepend

4561N/APKGFMT = /usr/bin/pkgfmt

4561N/APKGMOGRIFY = /usr/bin/pkgmogrify

4561N/APKGSEND = /usr/bin/pkgsend

883N/APKGLINT = /usr/bin/pkglint

883N/APKGMANGLE = $(WS_TOOLS)/userland-mangler

883N/A

883N/A# Package headers should all pretty much follow the same format

883N/AMETADATA_TEMPLATE = $(WS_TOP)/transforms/manifest-metadata-template

883N/ACOPYRIGHT_TEMPLATE = $(WS_TOP)/transforms/copyright-template

883N/A

1653N/A# order is important

883N/AGENERATE_TRANSFORMS += $(WS_TOP)/transforms/generate-cleanup

956N/A

883N/APKGMOGRIFY_TRANSFORMS += $(WS_TOP)/transforms/libtool-drop

883N/A

883N/ACOMPARISON_TRANSFORMS += $(WS_TOP)/transforms/comparison-cleanup

883N/ACOMPARISON_TRANSFORMS += $(PKGMOGRIFY_TRANSFORMS)

883N/A

883N/ALICENSE_TRANSFORMS = $(WS_TOP)/transforms/license-changes

883N/A

883N/A# order is important

1574N/APUBLISH_TRANSFORMS += $(LICENSE_TRANSFORMS)

1574N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/variant-cleanup

1574N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/autopyc

883N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/defaults

883N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/actuators

883N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/devel

883N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/docs

883N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/locale

883N/APUBLISH_TRANSFORMS += $(PKGMOGRIFY_TRANSFORMS)

883N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/publish-cleanup

883N/A

883N/APKG_MACROS += MACH=$(MACH)

883N/APKG_MACROS += MACH32=$(MACH32)

887N/APKG_MACROS += MACH64=$(MACH64)

887N/APKG_MACROS += PUBLISHER=$(PUBLISHER)

887N/APKG_MACROS += PUBLISHER_LOCALIZABLE=$(PUBLISHER_LOCALIZABLE)

913N/APKG_MACROS += CONSOLIDATION=$(CONSOLIDATION)

913N/APKG_MACROS += BUILD_VERSION=$(BUILD_VERSION)

913N/APKG_MACROS += SOLARIS_VERSION=$(SOLARIS_VERSION)

913N/APKG_MACROS += OS_VERSION=$(OS_VERSION)

883N/APKG_MACROS += HUMAN_VERSION=$(HUMAN_VERSION)

3996N/APKG_MACROS += IPS_COMPONENT_VERSION=$(IPS_COMPONENT_VERSION)

PKG_MACROS += COMPONENT_VERSION=$(COMPONENT_VERSION)

PKG_MACROS += COMPONENT_PROJECT_URL=$(COMPONENT_PROJECT_URL)

PKG_MACROS += COMPONENT_ARCHIVE_URL=$(COMPONENT_ARCHIVE_URL)

PKG_MACROS += COMPONENT_HG_URL=$(COMPONENT_HG_URL)

PKG_MACROS += COMPONENT_HG_REV=$(COMPONENT_HG_REV)

PKG_MACROS += COMPONENT_NAME=$(COMPONENT_NAME)

PKG_MACROS += TPNO=$(TPNO)

PKG_OPTIONS += $(PKG_MACROS:%=-D %)

MANGLED_DIR = $(PROTO_DIR)/mangled

PKG_PROTO_DIRS += $(MANGLED_DIR) $(PROTO_DIR) $(@D) $(COMPONENT_DIR) $(COMPONENT_SRC)

MANIFEST_BASE = $(BUILD_DIR)/manifest-$(MACH)

CANONICAL_MANIFESTS = $(wildcard *.p5m)

# Look for manifests which need to be duplicated for each version of python.

ifeq ($(findstring -PYVER,$(CANONICAL_MANIFESTS)),-PYVER)

UNVERSIONED_MANIFESTS = $(filter-out %-GENFRAG.p5m,$(filter-out %-PYVER.p5m,$(CANONICAL_MANIFESTS)))

PY_MANIFESTS = $(filter %-PYVER.p5m,$(CANONICAL_MANIFESTS))

PYV_MANIFESTS = $(foreach v,$(shell echo $(PYTHON_VERSIONS) | tr -d .),$(shell echo $(PY_MANIFESTS) | sed -e 's/-PYVER.p5m/-$(v).p5m/g'))

PYNV_MANIFESTS = $(shell echo $(PY_MANIFESTS) | sed -e 's/-PYVER//')

else

UNVERSIONED_MANIFESTS = $(CANONICAL_MANIFESTS)

endif

# Look for manifests which need to be duplicated for each version of perl.

ifeq ($(findstring -PERLVER,$(UNVERSIONED_MANIFESTS)),-PERLVER)

NOPERL_MANIFESTS = $(filter-out %-GENFRAG.p5m,$(filter-out %-PERLVER.p5m,$(UNVERSIONED_MANIFESTS)))

PERL_MANIFESTS = $(filter %-PERLVER.p5m,$(UNVERSIONED_MANIFESTS))

PERLV_MANIFESTS = $(foreach v,$(shell echo $(PERL_VERSIONS) | tr -d .),$(shell echo $(PERL_MANIFESTS) | sed -e 's/-PERLVER.p5m/-$(v).p5m/g'))

PERLNV_MANIFESTS = $(shell echo $(PERL_MANIFESTS) | sed -e 's/-PERLVER//')

else

NOPERL_MANIFESTS = $(UNVERSIONED_MANIFESTS)

endif

VERSIONED_MANIFESTS = \

$(PYV_MANIFESTS) $(PYNV_MANIFESTS) \

$(PERLV_MANIFESTS) $(PERLNV_MANIFESTS) \

$(NOPERL_MANIFESTS)

GENERATED = $(MANIFEST_BASE)-generated

COMBINED = $(MANIFEST_BASE)-combined

MANIFESTS = $(VERSIONED_MANIFESTS:%=$(MANIFEST_BASE)-%)

DEPENDED=$(VERSIONED_MANIFESTS:%.p5m=$(MANIFEST_BASE)-%.depend)

RESOLVED=$(VERSIONED_MANIFESTS:%.p5m=$(MANIFEST_BASE)-%.depend.res)

PUBLISHED=$(RESOLVED:%.depend.res=%.published)

COPYRIGHT_FILE ?= $(COMPONENT_NAME)-$(COMPONENT_VERSION).copyright

IPS_COMPONENT_VERSION ?= $(COMPONENT_VERSION)

.DEFAULT: publish

.SECONDARY:

# allow publishing to be overridden, such as when

# a package is for one architecture only.

PUBLISH_STAMP ?= $(BUILD_DIR)/.published-$(MACH)

publish: build install $(PUBLISH_STAMP)

sample-manifest: $(GENERATED).p5m

$(GENERATED).p5m: install

$(PKGSEND) generate $(PKG_HARDLINKS:%=--target %) $(PROTO_DIR) | \

$(PKGMOGRIFY) $(PKG_OPTIONS) /dev/fd/0 $(GENERATE_TRANSFORMS) | \

sed -e '/^$$/d' -e '/^#.*$$/d' | $(PKGFMT) | \

cat $(METADATA_TEMPLATE) - >$@

# copy the canonical manifest(s) to the build tree

$(MANIFEST_BASE)-%.generate: %.p5m canonical-manifests

cat $(METADATA_TEMPLATE) $< >$@

# The text of a transform that will emit a dependency conditional on the

# presence of a particular version of a runtime, which will then draw in the

# runtime-version-specific version of the package we're operating on. $(1) is

# the name of the runtime package, and $(2) is the version suffix.

mkgeneric = \

echo "<transform set name=pkg.fmri value=(?:pkg:/)?(.+)-\#\#\#@(.*)" \

"-> emit depend nodrop=true type=conditional" \

"predicate=$(1)-$(2) fmri=%<1>-$(2)@%<2>>" >> $@;

# Define and execute a macro that generates a rule to create a manifest for a

# python module specific to a particular version of the python runtime.

define python-manifest-rule

$(MANIFEST_BASE)-%-$(shell echo $(1) | tr -d .).p5m: %-PYVER.p5m

$(PKGMOGRIFY) -D PYVER=$(1) -D PYV=$(shell echo $(1) | tr -d .) $$< > $$@

endef

$(foreach ver,$(PYTHON_VERSIONS),$(eval $(call python-manifest-rule,$(ver))))

# A rule to create a helper transform package for python, that will insert the

# appropriate conditional dependencies into a python library's

# runtime-version-generic package to pull in the version-specific bits when the

# corresponding version of python is on the system.

$(WS_TOP)/transforms/mkgeneric-python: $(WS_TOP)/make-rules/shared-macros.mk

$(RM) $@

$(foreach ver,$(shell echo $(PYTHON_VERSIONS) | tr -d .), \

$(call mkgeneric,runtime/python,$(ver)))

# Build Python version-wrapping manifests from the generic version.

$(MANIFEST_BASE)-%.p5m: %-PYVER.p5m $(WS_TOP)/transforms/mkgeneric-python

$(PKGMOGRIFY) -D PYV=### $(WS_TOP)/transforms/mkgeneric-python \

$(WS_TOP)/transforms/mkgeneric $< > $@

if [ -f $*-GENFRAG.p5m ]; then cat $*-GENFRAG.p5m >> $@; fi

# Define and execute a macro that generates a rule to create a manifest for a

# perl module specific to a particular version of the perl runtime.

define perl-manifest-rule

$(MANIFEST_BASE)-%-$(shell echo $(1) | tr -d .).p5m: %-PERLVER.p5m

$(PKGMOGRIFY) -D PERLVER=$(1) -D PLV=$(shell echo $(1) | tr -d .) \

-D PERL_ARCH=$(call PERL_ARCH_FUNC,$(PERL.$(1))) $$< > $$@

endef

$(foreach ver,$(PERL_VERSIONS),$(eval $(call perl-manifest-rule,$(ver))))

# A rule to create a helper transform package for perl, that will insert the

# appropriate conditional dependencies into a perl library's

# runtime-version-generic package to pull in the version-specific bits when the

# corresponding version of perl is on the system.

$(WS_TOP)/transforms/mkgeneric-perl: $(WS_TOP)/make-rules/shared-macros.mk

$(RM) $@

$(foreach ver,$(shell echo $(PERL_VERSIONS) | tr -d .), \

$(call mkgeneric,runtime/perl,$(ver)))

# Build Perl version-wrapping manifests from the generic version.

$(MANIFEST_BASE)-%.p5m: %-PERLVER.p5m $(WS_TOP)/transforms/mkgeneric-perl

$(PKGMOGRIFY) -D PLV=### $(WS_TOP)/transforms/mkgeneric-perl \

$(WS_TOP)/transforms/mkgeneric $< > $@

if [ -f $*-GENFRAG.p5m ]; then cat $*-GENFRAG.p5m >> $@; fi

# mogrify non-parameterized manifests

$(MANIFEST_BASE)-%.mogrified: %.p5m $(BUILD_DIR)

$(PKGMOGRIFY) $(PKG_OPTIONS) $< \

$(PUBLISH_TRANSFORMS) | \

sed -e '/^$$/d' -e '/^#.*$$/d' | uniq >$@

# mogrify parameterized manifests

$(MANIFEST_BASE)-%.mogrified: $(MANIFEST_BASE)-%.p5m $(BUILD_DIR)

$(PKGMOGRIFY) $(PKG_OPTIONS) $< \

$(PUBLISH_TRANSFORMS) | \

sed -e '/^$$/d' -e '/^#.*$$/d' | uniq >$@

# mangle the file contents

$(BUILD_DIR) $(MANGLED_DIR):

$(MKDIR) $@

PKGMANGLE_OPTIONS = -D $(MANGLED_DIR) $(PKG_PROTO_DIRS:%=-d %)

$(MANIFEST_BASE)-%.mangled: $(MANIFEST_BASE)-%.mogrified $(MANGLED_DIR)

$(PKGMANGLE) $(PKGMANGLE_OPTIONS) -m $< >$@

# generate dependencies

PKGDEPEND_GENERATE_OPTIONS = -m $(PKG_PROTO_DIRS:%=-d %)

$(MANIFEST_BASE)-%.depend: $(MANIFEST_BASE)-%.mangled

$(PKGDEPEND) generate $(PKGDEPEND_GENERATE_OPTIONS) $< >$@

# These files should contain a list of packages that the component is known to

# depend on. Using resolve.deps is not required, but significantly speeds up

# the "pkg resolve" step.

EXTDEPFILES = $(wildcard $(sort $(addsuffix ../resolve.deps, $(dir $(DEPENDED)))))

# This is a target that should only be run by hand, and not something that

# .resolved-$(MACH) should depend on.

sample-resolve.deps:

@echo "<transform depend type=(require|require-any) -> print %(fmri)>" > rd-trans

@for i in build/*.depend; do \

$(PKGMOGRIFY) -O /dev/null $$i rd-trans | tr " " "\n" | sort -u > m1; \

$(PKGMOGRIFY) -O /dev/null $$i.res rd-trans | tr " " "\n" | sort -u > m2; \

comm -13 m1 m2; \

done | sed -e 's/@[^ ]*//g' -e 's,pkg:/,,g' | sort -u > resolve.deps

@$(RM) rd-trans m1 m2

@if [[ ! -s resolve.deps ]]; then \

echo "No computed dependencies found; removing empty resolve.deps."; \

$(RM) resolve.deps; \

fi

# resolve the dependencies all at once

$(BUILD_DIR)/.resolved-$(MACH): $(DEPENDED)

$(PKGDEPEND) resolve $(EXTDEPFILES:%=-e %) -m $(DEPENDED)

$(TOUCH) $@

# lint the manifests all at once

$(BUILD_DIR)/.linted-$(MACH): $(BUILD_DIR)/.resolved-$(MACH)

@echo "VALIDATING MANIFEST CONTENT: $(RESOLVED)"

$(ENV) PYTHONPATH=$(WS_TOOLS)/python PROTO_PATH="$(PKG_PROTO_DIRS)"\

$(PKGLINT) $(CANONICAL_REPO:%=-c $(WS_LINT_CACHE)) \

-f $(WS_TOOLS)/pkglintrc $(RESOLVED)

$(TOUCH) $@

# published

PKGSEND_PUBLISH_OPTIONS = -s $(PKG_REPO) publish --fmri-in-manifest

PKGSEND_PUBLISH_OPTIONS += $(PKG_PROTO_DIRS:%=-d %)

PKGSEND_PUBLISH_OPTIONS += -T \*.py

$(MANIFEST_BASE)-%.published: $(MANIFEST_BASE)-%.depend.res $(BUILD_DIR)/.linted-$(MACH)

$(PKGSEND) $(PKGSEND_PUBLISH_OPTIONS) $<

$(PKGFMT) <$< >$@

$(BUILD_DIR)/.published-$(MACH): $(PUBLISHED)

$(TOUCH) $@

print-package-names: canonical-manifests

@cat $(VERSIONED_MANIFESTS) $(WS_TOP)/transforms/print-pkgs | \

$(PKGMOGRIFY) $(PKG_OPTIONS) /dev/fd/0 | \

sed -e '/^$$/d' -e '/^#.*$$/d' | sort -u

print-package-paths: canonical-manifests

@cat $(VERSIONED_MANIFESTS) $(WS_TOP)/transforms/print-paths | \

$(PKGMOGRIFY) $(PKG_OPTIONS) /dev/fd/0 | \

sed -e '/^$$/d' -e '/^#.*$$/d' | sort -u

install-packages: publish

@if [ $(IS_GLOBAL_ZONE) = 0 -o x$(ROOT) != x ]; then \

cat $(VERSIONED_MANIFESTS) $(WS_TOP)/transforms/print-paths | \

$(PKGMOGRIFY) $(PKG_OPTIONS) /dev/fd/0 | \

sed -e '/^$$/d' -e '/^#.*$$/d' -e 's;/;;' | sort -u | \

(cd $(PROTO_DIR) ; pfexec /bin/cpio -dump $(ROOT)) ; \

else ; \

echo "unsafe to install package(s) automatically" ; \

fi

$(RESOLVED): install

canonical-manifests: $(CANONICAL_MANIFESTS) Makefile $(PATCHES)

ifeq ($(strip $(CANONICAL_MANIFESTS)),)

# If there were no canonical manifests in the workspace, nothing will

# be published and we should fail. A sample manifest can be generated

# with

# $ gmake sample-manifest

# Once created, it will need to be reviewed, edited, and added to the

# workspace.

$(error Missing canonical manifest(s))

endif

# This converts required paths to containing package names for be able to

# properly setup the build environment for a component.

required-pkgs.mk: Makefile

@echo "generating $@ from Makefile REQUIRED_* data"

@pkg search -H -l '<$(DEPENDS:%=% OR) /bin/true>' \

| sed -e 's/pkg:\/\(.*\)@.*/REQUIRED_PKGS += \1/g' >$@

pre-prep: required-pkgs.mk

CLEAN_PATHS += required-pkgs.mk