summaryrefslogtreecommitdiffhomepage
path: root/tools/go_stateify/defs.bzl
diff options
context:
space:
mode:
authorZhaozhong Ni <nzz@google.com>2018-07-27 10:16:27 -0700
committerShentubot <shentubot@google.com>2018-07-27 10:17:21 -0700
commitbe7fcbc5582fe831b5ec63f773d867d7591e27a1 (patch)
tree0b14ffa46eebaeab73a751ac4b3b38e434bbed67 /tools/go_stateify/defs.bzl
parentb8f96a9d0b9868060025e7a89e99e1b30d17fa8b (diff)
stateify: support explicit annotation mode; convert refs and stack packages.
We have been unnecessarily creating too many savable types implicitly. PiperOrigin-RevId: 206334201 Change-Id: Idc5a3a14bfb7ee125c4f2bb2b1c53164e46f29a8
Diffstat (limited to 'tools/go_stateify/defs.bzl')
-rw-r--r--tools/go_stateify/defs.bzl58
1 files changed, 47 insertions, 11 deletions
diff --git a/tools/go_stateify/defs.bzl b/tools/go_stateify/defs.bzl
index 60a9895ff..2b2582b7a 100644
--- a/tools/go_stateify/defs.bzl
+++ b/tools/go_stateify/defs.bzl
@@ -22,6 +22,8 @@ go_library(
)
"""
+load("@io_bazel_rules_go//go:def.bzl", _go_library = "go_library", _go_test = "go_test")
+
def _go_stateify_impl(ctx):
"""Implementation for the stateify tool."""
output = ctx.outputs.out
@@ -33,6 +35,8 @@ def _go_stateify_impl(ctx):
args += ["-statepkg=%s" % ctx.attr._statepkg]
if ctx.attr.imports:
args += ["-imports=%s" % ",".join(ctx.attr.imports)]
+ if ctx.attr.explicit:
+ args += ["-explicit=true"]
args += ["--"]
for src in ctx.attr.srcs:
args += [f.path for f in src.files]
@@ -45,17 +49,15 @@ def _go_stateify_impl(ctx):
executable = ctx.executable._tool,
)
-"""
-Generates save and restore logic from a set of Go files.
-
-
-Args:
- name: the name of the rule.
- srcs: the input source files. These files should include all structs in the package that need to be saved.
- imports: an optional list of extra non-aliased, Go-style absolute import paths.
- out: the name of the generated file output. This must not conflict with any other files and must be added to the srcs of the relevant go_library.
- package: the package name for the input sources.
-"""
+# Generates save and restore logic from a set of Go files.
+#
+# Args:
+# name: the name of the rule.
+# srcs: the input source files. These files should include all structs in the package that need to be saved.
+# imports: an optional list of extra non-aliased, Go-style absolute import paths.
+# out: the name of the generated file output. This must not conflict with any other files and must be added to the srcs of the relevant go_library.
+# package: the package name for the input sources.
+# explicit: only generate for types explicitly annotated as savable.
go_stateify = rule(
implementation = _go_stateify_impl,
attrs = {
@@ -63,7 +65,41 @@ go_stateify = rule(
"imports": attr.string_list(mandatory = False),
"package": attr.string(mandatory = True),
"out": attr.output(mandatory = True),
+ "explicit": attr.bool(default = False),
"_tool": attr.label(executable = True, cfg = "host", default = Label("//tools/go_stateify:stateify")),
"_statepkg": attr.string(default = "gvisor.googlesource.com/gvisor/pkg/state"),
},
)
+
+def go_library(name, srcs, deps = [], imports = [], **kwargs):
+ """wraps the standard go_library and does stateification."""
+ if "encode_unsafe.go" not in srcs and (name + "_state_autogen.go") not in srcs:
+ # Only do stateification for non-state packages without manual autogen.
+ go_stateify(
+ name = name + "_state_autogen",
+ srcs = [src for src in srcs if src.endswith(".go")],
+ imports = imports,
+ package = name,
+ out = name + "_state_autogen.go",
+ explicit = True,
+ )
+ all_srcs = srcs + [name + "_state_autogen.go"]
+ if "//pkg/state" not in deps:
+ all_deps = deps + ["//pkg/state"]
+ else:
+ all_deps = deps
+ else:
+ all_deps = deps
+ all_srcs = srcs
+ _go_library(
+ name = name,
+ srcs = all_srcs,
+ deps = all_deps,
+ **kwargs
+ )
+
+def go_test(**kwargs):
+ """Wraps the standard go_test."""
+ _go_test(
+ **kwargs
+ )