upb_generator/bootstrap_compiler.bzl - third_party/protobuf - Git at Google

 """Macros that implement bootstrapping for the upb code generator."""

 # begin:github_only
 load(
     "//bazel:upb_minitable_proto_library.bzl",
     "upb_minitable_proto_library",
 )
 # end:github_only

 load(
     "//bazel:upb_proto_library.bzl",
     "upb_proto_library",
 )
 load(
     "//upb/cmake:build_defs.bzl",
     "staleness_test",
 )

 _stages = ["_stage0", "_stage1", ""]
 _protoc = "//:protoc"
 _upbc_base = "//upb_generator:protoc-gen-"

 # begin:google_only
 # _is_google3 = True
 # _extra_proto_path = ""
 # end:google_only

 # begin:github_only
 _is_google3 = False
 _extra_proto_path = "-I$$(dirname $(location @com_google_protobuf//:descriptor_proto_srcs))/../.. "
 # end:github_only

 def _upbc(generator, stage):
     return _upbc_base + generator + _stages[stage]

 def bootstrap_cc_library(name, visibility, deps = [], bootstrap_deps = [], **kwargs):
     for stage in _stages:
         stage_visibility = visibility if stage == "" else ["//upb_generator:__pkg__"]
         native.cc_library(
             name = name + stage,
             deps = deps + [dep + stage for dep in bootstrap_deps],
             visibility = stage_visibility,
             **kwargs
         )

 def bootstrap_cc_binary(name, deps = [], bootstrap_deps = [], **kwargs):
     for stage in _stages:
         native.cc_binary(
             name = name + stage,
             deps = deps + [dep + stage for dep in bootstrap_deps],
             **kwargs
         )

 def _generated_srcs_for_suffix(prefix, srcs, suffix):
     return [prefix + "/" + src[:-len(".proto")] + suffix for src in srcs]

 def _generated_srcs_for_generator(prefix, srcs, generator):
     ret = _generated_srcs_for_suffix(prefix, srcs, ".{}.h".format(generator))

     if generator != "upb" or prefix.endswith("stage0"):
         ret += _generated_srcs_for_suffix(prefix, srcs, ".{}.c".format(generator))
     return ret

 def _generated_srcs(prefix, srcs):
     return _generated_srcs_for_generator(prefix, srcs, "upb")

 def _stage0_proto_staleness_test(name, base_dir, src_files, src_rules, strip_prefix):
     native.genrule(
         name = name + "_generate_bootstrap",
         srcs = src_rules,
         outs = _generated_srcs("bootstrap_generated_sources/" + base_dir + "stage0", src_files),
         tools = [_protoc, _upbc("upb", 0)],
         cmd =
             "$(location " + _protoc + ") " +
             "-I$(GENDIR)/" + strip_prefix + " " + _extra_proto_path +
             "--plugin=protoc-gen-upb=$(location " + _upbc("upb", 0) + ") " +
             "--upb_out=bootstrap_upb:$(@D)/bootstrap_generated_sources/" + base_dir + "stage0 " +
             " ".join(src_files),
     )

     staleness_test(
         name = name + "_stage0_staleness_test",
         outs = _generated_srcs(base_dir + "stage0", src_files),
         generated_pattern = "bootstrap_generated_sources/%s",
         target_files = native.glob([base_dir + "stage0/**"]),
         # To avoid skew problems for descriptor.proto/pluging.proto between
         # GitHub repos.  It's not critical that the checked-in protos are up to
         # date for every change, they just needs to be complete enough to have
         # everything needed by the code generator itself.
         tags = ["manual"],
     )

 def _generate_stage1_proto(name, base_dir, src_files, src_rules, generator, kwargs):
     native.genrule(
         name = "gen_{}_{}_stage1".format(name, generator),
         srcs = src_rules,
         outs = _generated_srcs_for_generator(base_dir + "stage1", src_files, generator),
         cmd = "$(location " + _protoc + ") " +
               "--plugin=protoc-gen-" + generator +
               "=$(location " + _upbc(generator, 0) + ") " + _extra_proto_path +
               "--" + generator + "_out=$(RULEDIR)/" + base_dir + "stage1 " +
               " ".join(src_files),
         visibility = ["//upb_generator:__pkg__"],
         tools = [
             _protoc,
             _upbc(generator, 0),
         ],
         **kwargs
     )

 # begin:github_only
 def _cmake_staleness_test(name, base_dir, src_files, proto_lib_deps, **kwargs):
     upb_minitable_proto_library(
         name = name + "_minitable",
         deps = proto_lib_deps,
         **kwargs
     )

     # Copy the final gencode for staleness comparison
     files = _generated_srcs("cmake" + base_dir, src_files) + \
             _generated_srcs_for_generator("cmake" + base_dir, src_files, "upb_minitable")
     genrule = 0
     for src in files:
         genrule += 1
         native.genrule(
             name = name + "_copy_gencode_%d" % genrule,
             outs = ["generated_sources/" + src],
             srcs = [name, name + "_minitable"],
             cmd = """
                 mkdir -p $(@D)
                 for src in $(SRCS); do
                     if [[ $$src == *%s ]]; then
                         cp -f $$src $(@D) || echo 'copy failed!'
                     fi
                 done
             """ % src[src.rfind("/"):],
         )

     # Keep bazel gencode in sync with our checked-in sources needed for cmake builds.
     staleness_test(
         name = name + "_staleness_test",
         outs = files,
         generated_pattern = "generated_sources/%s",
         tags = ["manual"],
     )

 # end:github_only

 def bootstrap_upb_proto_library(
         name,
         base_dir,
         google3_src_files,
         google3_src_rules,
         oss_src_files,
         oss_src_rules,
         oss_strip_prefix,
         proto_lib_deps,
         visibility,
         deps = [],
         **kwargs):
     """A version of upb_proto_library() that is augmented to allow for bootstrapping the compiler.

     Args:
         name: Name of this rule.  This name will resolve to a upb_proto_library().
         base_dir: The directory that all generated files should be placed under.
         google3_src_files: Google3 filenames of .proto files that should be built by this rule.
           The names should be relative to the depot base.
         google3_src_rules: Target names of the Blaze rules that will provide these filenames.
         oss_src_files: OSS filenames of .proto files that should be built by this rule.
         oss_src_rules: Target names of the Bazel rules that will provide these filenames.
         oss_strip_prefix: Prefix that should be stripped from OSS file names.
         proto_lib_deps: proto_library() rules that we will use to build the protos when we are
           not bootstrapping.
         visibility: Visibility list for the final upb_proto_library() rule.  Bootstrapping rules
           will always be hidden, and will not honor the visibility parameter passed here.
         deps: other bootstrap_upb_proto_library() rules that this one depends on.
         **kwargs: Other arguments that will be passed through to cc_library(), genrule(), and
           upb_proto_library().
     """
     _stage0_proto_staleness_test(name, base_dir, oss_src_files, oss_src_rules, oss_strip_prefix)

     # stage0 uses checked-in protos, and has no MiniTable.
     native.cc_library(
         name = name + "_stage0",
         srcs = _generated_srcs_for_suffix(base_dir + "stage0", oss_src_files, ".upb.c"),
         hdrs = _generated_srcs_for_suffix(base_dir + "stage0", oss_src_files, ".upb.h"),
         includes = [base_dir + "stage0"],
         visibility = ["//upb_generator:__pkg__"],
         # This macro signals to the runtime that it must use OSS APIs for descriptor.proto/plugin.proto.
         defines = ["UPB_BOOTSTRAP_STAGE0"],
         deps = [
             "//upb:generated_code_support__only_for_generated_code_do_not_use__i_give_permission_to_break_me",
             "//upb:mini_table",
         ] + [dep + "_stage0" for dep in deps],
         **kwargs
     )

     src_files = google3_src_files if _is_google3 else oss_src_files
     src_rules = google3_src_rules if _is_google3 else oss_src_rules

     # Generate stage1 protos (C API and MiniTables) using stage0 compiler.
     _generate_stage1_proto(name, base_dir, src_files, src_rules, "upb", kwargs)
     _generate_stage1_proto(name, base_dir, src_files, src_rules, "upb_minitable", kwargs)

     native.cc_library(
         name = name + "_minitable_stage1",
         srcs = _generated_srcs_for_suffix(base_dir + "stage1", src_files, ".upb_minitable.c"),
         hdrs = _generated_srcs_for_suffix(base_dir + "stage1", src_files, ".upb_minitable.h"),
         includes = [base_dir + "stage1"],
         visibility = ["//upb_generator:__pkg__"],
         deps = [
             "//upb:generated_code_support__only_for_generated_code_do_not_use__i_give_permission_to_break_me",
         ] + [dep + "_stage1" for dep in deps],
         **kwargs
     )
     native.cc_library(
         name = name + "_stage1",
         hdrs = _generated_srcs_for_suffix(base_dir + "stage1", src_files, ".upb.h"),
         includes = [base_dir + "stage1"],
         visibility = ["//upb_generator:__pkg__"],
         deps = [
             "//upb:generated_code_support__only_for_generated_code_do_not_use__i_give_permission_to_break_me",
             ":" + name + "_minitable_stage1",
         ] + [dep + "_stage1" for dep in deps],
         **kwargs
     )

     # The final protos are generated via normal upb_proto_library().
     upb_proto_library(
         name = name,
         deps = proto_lib_deps,
         visibility = visibility,
         **kwargs
     )

     # begin:github_only
     _cmake_staleness_test(name, base_dir, src_files, proto_lib_deps, **kwargs)

 # end:github_only
	"""Macros that implement bootstrapping for the upb code generator."""

	# begin:github_only
	load(
	"//bazel:upb_minitable_proto_library.bzl",
	"upb_minitable_proto_library",
	)
	# end:github_only

	load(
	"//bazel:upb_proto_library.bzl",
	"upb_proto_library",
	)
	load(
	"//upb/cmake:build_defs.bzl",
	"staleness_test",
	)

	_stages = ["_stage0", "_stage1", ""]
	_protoc = "//:protoc"
	_upbc_base = "//upb_generator:protoc-gen-"

	# begin:google_only
	# _is_google3 = True
	# _extra_proto_path = ""
	# end:google_only

	# begin:github_only
	_is_google3 = False
	_extra_proto_path = "-I$$(dirname $(location @com_google_protobuf//:descriptor_proto_srcs))/../.. "
	# end:github_only

	def _upbc(generator, stage):
	return _upbc_base + generator + _stages[stage]

	def bootstrap_cc_library(name, visibility, deps = [], bootstrap_deps = [], **kwargs):
	for stage in _stages:
	stage_visibility = visibility if stage == "" else ["//upb_generator:__pkg__"]
	native.cc_library(
	name = name + stage,
	deps = deps + [dep + stage for dep in bootstrap_deps],
	visibility = stage_visibility,
	**kwargs
	)

	def bootstrap_cc_binary(name, deps = [], bootstrap_deps = [], **kwargs):
	for stage in _stages:
	native.cc_binary(
	name = name + stage,
	deps = deps + [dep + stage for dep in bootstrap_deps],
	**kwargs
	)

	def _generated_srcs_for_suffix(prefix, srcs, suffix):
	return [prefix + "/" + src[:-len(".proto")] + suffix for src in srcs]

	def _generated_srcs_for_generator(prefix, srcs, generator):
	ret = _generated_srcs_for_suffix(prefix, srcs, ".{}.h".format(generator))

	if generator != "upb" or prefix.endswith("stage0"):
	ret += _generated_srcs_for_suffix(prefix, srcs, ".{}.c".format(generator))
	return ret

	def _generated_srcs(prefix, srcs):
	return _generated_srcs_for_generator(prefix, srcs, "upb")

	def _stage0_proto_staleness_test(name, base_dir, src_files, src_rules, strip_prefix):
	native.genrule(
	name = name + "_generate_bootstrap",
	srcs = src_rules,
	outs = _generated_srcs("bootstrap_generated_sources/" + base_dir + "stage0", src_files),
	tools = [_protoc, _upbc("upb", 0)],
	cmd =
	"$(location " + _protoc + ") " +
	"-I$(GENDIR)/" + strip_prefix + " " + _extra_proto_path +
	"--plugin=protoc-gen-upb=$(location " + _upbc("upb", 0) + ") " +
	"--upb_out=bootstrap_upb:$(@D)/bootstrap_generated_sources/" + base_dir + "stage0 " +
	" ".join(src_files),
	)

	staleness_test(
	name = name + "_stage0_staleness_test",
	outs = _generated_srcs(base_dir + "stage0", src_files),
	generated_pattern = "bootstrap_generated_sources/%s",
	target_files = native.glob([base_dir + "stage0/**"]),
	# To avoid skew problems for descriptor.proto/pluging.proto between
	# GitHub repos. It's not critical that the checked-in protos are up to
	# date for every change, they just needs to be complete enough to have
	# everything needed by the code generator itself.
	tags = ["manual"],
	)

	def _generate_stage1_proto(name, base_dir, src_files, src_rules, generator, kwargs):
	native.genrule(
	name = "gen_{}_{}_stage1".format(name, generator),
	srcs = src_rules,
	outs = _generated_srcs_for_generator(base_dir + "stage1", src_files, generator),
	cmd = "$(location " + _protoc + ") " +
	"--plugin=protoc-gen-" + generator +
	"=$(location " + _upbc(generator, 0) + ") " + _extra_proto_path +
	"--" + generator + "_out=$(RULEDIR)/" + base_dir + "stage1 " +
	" ".join(src_files),
	visibility = ["//upb_generator:__pkg__"],
	tools = [
	_protoc,
	_upbc(generator, 0),
	],
	**kwargs
	)

	# begin:github_only
	def _cmake_staleness_test(name, base_dir, src_files, proto_lib_deps, **kwargs):
	upb_minitable_proto_library(
	name = name + "_minitable",
	deps = proto_lib_deps,
	**kwargs
	)

	# Copy the final gencode for staleness comparison
	files = _generated_srcs("cmake" + base_dir, src_files) + \
	_generated_srcs_for_generator("cmake" + base_dir, src_files, "upb_minitable")
	genrule = 0
	for src in files:
	genrule += 1
	native.genrule(
	name = name + "_copy_gencode_%d" % genrule,
	outs = ["generated_sources/" + src],
	srcs = [name, name + "_minitable"],
	cmd = """
	mkdir -p $(@D)
	for src in $(SRCS); do
	if [[ $$src == *%s ]]; then
	cp -f $$src $(@D) \|\| echo 'copy failed!'
	fi
	done
	""" % src[src.rfind("/"):],
	)

	# Keep bazel gencode in sync with our checked-in sources needed for cmake builds.
	staleness_test(
	name = name + "_staleness_test",
	outs = files,
	generated_pattern = "generated_sources/%s",
	tags = ["manual"],
	)

	# end:github_only

	def bootstrap_upb_proto_library(
	name,
	base_dir,
	google3_src_files,
	google3_src_rules,
	oss_src_files,
	oss_src_rules,
	oss_strip_prefix,
	proto_lib_deps,
	visibility,
	deps = [],
	**kwargs):
	"""A version of upb_proto_library() that is augmented to allow for bootstrapping the compiler.

	Args:
	name: Name of this rule. This name will resolve to a upb_proto_library().
	base_dir: The directory that all generated files should be placed under.
	google3_src_files: Google3 filenames of .proto files that should be built by this rule.
	The names should be relative to the depot base.
	google3_src_rules: Target names of the Blaze rules that will provide these filenames.
	oss_src_files: OSS filenames of .proto files that should be built by this rule.
	oss_src_rules: Target names of the Bazel rules that will provide these filenames.
	oss_strip_prefix: Prefix that should be stripped from OSS file names.
	proto_lib_deps: proto_library() rules that we will use to build the protos when we are
	not bootstrapping.
	visibility: Visibility list for the final upb_proto_library() rule. Bootstrapping rules
	will always be hidden, and will not honor the visibility parameter passed here.
	deps: other bootstrap_upb_proto_library() rules that this one depends on.
	**kwargs: Other arguments that will be passed through to cc_library(), genrule(), and
	upb_proto_library().
	"""
	_stage0_proto_staleness_test(name, base_dir, oss_src_files, oss_src_rules, oss_strip_prefix)

	# stage0 uses checked-in protos, and has no MiniTable.
	native.cc_library(
	name = name + "_stage0",
	srcs = _generated_srcs_for_suffix(base_dir + "stage0", oss_src_files, ".upb.c"),
	hdrs = _generated_srcs_for_suffix(base_dir + "stage0", oss_src_files, ".upb.h"),
	includes = [base_dir + "stage0"],
	visibility = ["//upb_generator:__pkg__"],
	# This macro signals to the runtime that it must use OSS APIs for descriptor.proto/plugin.proto.
	defines = ["UPB_BOOTSTRAP_STAGE0"],
	deps = [
	"//upb:generated_code_support__only_for_generated_code_do_not_use__i_give_permission_to_break_me",
	"//upb:mini_table",
	] + [dep + "_stage0" for dep in deps],
	**kwargs
	)

	src_files = google3_src_files if _is_google3 else oss_src_files
	src_rules = google3_src_rules if _is_google3 else oss_src_rules

	# Generate stage1 protos (C API and MiniTables) using stage0 compiler.
	_generate_stage1_proto(name, base_dir, src_files, src_rules, "upb", kwargs)
	_generate_stage1_proto(name, base_dir, src_files, src_rules, "upb_minitable", kwargs)

	native.cc_library(
	name = name + "_minitable_stage1",
	srcs = _generated_srcs_for_suffix(base_dir + "stage1", src_files, ".upb_minitable.c"),
	hdrs = _generated_srcs_for_suffix(base_dir + "stage1", src_files, ".upb_minitable.h"),
	includes = [base_dir + "stage1"],
	visibility = ["//upb_generator:__pkg__"],
	deps = [
	"//upb:generated_code_support__only_for_generated_code_do_not_use__i_give_permission_to_break_me",
	] + [dep + "_stage1" for dep in deps],
	**kwargs
	)
	native.cc_library(
	name = name + "_stage1",
	hdrs = _generated_srcs_for_suffix(base_dir + "stage1", src_files, ".upb.h"),
	includes = [base_dir + "stage1"],
	visibility = ["//upb_generator:__pkg__"],
	deps = [
	"//upb:generated_code_support__only_for_generated_code_do_not_use__i_give_permission_to_break_me",
	":" + name + "_minitable_stage1",
	] + [dep + "_stage1" for dep in deps],
	**kwargs
	)

	# The final protos are generated via normal upb_proto_library().
	upb_proto_library(
	name = name,
	deps = proto_lib_deps,
	visibility = visibility,
	**kwargs
	)

	# begin:github_only
	_cmake_staleness_test(name, base_dir, src_files, proto_lib_deps, **kwargs)

	# end:github_only