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]
2N/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.
2N/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.
2N/A# install: $(BUILD_DIR)/build/$(MACH32)/.installed \
2N/A# $(BUILD_DIR)/build/$(MACH64)/.installed
2N/A# This set of rules makes the "publish" target the default target for make(1)
26N/Aifeq ($(strip $(PKGLINT_COMPONENT)),)
26N/APKGLINT = ${WS_TOOLS}/pkglint
26N/APKGMANGLE = $(WS_TOOLS)/userland-mangler
26N/AWS_TRANSFORMS = $(WS_TOP)/transforms
700N/A# Package headers should all pretty much follow the same format
26N/ACOMPARISON_TRANSFORMS += $(PKGMOGRIFY_TRANSFORMS)
26N/A# order is important
26N/APUBLISH_TRANSFORMS += $(LICENSE_TRANSFORMS)
26N/APUBLISH_TRANSFORMS += $(PKGMOGRIFY_TRANSFORMS)
379N/APKG_MACROS += MACH=$(MACH)
379N/APKG_MACROS += MACH32=$(MACH32)
1574N/APKG_MACROS += MACH64=$(MACH64)
1574N/APKG_MACROS += PUBLISHER=$(PUBLISHER)
2N/APKG_MACROS += PUBLISHER_LOCALIZABLE=$(PUBLISHER_LOCALIZABLE)
26N/APKG_MACROS += CONSOLIDATION=$(CONSOLIDATION)
26N/APKG_MACROS += BUILD_VERSION=$(BUILD_VERSION)
181N/APKG_MACROS += SOLARIS_VERSION=$(SOLARIS_VERSION)
181N/APKG_MACROS += OS_VERSION=$(OS_VERSION)
181N/APKG_MACROS += PKG_SOLARIS_VERSION=$(PKG_SOLARIS_VERSION)
99N/APKG_MACROS += HUMAN_VERSION=$(HUMAN_VERSION)
59N/APKG_MACROS += IPS_COMPONENT_VERSION=$(IPS_COMPONENT_VERSION)
12N/APKG_MACROS += COMPONENT_VERSION=$(COMPONENT_VERSION)
30N/APKG_MACROS += COMPONENT_PROJECT_URL=$(COMPONENT_PROJECT_URL)
1622N/APKG_MACROS += COMPONENT_ARCHIVE_URL=$(COMPONENT_ARCHIVE_URL)
1622N/APKG_MACROS += COMPONENT_HG_URL=$(COMPONENT_HG_URL)
1622N/APKG_MACROS += COMPONENT_HG_REV=$(COMPONENT_HG_REV)
1622N/APKG_MACROS += COMPONENT_NAME=$(COMPONENT_NAME)
1622N/A# Add any TPNO_* Makefile macros to the pkgmogrify arguments.
1622N/A$(foreach macro, $(filter TPNO_%, $(.VARIABLES)), \
1622N/A $(eval PKG_MACROS += $(macro)=$$($(macro))) \
1622N/APKG_MACROS += PYTHON_2.6_ONLY=\#
1622N/APKG_MACROS += PYTHON_2.7_ONLY=\#
1622N/APKG_MACROS += PYTHON_3.4_ONLY=\#
1622N/APKG_OPTIONS += $(PKG_MACROS:%=-D %)
1622N/AMANGLED_DIR = $(PROTO_DIR)/mangled
1622N/A# We use += below so anyone wishing to put other directories at the beginning
1622N/A# of the list can do so, by setting PKG_PROTO_DIRS before including this file.
1622N/A# So don't change += to = here or components that use this will break.
1622N/APKG_PROTO_DIRS += $(MANGLED_DIR) $(PROTO_DIR) $(@D) $(COMPONENT_DIR) $(COMPONENT_SRC)
1622N/AMANIFEST_BASE = $(BUILD_DIR)/manifest-$(MACH)
26N/ACANONICAL_MANIFESTS = $(wildcard *.p5m)
1622N/A# Look for manifests which need to be duplicated for each version of python.
2N/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'))
185N/APYNV_MANIFESTS = $(shell echo $(PY_MANIFESTS) | sed -e 's/-PYVER//')
255N/AUNVERSIONED_MANIFESTS = $(CANONICAL_MANIFESTS)
26N/A# Look for manifests which need to be duplicated for each version of perl.
26N/Aifeq ($(findstring -PERLVER,$(UNVERSIONED_MANIFESTS)),-PERLVER)
197N/APERLV_MANIFESTS = $(foreach v,$(shell echo $(PERL_VERSIONS) | tr -d .),$(shell echo $(PERL_MANIFESTS) | sed -e 's/
-PERLVER.p5m/-$(v).p5m/g'))
197N/APERLNV_MANIFESTS = $(shell echo $(PERL_MANIFESTS) | sed -e 's/-PERLVER//')
197N/ANOPERL_MANIFESTS = $(UNVERSIONED_MANIFESTS)
30N/A# Look for manifests which need to be duplicated for each version of ruby.
26N/A# NOPERL_MANIFESTS represents the manifests that are not Python or
46N/A# Perl manifests. Extract the Ruby Manifests from NOPERL_MANIFESTS.
46N/A# Any remaining manifests are stored in NONRUBY_MANIFESTS
46N/Aifeq ($(findstring -RUBYVER,$(NOPERL_MANIFESTS)),-RUBYVER)
46N/ARUBYV_MANIFESTS = $(foreach v,$(shell echo $(RUBY_VERSIONS)),\
46N/A $(shell echo $(RUBY_MANIFESTS) |\
2N/A cut -d. -f1,2 | tr -d .).p5m/g'))
1622N/ARUBYNV_MANIFESTS = $(shell echo $(RUBY_MANIFESTS) | sed -e 's/-RUBYVER//')
1622N/ANORUBY_MANIFESTS = $(NOPERL_MANIFESTS)
1622N/A $(PYV_MANIFESTS) $(PYNV_MANIFESTS) \
1622N/A $(PERLV_MANIFESTS) $(PERLNV_MANIFESTS) \
1622N/A $(RUBYV_MANIFESTS) $(RUBYNV_MANIFESTS) \
1622N/AGENERATED = $(MANIFEST_BASE)-generated
1622N/ACOMBINED = $(MANIFEST_BASE)-combined
1622N/AMANIFESTS = $(VERSIONED_MANIFESTS:%=$(MANIFEST_BASE)-%)
1622N/ADEPENDED=$(VERSIONED_MANIFESTS:%.p5m=$(MANIFEST_BASE)-%.depend)
1622N/ACOPYRIGHT_FILE ?= $(COMPONENT_NAME)-$(COMPONENT_VERSION).copyright
1622N/AIPS_COMPONENT_VERSION ?= $(COMPONENT_VERSION)
1622N/A# allow publishing to be overridden, such as when
1622N/A# a package is for one architecture only.
1622N/APUBLISH_STAMP ?= $(BUILD_DIR)/.published-$(MACH)
1622N/Apublish: build install $(PUBLISH_STAMP)
1622N/Asample-manifest: $(GENERATED).p5m
1622N/A $(PKGSEND) generate $(PKG_HARDLINKS:%=--target %) $(PROTO_DIR) | \
1622N/A $(PKGMOGRIFY) $(PKG_OPTIONS)
/dev/fd/0 $(GENERATE_TRANSFORMS) | \
1622N/A sed -e '/^$$/d' -e '/^#.*$$/d' | $(PKGFMT) | \
1622N/A cat $(METADATA_TEMPLATE) - >$@
1622N/A# copy the canonical manifest(s) to the build tree
1622N/A$(MANIFEST_BASE)-%.generate: %.p5m canonical-manifests
1622N/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.
1622N/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.
1622N/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 .) $$< > $$@
46N/A$(foreach ver,$(PYTHON_VERSIONS),$(eval $(call python-manifest-rule,$(ver))))
26N/A# A rule to create a helper transform package for python, that will insert the
181N/A# appropriate conditional dependencies into a python library's
369N/A# runtime-version-generic package to pull in the version-specific bits when the
181N/A# corresponding version of python is on the system.
181N/A $(foreach ver,$(shell echo $(PYTHON_VERSIONS) | tr -d .), \
76N/A# Build Python version-wrapping manifests from the generic version.
181N/A# Note that the mkgeneric transform uses the literal string "###PYV###"
99N/A# as the place-holder for the Python version (for mkgeneric-python) and
26N/A# the Perl version (for mkgeneric-perl below) and the Ruby version (for
185N/A# mkgeneric-ruby further below). The authors did not anticipate that this
185N/A# mechanism would be extended beyond Python when they wrote it; something
185N/A# more generic like LANGVER might make more sense, but for now we are
145N/A# sticking with something known to work.
145N/A $(PKGMOGRIFY) -D PYV=###PYV### $(BUILD_DIR)/mkgeneric-python \
84N/A# Define and execute a macro that generates a rule to create a manifest for a
145N/A# perl module specific to a particular version of the perl runtime.
145N/Adefine perl-manifest-rule
38N/A $(PKGMOGRIFY) -D PERLVER=$(1) -D PLV=$(shell echo $(1) | tr -d .) \
46N/A -D PERL_ARCH=$(call PERL_ARCH_FUNC,$(PERL.$(1))) $$< > $$@
99N/A$(foreach ver,$(PERL_VERSIONS),$(eval $(call perl-manifest-rule,$(ver))))
185N/A# A rule to create a helper transform package for perl, that will insert the
99N/A# appropriate conditional dependencies into a perl library's
46N/A# runtime-version-generic package to pull in the version-specific bits when the
2N/A# corresponding version of perl is on the system.
2N/A $(foreach ver,$(shell echo $(PERL_VERSIONS) | tr -d .), \
32N/A# Build Perl version-wrapping manifests from the generic version.
32N/A# See the block comment above about why "###PYV###" is used here even
32N/A# though this is for Perl rather than Python.
1622N/A $(PKGFMT) $(PKGFMT_CHECK_ARGS) $(CANONICAL_MANIFESTS)
32N/A $(PKGMOGRIFY) -D PLV=###PYV### $(BUILD_DIR)/mkgeneric-perl \
38N/A# Define and execute a macro that generates a rule to create a manifest for a
1622N/A# ruby module specific to a particular version of the ruby runtime.
38N/A# the version number.
38N/Adefine ruby-manifest-rule
38N/A$(MANIFEST_BASE)-%-$(shell echo $(1) | tr -d .).mogrified: \
38N/A PKG_MACROS += RUBY_VERSION=$(1) RUBY_LIB_VERSION=$(2) \
38N/A RUBYV=$(subst .,,$(1))
26N/A $(PKGMOGRIFY) -D RUBY_VERSION=$(1) -D RUBY_LIB_VERSION=$(2) \
26N/A -D RUBYV=$(shell echo $(1) | tr -d .) $$< > $$@
26N/A$(foreach ver,$(RUBY_VERSIONS),\
26N/A $(eval $(call ruby-manifest-rule,$(shell echo $(ver) | \
26N/A cut -d. -f1,2),$(ver))))
26N/A# A rule to create a helper transform package for ruby, that will insert the
32N/A# appropriate conditional dependencies into a ruby library's
32N/A# runtime-version-generic package to pull in the version-specific bits when the
32N/A# corresponding version of ruby is on the system.
32N/A $(foreach ver,$(RUBY_VERSIONS),\
32N/A cut -d. -f1,2 | tr -d .)))
38N/A# Build Ruby version-wrapping manifests from the generic version.
# See the block comment above about why "###PYV###" is used here even
# though this is for Ruby rather than Python.
$(MANIFEST_BASE)-%.p5m: %
-RUBYVER.p5m $(BUILD_DIR)/mkgeneric-ruby
$(PKGMOGRIFY) -D RUBYV=###PYV### $(BUILD_DIR)/mkgeneric-ruby \
# 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):
PKGMANGLE_OPTIONS = -D $(MANGLED_DIR) $(PKG_PROTO_DIRS:%=-d %)
$(MANIFEST_BASE)-%.mangled: $(MANIFEST_BASE)-%.mogrified $(MANGLED_DIR)
$(PKGMANGLE) $(PKGMANGLE_OPTIONS) -m $< >$@
PKGDEPEND_GENERATE_OPTIONS = -m $(PKG_PROTO_DIRS:%=-d %)
$(MANIFEST_BASE)-%.depend: $(MANIFEST_BASE)-%.mangled
$(ENV) $(COMPONENT_PUBLISH_ENV) $(PKGDEPEND) generate \
$(PKGDEPEND_GENERATE_OPTIONS) $< >$@
# pkgdepend resolve builds a map of all installed packages by default. This
# makes dependency resolution particularly slow. We can dramatically improve
# performance here by creating a file with a list of packages that we know
# are needed, dramatically reducing the overhead involved in creating and
# Generate a
resolve.deps file from the dependencies in the Makefile and
# fragments that it uses.
$(RESOLVE_DEPS): $(MAKEFILE_PREREQ) $(BUILD_DIR)
@for pkg in $(REQUIRED_PACKAGES:%=/%) ; do \
# resolve the dependencies all at once
$(BUILD_DIR)/.resolved-$(MACH): $(DEPENDED) $(RESOLVE_DEPS)
$(PKGDEPEND) resolve $(RESOLVE_DEPS:%=-e %) -m $(DEPENDED)
# Generate a set of REQUIRED_PACKAGES based on what is needed to for pkgdepend
# to resolve properly. Automatically append this to your Makefile for the truly
# lazy among us. This is only a piece of the REQUIRED_PACKAGES puzzle.
# You must still include packages for tools you build and test with.
REQUIRED_PACKAGES:: $(RESOLVED)
$(GMAKE) RESOLVE_DEPS= $(BUILD_DIR)/.resolved-$(MACH)
@echo "# Auto-generated contents below. Please manually verify and remove this comment" >>Makefile
@$(PKGMOGRIFY) $(WS_TRANSFORMS)/$@ $(RESOLVED) | \
$(GSED) -e '/^[\t ]*$$/d' -e '/^#/d' | sort -u >>Makefile
@echo "*** Please edit your Makefile and verify the new content at the end ***"
# 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)"\
SOLARIS_VERSION=$(SOLARIS_VERSION)\
$(PKGLINT) $(CANONICAL_REPO:%=-c $(WS_LINT_CACHE)) \
-f $(WS_TOOLS)/pkglintrc $(RESOLVED)
@echo "VALIDATING MANIFEST CONTENT: $(RESOLVED)"
$(ENV) PYTHONPATH=$(WS_TOOLS)/python PROTO_PATH="$(PKG_PROTO_DIRS)"\
SOLARIS_VERSION=$(SOLARIS_VERSION)\
$(PKGLINT) $(CANONICAL_REPO:%=-c $(WS_LINT_CACHE)) \
-f $(WS_TOOLS)/pkglintrc $(RESOLVED)
PKGSEND_PUBLISH_OPTIONS = -s $(PKG_REPO) publish --fmri-in-manifest
PKGSEND_PUBLISH_OPTIONS += --no-catalog
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) $<
$(BUILD_DIR)/.published-$(MACH): $(PUBLISHED)
ifndef DISABLE_IPS_CATALOG_AND_INDEX_UPDATES
$(PKGREPO) refresh -s $(PKG_REPO)
print-package-names: canonical-manifests
$(PKGMOGRIFY) $(PKG_OPTIONS)
/dev/fd/0 | \
sed -e '/^$$/d' -e '/^#.*$$/d' | sort -u
print-package-paths: canonical-manifests
$(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 \
$(PKGMOGRIFY) $(PKG_OPTIONS)
/dev/fd/0 | \
sed -e '/^$$/d' -e '/^#.*$$/d' -e 's;/;;' | sort -u | \
(cd $(PROTO_DIR) ; pfexec
/bin/cpio -dump $(ROOT)) ; \
echo "unsafe to install package(s) automatically" ; \
canonical-manifests: $(CANONICAL_MANIFESTS) $(MAKEFILE_PREREQ) $(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
# $ gmake sample-manifest
# Once created, it will need to be reviewed, edited, and added to the
$(error Missing canonical manifest(s))
# This converts required paths to containing package names for be able to
# properly setup the build environment for a component.
@echo "generating $@ from Makefile REQUIRED_* data"
@pkg search -H -l '<$(DEPENDS:%=% OR)
/bin/true>' \
| sed -e '
s/pkg:\/\(.*\)@.*/REQUIRED_PKGS += \1/g' >$@