-
Notifications
You must be signed in to change notification settings - Fork 3.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
dev,generate-cgo: externalize cgo files gen into a seperate binary #104554
Merged
+229
−77
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| load("//build/bazelutil/unused_checker:unused.bzl", "get_x_data") | ||
| load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library") | ||
|
|
||
| go_library( | ||
| name = "generate-cgo_lib", | ||
| srcs = ["main.go"], | ||
| importpath = "github.com/cockroachdb/cockroach/pkg/cmd/generate-cgo", | ||
| visibility = ["//visibility:private"], | ||
| deps = [ | ||
| "@com_github_alessio_shellescape//:shellescape", | ||
| "@com_github_cockroachdb_errors//:errors", | ||
| ], | ||
| ) | ||
|
|
||
| go_binary( | ||
| name = "generate-cgo", | ||
| embed = [":generate-cgo_lib"], | ||
| visibility = ["//visibility:public"], | ||
| ) | ||
|
|
||
| get_x_data(name = "get_x_data") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| // Copyright 2023 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "os" | ||
| "os/exec" | ||
| "path/filepath" | ||
| "runtime" | ||
| "strings" | ||
| "text/template" | ||
|
|
||
| "github.com/alessio/shellescape" | ||
| "github.com/cockroachdb/errors" | ||
| ) | ||
|
|
||
| type configuration struct { | ||
| Os string | ||
| Arch string | ||
| } | ||
|
|
||
| var ( | ||
| workspace string | ||
| bazelBin string | ||
| archivedCdepConfigurations = []configuration{ | ||
| {"linux", "amd64"}, | ||
| {"linux", "arm64"}, | ||
| {"darwin", "amd64"}, | ||
| {"darwin", "arm64"}, | ||
| {"windows", "amd64"}, | ||
| } | ||
| ) | ||
|
|
||
| func logCommand(cmd string, args ...string) { | ||
| var fullArgs []string | ||
| fullArgs = append(fullArgs, cmd) | ||
| fullArgs = append(fullArgs, args...) | ||
| log.Printf("$ %s", shellescape.QuoteCommand(fullArgs)) | ||
| } | ||
|
|
||
| // getArchivedCdepString returns a non-empty string iff the force_build_cdeps | ||
| // config is not being used. This string is the name of the cross config used to | ||
| // build the pre-built c-deps, minus the "cross" prefix. This can be used to | ||
| // locate the pre-built c-dep in | ||
| // $EXECUTION_ROOT/external/archived_cdep_{LIB}_{ARCHIVED_CDEP_STRING}. | ||
| // If the returned string is empty then force_build_cdeps is set in which case | ||
| // the (non-pre-built) libraries can be found in $BAZEL_BIN/c-deps/{LIB}_foreign. | ||
| // | ||
| // You MUST build //build/bazelutil:test_force_build_cdeps before calling this | ||
| // function. | ||
| func getArchivedCdepString(bazelBin string) (string, error) { | ||
| var ret string | ||
| // If force_build_cdeps is set then the prebuilt libraries won't be in | ||
| // the archived location anyway. | ||
| forceBuildCdeps, err := os.ReadFile(filepath.Join(bazelBin, "build", "bazelutil", "test_force_build_cdeps.txt")) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| // force_build_cdeps is activated if the length of this file is not 0. | ||
| if len(forceBuildCdeps) == 0 { | ||
| for _, config := range archivedCdepConfigurations { | ||
| if config.Os == runtime.GOOS && config.Arch == runtime.GOARCH { | ||
| ret = config.Os | ||
| if ret == "darwin" { | ||
| ret = "macos" | ||
| } | ||
| if config.Arch == "arm64" { | ||
| ret += "arm" | ||
| } | ||
| break | ||
| } | ||
| } | ||
| } | ||
| return ret, nil | ||
| } | ||
|
|
||
| func getBazelInfo(info string) (string, error) { | ||
| args := []string{"info", info, "--color=no"} | ||
| logCommand("bazel", args...) | ||
| cmd := exec.Command("bazel", args...) | ||
| var outBuf, errBuf strings.Builder | ||
| cmd.Stdout = &outBuf | ||
| cmd.Stderr = &errBuf | ||
| if err := cmd.Run(); err != nil { | ||
| return "", errors.Wrapf(err, "Stderr: %s", errBuf.String()) | ||
| } else { | ||
| return strings.TrimSpace(outBuf.String()), nil | ||
| } | ||
| } | ||
|
|
||
| func generateCgo() error { | ||
| if workspace == "" || bazelBin == "" { | ||
| return errors.New("--workspace and --bazel-bin are required") | ||
| } | ||
| args := []string{"build", "//build/bazelutil:test_force_build_cdeps", "//c-deps:libjemalloc", "//c-deps:libproj"} | ||
| if runtime.GOOS == "linux" { | ||
| args = append(args, "//c-deps:libkrb5") | ||
| } | ||
| logCommand("bazel", args...) | ||
| cmd := exec.Command("bazel", args...) | ||
| var outBuf, errBuf strings.Builder | ||
| cmd.Stdout = &outBuf | ||
| cmd.Stderr = &errBuf | ||
| if err := cmd.Run(); err != nil { | ||
| return errors.Wrapf(err, "Stderr: %s", errBuf.String()) | ||
| } | ||
|
|
||
| const cgoTmpl = `// GENERATED FILE DO NOT EDIT | ||
| package {{ .Package }} | ||
| // #cgo CPPFLAGS: {{ .CPPFlags }} | ||
| // #cgo LDFLAGS: {{ .LDFlags }} | ||
| import "C" | ||
| ` | ||
|
|
||
| tpl := template.Must(template.New("source").Parse(cgoTmpl)) | ||
| archived, err := getArchivedCdepString(bazelBin) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| // Figure out where to find the c-deps libraries. | ||
| var jemallocDir, projDir, krbDir string | ||
| if archived != "" { | ||
| execRoot, err := getBazelInfo("execution_root") | ||
| if err != nil { | ||
| return err | ||
| } | ||
| jemallocDir = filepath.Join(execRoot, "external", fmt.Sprintf("archived_cdep_libjemalloc_%s", archived)) | ||
| projDir = filepath.Join(execRoot, "external", fmt.Sprintf("archived_cdep_libproj_%s", archived)) | ||
| if runtime.GOOS == "linux" { | ||
| krbDir = filepath.Join(execRoot, "external", fmt.Sprintf("archived_cdep_libkrb5_%s", archived)) | ||
| } | ||
| } else { | ||
| jemallocDir = filepath.Join(bazelBin, "c-deps/libjemalloc_foreign") | ||
| projDir = filepath.Join(bazelBin, "c-deps/libproj_foreign") | ||
| if runtime.GOOS == "linux" { | ||
| krbDir = filepath.Join(bazelBin, "c-deps/libkrb5_foreign") | ||
| } | ||
| } | ||
| cppFlags := fmt.Sprintf("-I%s", filepath.Join(jemallocDir, "include")) | ||
| ldFlags := fmt.Sprintf("-L%s -L%s", filepath.Join(jemallocDir, "lib"), filepath.Join(projDir, "lib")) | ||
| if krbDir != "" { | ||
| cppFlags += fmt.Sprintf(" -I%s", filepath.Join(krbDir, "include")) | ||
| ldFlags += fmt.Sprintf(" -L%s", filepath.Join(krbDir, "lib")) | ||
| } | ||
|
|
||
| cgoPkgs := []string{ | ||
| "pkg/cli", | ||
| "pkg/cli/clisqlshell", | ||
| "pkg/server/status", | ||
| "pkg/ccl/gssapiccl", | ||
| "pkg/geo/geoproj", | ||
| } | ||
|
|
||
| for _, cgoPkg := range cgoPkgs { | ||
| out, err := os.Create(filepath.Join(workspace, cgoPkg, "zcgo_flags.go")) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| err = tpl.Execute(out, struct { | ||
| Package string | ||
| CPPFlags string | ||
| LDFlags string | ||
| }{Package: filepath.Base(cgoPkg), CPPFlags: cppFlags, LDFlags: ldFlags}) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func main() { | ||
| var err error | ||
| workspace, err = getBazelInfo("workspace") | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| bazelBin, err = getBazelInfo("bazel-bin") | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| if err := generateCgo(); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should add:
Or something like this to make sure the binary is executed in the workspace directory.