2N/A# The contents of this file are subject to the terms of the
2N/A# Common Development and Distribution License (the "License").
2N/A# You may not use this file except in compliance with the License.
2N/A# See the License for the specific language governing permissions
2N/A# and limitations under the License.
2N/A# When distributing Covered Code, include this CDDL HEADER in each
2N/A# If applicable, add the following below this CDDL HEADER, with the
2N/A# fields enclosed by brackets "[]" replaced with your own identifying
2N/A# information: Portions Copyright [yyyy] [name of copyright owner]
3996N/A# Copyright (c) 2010, 2015, Oracle
and/or its affiliates. All rights reserved.
2N/A# Rules and Macros for generating an IPS package manifest and publishing an
2N/A# IPS package to a pkg depot.
3996N/A# To use these rules, include $(WS_MAKE_RULES)/
ips.mk in your Makefile
2N/A# and define an "install" target appropriate to building your component.
59N/A# install: $(BUILD_DIR)/build/$(MACH32)/.installed \
59N/A# $(BUILD_DIR)/build/$(MACH64)/.installed
2N/A# This set of rules makes the "publish" target the default target for make(1)
2238N/Aifeq ($(strip $(PKGLINT_COMPONENT)),)
2238N/APKGLINT = ${WS_TOOLS}/pkglint
181N/APKGMANGLE = $(WS_TOOLS)/userland-mangler
5630N/AGENERATE_HISTORY= $(WS_TOOLS)/generate-history
3996N/AWS_TRANSFORMS = $(WS_TOP)/transforms
26N/A# Package headers should all pretty much follow the same format
26N/A# order is important
26N/ACOMPARISON_TRANSFORMS += $(PKGMOGRIFY_TRANSFORMS)
26N/A# order is important
1574N/APUBLISH_TRANSFORMS += $(LICENSE_TRANSFORMS)
26N/APUBLISH_TRANSFORMS += $(PKGMOGRIFY_TRANSFORMS)
4561N/A# If we are building "evaluation" packages, add the evaluation information
4447N/A# action so that the package(s) display the terms and require acceptance
4561N/Aifeq ($(BUILD_TYPE),evaluation)
26N/APKG_MACROS += MACH=$(MACH)
26N/APKG_MACROS += MACH32=$(MACH32)
26N/APKG_MACROS += MACH64=$(MACH64)
26N/APKG_MACROS += PUBLISHER=$(PUBLISHER)
883N/APKG_MACROS += PUBLISHER_LOCALIZABLE=$(PUBLISHER_LOCALIZABLE)
26N/APKG_MACROS += CONSOLIDATION=$(CONSOLIDATION)
26N/APKG_MACROS += BUILD_VERSION=$(BUILD_VERSION)
26N/APKG_MACROS += SOLARIS_VERSION=$(SOLARIS_VERSION)
26N/APKG_MACROS += OS_VERSION=$(OS_VERSION)
3996N/APKG_MACROS += PKG_SOLARIS_VERSION=$(PKG_SOLARIS_VERSION)
586N/APKG_MACROS += HUMAN_VERSION=$(HUMAN_VERSION)
26N/APKG_MACROS += IPS_COMPONENT_VERSION=$(IPS_COMPONENT_VERSION)
93N/APKG_MACROS += COMPONENT_VERSION=$(COMPONENT_VERSION)
166N/APKG_MACROS += COMPONENT_PROJECT_URL=$(COMPONENT_PROJECT_URL)
26N/APKG_MACROS += COMPONENT_ARCHIVE_URL=$(COMPONENT_ARCHIVE_URL)
379N/APKG_MACROS += COMPONENT_HG_URL=$(COMPONENT_HG_URL)
379N/APKG_MACROS += COMPONENT_HG_REV=$(COMPONENT_HG_REV)
1574N/APKG_MACROS += COMPONENT_NAME=$(COMPONENT_NAME)
4519N/APKG_MACROS += CONSOLIDATION_CHANGESET=$(CONSOLIDATION_CHANGESET)
4519N/APKG_MACROS += CONSOLIDATION_REPOSITORY_URL=$(CONSOLIDATION_REPOSITORY_URL)
3522N/A# Add any TPNO_* Makefile macros to the pkgmogrify arguments.
3522N/A$(foreach macro, $(filter TPNO_%, $(.VARIABLES)), \
3522N/A $(eval PKG_MACROS += $(macro)=$$($(macro))) \
2271N/APKG_MACROS += PYTHON_2.6_ONLY=\#
2271N/APKG_MACROS += PYTHON_2.7_ONLY=\#
3778N/APKG_MACROS += PYTHON_3.4_ONLY=\#
26N/APKG_OPTIONS += $(PKG_MACROS:%=-D %)
181N/AMANGLED_DIR = $(PROTO_DIR)/mangled
4374N/A# We use += below so anyone wishing to put other directories at the beginning
4374N/A# of the list can do so, by setting PKG_PROTO_DIRS before including this file.
4374N/A# So don't change += to = here or components that use this will break.
4561N/APKG_PROTO_DIRS += $(MANGLED_DIR) $(PROTO_DIR) $(@D) $(COMPONENT_DIR) $(COMPONENT_SRC) $(WS_LICENSES)
59N/AMANIFEST_BASE = $(BUILD_DIR)/manifest-$(MACH)
30N/ACANONICAL_MANIFESTS = $(wildcard *.p5m)
5630N/Aifneq ($(wildcard $(HISTORY)),)
5630N/AHISTORICAL_MANIFESTS = $(shell $(NAWK) -v FUNCTION=name -f $(GENERATE_HISTORY) < $(HISTORY))
1622N/A# Look for manifests which need to be duplicated for each version of python.
1622N/Aifeq ($(findstring -PYVER,$(CANONICAL_MANIFESTS)),-PYVER)
1622N/APYV_MANIFESTS = $(foreach v,$(shell echo $(PYTHON_VERSIONS) | tr -d .),$(shell echo $(PY_MANIFESTS) | sed -e 's/
-PYVER.p5m/-$(v).p5m/g'))
1622N/APYNV_MANIFESTS = $(shell echo $(PY_MANIFESTS) | sed -e 's/-PYVER//')
1622N/AUNVERSIONED_MANIFESTS = $(CANONICAL_MANIFESTS)
1622N/A# Look for manifests which need to be duplicated for each version of perl.
1622N/Aifeq ($(findstring -PERLVER,$(UNVERSIONED_MANIFESTS)),-PERLVER)
1622N/APERLV_MANIFESTS = $(foreach v,$(shell echo $(PERL_VERSIONS) | tr -d .),$(shell echo $(PERL_MANIFESTS) | sed -e 's/
-PERLVER.p5m/-$(v).p5m/g'))
1622N/APERLNV_MANIFESTS = $(shell echo $(PERL_MANIFESTS) | sed -e 's/-PERLVER//')
1622N/ANOPERL_MANIFESTS = $(UNVERSIONED_MANIFESTS)
3293N/A# Look for manifests which need to be duplicated for each version of ruby.
3293N/A# NOPERL_MANIFESTS represents the manifests that are not Python or
3293N/A# Perl manifests. Extract the Ruby Manifests from NOPERL_MANIFESTS.
3293N/A# Any remaining manifests are stored in NONRUBY_MANIFESTS
3293N/Aifeq ($(findstring -RUBYVER,$(NOPERL_MANIFESTS)),-RUBYVER)
3293N/ARUBYV_MANIFESTS = $(foreach v,$(shell echo $(RUBY_VERSIONS)),\
3293N/A $(shell echo $(RUBY_MANIFESTS) |\
3293N/A cut -d. -f1,2 | tr -d .).p5m/g'))
3293N/ARUBYNV_MANIFESTS = $(shell echo $(RUBY_MANIFESTS) | sed -e 's/-RUBYVER//')
3293N/ANORUBY_MANIFESTS = $(NOPERL_MANIFESTS)
1622N/A $(PYV_MANIFESTS) $(PYNV_MANIFESTS) \
1622N/A $(PERLV_MANIFESTS) $(PERLNV_MANIFESTS) \
3293N/A $(RUBYV_MANIFESTS) $(RUBYNV_MANIFESTS) \
5630N/A $(NORUBY_MANIFESTS) $(HISTORICAL_MANIFESTS)
26N/AGENERATED = $(MANIFEST_BASE)-generated
26N/ACOMBINED = $(MANIFEST_BASE)-combined
1622N/AMANIFESTS = $(VERSIONED_MANIFESTS:%=$(MANIFEST_BASE)-%)
1622N/ADEPENDED=$(VERSIONED_MANIFESTS:%.p5m=$(MANIFEST_BASE)-%.depend)
255N/ACOPYRIGHT_FILE ?= $(COMPONENT_NAME)-$(COMPONENT_VERSION).copyright
145N/AIPS_COMPONENT_VERSION ?= $(COMPONENT_VERSION)
197N/A# allow publishing to be overridden, such as when
197N/A# a package is for one architecture only.
197N/APUBLISH_STAMP ?= $(BUILD_DIR)/.published-$(MACH)
197N/Apublish: build install $(PUBLISH_STAMP)
30N/Asample-manifest: $(GENERATED).p5m
46N/A$(GENERATED).p5m: install
46N/A $(PKGSEND) generate $(PKG_HARDLINKS:%=--target %) $(PROTO_DIR) | \
46N/A $(PKGMOGRIFY) $(PKG_OPTIONS)
/dev/fd/0 $(GENERATE_TRANSFORMS) | \
64N/A sed -e '/^$$/d' -e '/^#.*$$/d' | $(PKGFMT) | \
64N/A cat $(METADATA_TEMPLATE) - >$@
46N/A# copy the canonical manifest(s) to the build tree
46N/A$(MANIFEST_BASE)-%.generate: %.p5m canonical-manifests
46N/A cat $(METADATA_TEMPLATE) $< >$@
1622N/A# The text of a transform that will emit a dependency conditional on the
1622N/A# presence of a particular version of a runtime, which will then draw in the
1622N/A# runtime-version-specific version of the package we're operating on. $(1) is
1622N/A# the name of the runtime package, and $(2) is the version suffix.
3293N/A echo "<transform set name=
pkg.fmri value=(?:pkg:/)?(.+)-\#\#\#PYV\#\#\#@(.*)" \
1622N/A "-> emit depend nodrop=true type=conditional" \
1622N/A "predicate=$(1)-$(2) fmri=%<1>-$(2)@%<2>>" >> $@;
1622N/A# Define and execute a macro that generates a rule to create a manifest for a
1622N/A# python module specific to a particular version of the python runtime.
2271N/A$(MANIFEST_BASE)-%-$(shell echo $(1) | tr -d .).mogrified: PKG_MACROS += PYTHON_$(1)_ONLY=
1622N/A $(PKGMOGRIFY) -D PYVER=$(1) -D PYV=$(shell echo $(1) | tr -d .) $$< > $$@
1622N/A$(foreach ver,$(PYTHON_VERSIONS),$(eval $(call python-manifest-rule,$(ver))))
1622N/A# A rule to create a helper transform package for python, that will insert the
1622N/A# appropriate conditional dependencies into a python library's
1622N/A# runtime-version-generic package to pull in the version-specific bits when the
1622N/A# corresponding version of python is on the system.
1622N/A $(foreach ver,$(shell echo $(PYTHON_VERSIONS) | tr -d .), \
1622N/A# Build Python version-wrapping manifests from the generic version.
3787N/A# Note that the mkgeneric transform uses the literal string "###PYV###"
3787N/A# as the place-holder for the Python version (for mkgeneric-python) and
3787N/A# the Perl version (for mkgeneric-perl below) and the Ruby version (for
3787N/A# mkgeneric-ruby further below). The authors did not anticipate that this
3787N/A# mechanism would be extended beyond Python when they wrote it; something
3787N/A# more generic like LANGVER might make more sense, but for now we are
3787N/A# sticking with something known to work.
3293N/A $(PKGMOGRIFY) -D PYV=###PYV### $(BUILD_DIR)/mkgeneric-python \
1622N/A# Define and execute a macro that generates a rule to create a manifest for a
1622N/A# perl module specific to a particular version of the perl runtime.
1622N/A $(PKGMOGRIFY) -D PERLVER=$(1) -D PLV=$(shell echo $(1) | tr -d .) \
1622N/A -D PERL_ARCH=$(call PERL_ARCH_FUNC,$(PERL.$(1))) $$< > $$@
1622N/A$(foreach ver,$(PERL_VERSIONS),$(eval $(call perl-manifest-rule,$(ver))))
1622N/A# A rule to create a helper transform package for perl, that will insert the
1622N/A# appropriate conditional dependencies into a perl library's
1622N/A# runtime-version-generic package to pull in the version-specific bits when the
1622N/A# corresponding version of perl is on the system.
1622N/A $(foreach ver,$(shell echo $(PERL_VERSIONS) | tr -d .), \
1622N/A# Build Perl version-wrapping manifests from the generic version.
3787N/A# See the block comment above about why "###PYV###" is used here even
3787N/A# though this is for Perl rather than Python.
3996N/A $(PKGFMT) $(PKGFMT_CHECK_ARGS) $(CANONICAL_MANIFESTS)
3787N/A $(PKGMOGRIFY) -D PLV=###PYV### $(BUILD_DIR)/mkgeneric-perl \
3293N/A# Define and execute a macro that generates a rule to create a manifest for a
3293N/A# ruby module specific to a particular version of the ruby runtime.
3293N/A$(MANIFEST_BASE)-%-$(shell echo $(1) | tr -d .).mogrified: \
3293N/A PKG_MACROS += RUBY_VERSION=$(1) RUBY_LIB_VERSION=$(2) \
3293N/A $(PKGMOGRIFY) -D RUBY_VERSION=$(1) -D RUBY_LIB_VERSION=$(2) \
3293N/A -D RUBYV=$(shell echo $(1) | tr -d .) $$< > $$@
3293N/A$(foreach ver,$(RUBY_VERSIONS),\
3293N/A $(eval $(call ruby-manifest-rule,$(shell echo $(ver) | \
3293N/A# A rule to create a helper transform package for ruby, that will insert the
3293N/A# appropriate conditional dependencies into a ruby library's
3293N/A# runtime-version-generic package to pull in the version-specific bits when the
3293N/A# corresponding version of ruby is on the system.
3293N/A $(foreach ver,$(RUBY_VERSIONS),\
3293N/A# Build Ruby version-wrapping manifests from the generic version.
3787N/A# See the block comment above about why "###PYV###" is used here even
3787N/A# though this is for Ruby rather than Python.
3293N/A $(PKGMOGRIFY) -D RUBYV=###PYV### $(BUILD_DIR)/mkgeneric-ruby \
5630N/A# Rule to generate historical manifests from the $(HISTORY) file.
5630N/Adefine history-manifest-rule
5630N/A$(MANIFEST_BASE)-$(1): $(HISTORY) $(BUILD_DIR)
5630N/A $(NAWK) -v TARGET=$(1) -v FUNCTION=manifest -f $(GENERATE_HISTORY) < \
5630N/A$(foreach mfst,$(HISTORICAL_MANIFESTS),$(eval $(call history-manifest-rule,$(mfst))))
1622N/A# mogrify non-parameterized manifests
1622N/A$(MANIFEST_BASE)-%.mogrified: %.p5m $(BUILD_DIR)
1622N/A $(PKGMOGRIFY) $(PKG_OPTIONS) $< \
1622N/A sed -e '/^$$/d' -e '/^#.*$$/d' | uniq >$@
1622N/A# mogrify parameterized manifests
1622N/A$(MANIFEST_BASE)-%.mogrified: $(MANIFEST_BASE)-%.p5m $(BUILD_DIR)
53N/A $(PKGMOGRIFY) $(PKG_OPTIONS) $< \
46N/A $(PUBLISH_TRANSFORMS) | \
46N/A sed -e '/^$$/d' -e '/^#.*$$/d' | uniq >$@
181N/A# mangle the file contents
369N/A$(BUILD_DIR) $(MANGLED_DIR):
181N/APKGMANGLE_OPTIONS = -D $(MANGLED_DIR) $(PKG_PROTO_DIRS:%=-d %)
181N/A$(MANIFEST_BASE)-%.mangled: $(MANIFEST_BASE)-%.mogrified $(MANGLED_DIR)
181N/A $(PKGMANGLE) $(PKGMANGLE_OPTIONS) -m $< >$@
76N/A# generate dependencies
99N/APKGDEPEND_GENERATE_OPTIONS = -m $(PKG_PROTO_DIRS:%=-d %)
181N/A$(MANIFEST_BASE)-%.depend: $(MANIFEST_BASE)-%.mangled
3778N/A $(ENV) $(COMPONENT_PUBLISH_ENV) $(PKGDEPEND) generate \
3778N/A $(PKGDEPEND_GENERATE_OPTIONS) $< >$@
3996N/A# pkgdepend resolve builds a map of all installed packages by default. This
3996N/A# makes dependency resolution particularly slow. We can dramatically improve
3996N/A# performance here by creating a file with a list of packages that we know
3996N/A# are needed, dramatically reducing the overhead involved in creating and
3996N/A$(RESOLVE_DEPS): $(MAKEFILE_PREREQ) $(BUILD_DIR)
3996N/A @for pkg in $(REQUIRED_PACKAGES:%=/%) ; do \
185N/A# resolve the dependencies all at once
3996N/A$(BUILD_DIR)/.resolved-$(MACH): $(DEPENDED) $(RESOLVE_DEPS)
3996N/A $(PKGDEPEND) resolve $(RESOLVE_DEPS:%=-e %) -m $(DEPENDED)
3996N/A# Generate a set of REQUIRED_PACKAGES based on what is needed to for pkgdepend
3996N/A# to resolve properly. Automatically append this to your Makefile for the truly
3996N/A# lazy among us. This is only a piece of the REQUIRED_PACKAGES puzzle.
3996N/A# You must still include packages for tools you build and test with.
3996N/AREQUIRED_PACKAGES:: $(RESOLVED)
3996N/A $(GMAKE) RESOLVE_DEPS= $(BUILD_DIR)/.resolved-$(MACH)
3996N/A @echo "# Auto-generated contents below. Please manually verify and remove this comment" >>Makefile
3996N/A @$(PKGMOGRIFY) $(WS_TRANSFORMS)/$@ $(RESOLVED) | \
3996N/A $(GSED) -e '/^[\t ]*$$/d' -e '/^#/d' | sort -u >>Makefile
3996N/A @echo "*** Please edit your Makefile and verify the new content at the end ***"
145N/A# lint the manifests all at once
145N/A$(BUILD_DIR)/.linted-$(MACH): $(BUILD_DIR)/.resolved-$(MACH)
145N/A @echo "VALIDATING MANIFEST CONTENT: $(RESOLVED)"
117N/A $(ENV) PYTHONPATH=$(WS_TOOLS)/python PROTO_PATH="$(PKG_PROTO_DIRS)"\
2541N/A SOLARIS_VERSION=$(SOLARIS_VERSION)\
84N/A $(PKGLINT) $(CANONICAL_REPO:%=-c $(WS_LINT_CACHE)) \
145N/A -f $(WS_TOOLS)/pkglintrc $(RESOLVED)
2337N/A @echo "VALIDATING MANIFEST CONTENT: $(RESOLVED)"
2337N/A $(ENV) PYTHONPATH=$(WS_TOOLS)/python PROTO_PATH="$(PKG_PROTO_DIRS)"\
2541N/A SOLARIS_VERSION=$(SOLARIS_VERSION)\
2337N/A $(PKGLINT) $(CANONICAL_REPO:%=-c $(WS_LINT_CACHE)) \
2337N/A -f $(WS_TOOLS)/pkglintrc $(RESOLVED)
99N/APKGSEND_PUBLISH_OPTIONS = -s $(PKG_REPO) publish --fmri-in-manifest
1900N/APKGSEND_PUBLISH_OPTIONS += --no-catalog
99N/APKGSEND_PUBLISH_OPTIONS += $(PKG_PROTO_DIRS:%=-d %)
196N/APKGSEND_PUBLISH_OPTIONS += -T \*.py
6033N/A# PKGREPO_REMOVE_BEFORE_PUBLISH remove previously published versions of this package
6033N/A# before publishing the new build
6033N/APKGREPO_REMOVE_BEFORE_PUBLISH ?= no
185N/A$(MANIFEST_BASE)-%.published: $(MANIFEST_BASE)-%
.depend.res $(BUILD_DIR)/.linted-$(MACH)
6033N/Aifeq ($(PKGREPO_REMOVE_BEFORE_PUBLISH),yes)
6033N/A -$(PKGREPO) -s $(PKG_REPO) remove \
6033N/A sed -e '/^$$/d' -e '/^#.*$$/d' | sort -u)
99N/A $(PKGSEND) $(PKGSEND_PUBLISH_OPTIONS) $<
145N/A$(BUILD_DIR)/.published-$(MACH): $(PUBLISHED)
1900N/Aifndef DISABLE_IPS_CATALOG_AND_INDEX_UPDATES
1900N/A $(PKGREPO) refresh -s $(PKG_REPO)
32N/Aprint-package-names: canonical-manifests
32N/A sed -e '/^$$/d' -e '/^#.*$$/d' | sort -u
32N/Aprint-package-paths: canonical-manifests
32N/A sed -e '/^$$/d' -e '/^#.*$$/d' | sort -u
38N/Ainstall-packages: publish
38N/A @if [ $(IS_GLOBAL_ZONE) = 0 -o x$(ROOT) != x ]; then \
38N/A sed -e '/^$$/d' -e '/^#.*$$/d' -e 's;/;;' | sort -u | \
38N/A echo "unsafe to install package(s) automatically" ; \
5630N/Acanonical-manifests: $(CANONICAL_MANIFESTS) $(MAKEFILE_PREREQ) $(PATCHES) \
26N/Aifeq ($(strip $(CANONICAL_MANIFESTS)),)
26N/A # If there were no canonical manifests in the workspace, nothing will
26N/A # be published and we should fail. A sample manifest can be generated
26N/A # $ gmake sample-manifest
26N/A # Once created, it will need to be reviewed, edited, and added to the
26N/A $(error Missing canonical manifest(s))
32N/A# This converts required paths to containing package names for be able to
32N/A# properly setup the build environment for a component.
32N/A @echo "generating $@ from Makefile REQUIRED_* data"
32N/A | sed -e '
s/pkg:\/\(.*\)@.*/REQUIRED_PKGS += \1/g' >$@