llvm/tools/llvm-go/llvm-go.go
Andrew Wilkins 10add60748 Enable linking tools, shared libraries against libLLVM
Summary:
Three closely related changes, to have a mode in which we link all
executables and shared libraries against libLLVM. 

1. Add a new LLVM_LINK_LLVM_DYLIB cmake option, which, when ON, will link
   executables and shared libraries against libLLVM. For this to work, it
   is necessary to also set LLVM_BUILD_LLVM_DYLIB and LLVM_DYLIB_EXPORT_ALL.

   It is not strictly necessary to set LLVM_DISABLE_LLVM_DYLIB_ATEXIT, but
   we also default to OFF in this mode, or tools tend to misbehave (e.g.
   stdout may not flush on exit when output is buffered.)

   llvm-config and Tablegen do not use libLLVM, as they are dependencies of
   libLLVM.

2. Modify llvm-go to take a new flag, "linkmode=component-libs|dylib".
   Depending on which one is passed (default is component-libs), we link
   with the individual libraries or libLLVM respectively. We pass in dylib
   when LLVM_LINK_LLVM_DYLIB is ON.

3. Fix LLVM_DYLIB_EXPORT_ALL on Linux, and expand the symbols exported to
   actually export all. Don't strip leading underscore from symbols on Linux,
   and make sure we get all exported symbols and weak-with-default symbols
   ("W" in nm output). Without these changes, passes won't load because
   the "Annotate..." symbols defined in lib/Support/Valigrind.cpp are not
   found.

Testing:
 - Ran default build ("ninja") with LLVM, clang, compiler-rt, llgo, lldb.
 - Ran "check", "check-clang", "check-tsan", "check-libgo" targets. I've
   never had much success with LLDB tests, and llgoi is currently broken
   so check-llgo fails for an unrelated reason.
 - Ran "lldb" to ensure it loads.

Reviewers: chandlerc, beanz, pcc, rnk

Subscribers: rnk, chapuni, sylvestre.ledru, llvm-commits

Differential Revision: http://reviews.llvm.org/D12488

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@246527 91177308-0d34-0410-b5e6-96231b3b80d8
2015-09-01 03:14:31 +00:00

295 lines
6.1 KiB
Go

//===-- llvm-go.go - go tool wrapper for LLVM -----------------------------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This tool lets us build LLVM components within the tree by setting up a
// $GOPATH that resembles a tree fetched in the normal way with "go get".
//
//===----------------------------------------------------------------------===//
package main
import (
"fmt"
"io/ioutil"
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
)
const (
linkmodeComponentLibs = "component-libs"
linkmodeDylib = "dylib"
)
type pkg struct {
llvmpath, pkgpath string
}
var packages = []pkg{
{"bindings/go/llvm", "llvm.org/llvm/bindings/go/llvm"},
{"tools/llgo", "llvm.org/llgo"},
}
type compilerFlags struct {
cpp, cxx, ld string
}
var components = []string{
"all-targets",
"analysis",
"asmparser",
"asmprinter",
"bitreader",
"bitwriter",
"codegen",
"core",
"debuginfodwarf",
"executionengine",
"instrumentation",
"interpreter",
"ipo",
"irreader",
"linker",
"mc",
"mcjit",
"objcarcopts",
"option",
"profiledata",
"scalaropts",
"support",
"target",
}
func llvmConfig(args ...string) string {
configpath := os.Getenv("LLVM_CONFIG")
if configpath == "" {
bin, _ := filepath.Split(os.Args[0])
configpath = filepath.Join(bin, "llvm-config")
}
cmd := exec.Command(configpath, args...)
cmd.Stderr = os.Stderr
out, err := cmd.Output()
if err != nil {
panic(err.Error())
}
outstr := string(out)
outstr = strings.TrimSuffix(outstr, "\n")
outstr = strings.Replace(outstr, "\n", " ", -1)
return outstr
}
func llvmFlags(linkmode string) compilerFlags {
ldflags := llvmConfig("--ldflags")
switch linkmode {
case linkmodeComponentLibs:
ldflags += " " + llvmConfig(append([]string{"--libs"}, components...)...)
case linkmodeDylib:
ldflags += " -lLLVM"
default:
panic("invalid linkmode: " + linkmode)
}
ldflags += " " + llvmConfig("--system-libs")
if runtime.GOOS != "darwin" {
// OS X doesn't like -rpath with cgo. See:
// https://code.google.com/p/go/issues/detail?id=7293
ldflags = "-Wl,-rpath," + llvmConfig("--libdir") + " " + ldflags
}
return compilerFlags{
cpp: llvmConfig("--cppflags"),
cxx: "-std=c++11",
ld: ldflags,
}
}
func addTag(args []string, tag string) []string {
args = append([]string{}, args...)
addedTag := false
for i, a := range args {
if strings.HasPrefix(a, "-tags=") {
args[i] = a + " " + tag
addedTag = true
} else if a == "-tags" && i+1 < len(args) {
args[i+1] = args[i+1] + " " + tag
addedTag = true
}
}
if !addedTag {
args = append([]string{args[0], "-tags", tag}, args[1:]...)
}
return args
}
func printComponents() {
fmt.Println(strings.Join(components, " "))
}
func printConfig(linkmode string) {
flags := llvmFlags(linkmode)
fmt.Printf(`// +build !byollvm
// This file is generated by llvm-go, do not edit.
package llvm
/*
#cgo CPPFLAGS: %s
#cgo CXXFLAGS: %s
#cgo LDFLAGS: %s
*/
import "C"
type (run_build_sh int)
`, flags.cpp, flags.cxx, flags.ld)
}
func runGoWithLLVMEnv(args []string, cc, cxx, gocmd, llgo, cppflags, cxxflags, ldflags, linkmode string) {
args = addTag(args, "byollvm")
srcdir := llvmConfig("--src-root")
tmpgopath, err := ioutil.TempDir("", "gopath")
if err != nil {
panic(err.Error())
}
for _, p := range packages {
path := filepath.Join(tmpgopath, "src", p.pkgpath)
err := os.MkdirAll(filepath.Dir(path), os.ModePerm)
if err != nil {
panic(err.Error())
}
err = os.Symlink(filepath.Join(srcdir, p.llvmpath), path)
if err != nil {
panic(err.Error())
}
}
newpath := os.Getenv("PATH")
newgopathlist := []string{tmpgopath}
newgopathlist = append(newgopathlist, filepath.SplitList(os.Getenv("GOPATH"))...)
newgopath := strings.Join(newgopathlist, string(filepath.ListSeparator))
flags := llvmFlags(linkmode)
newenv := []string{
"CC=" + cc,
"CXX=" + cxx,
"CGO_CPPFLAGS=" + flags.cpp + " " + cppflags,
"CGO_CXXFLAGS=" + flags.cxx + " " + cxxflags,
"CGO_LDFLAGS=" + flags.ld + " " + ldflags,
"GOPATH=" + newgopath,
"PATH=" + newpath,
}
if llgo != "" {
newenv = append(newenv, "GCCGO="+llgo)
}
for _, v := range os.Environ() {
if !strings.HasPrefix(v, "CC=") &&
!strings.HasPrefix(v, "CXX=") &&
!strings.HasPrefix(v, "CGO_CPPFLAGS=") &&
!strings.HasPrefix(v, "CGO_CXXFLAGS=") &&
!strings.HasPrefix(v, "CGO_LDFLAGS=") &&
!strings.HasPrefix(v, "GCCGO=") &&
!strings.HasPrefix(v, "GOPATH=") &&
!strings.HasPrefix(v, "PATH=") {
newenv = append(newenv, v)
}
}
gocmdpath, err := exec.LookPath(gocmd)
if err != nil {
panic(err.Error())
}
proc, err := os.StartProcess(gocmdpath, append([]string{gocmd}, args...),
&os.ProcAttr{
Env: newenv,
Files: []*os.File{os.Stdin, os.Stdout, os.Stderr},
})
if err != nil {
panic(err.Error())
}
ps, err := proc.Wait()
if err != nil {
panic(err.Error())
}
os.RemoveAll(tmpgopath)
if !ps.Success() {
os.Exit(1)
}
}
func usage() {
fmt.Println(`Usage: llvm-go subcommand [flags]
Available subcommands: build get install run test print-components print-config`)
os.Exit(0)
}
func main() {
cc := os.Getenv("CC")
cxx := os.Getenv("CXX")
cppflags := os.Getenv("CGO_CPPFLAGS")
cxxflags := os.Getenv("CGO_CXXFLAGS")
ldflags := os.Getenv("CGO_LDFLAGS")
gocmd := "go"
llgo := ""
linkmode := linkmodeComponentLibs
flags := []struct {
name string
dest *string
}{
{"cc", &cc},
{"cxx", &cxx},
{"go", &gocmd},
{"llgo", &llgo},
{"cppflags", &cppflags},
{"ldflags", &ldflags},
{"linkmode", &linkmode},
}
args := os.Args[1:]
LOOP:
for {
if len(args) == 0 {
usage()
}
for _, flag := range flags {
if strings.HasPrefix(args[0], flag.name+"=") {
*flag.dest = args[0][len(flag.name)+1:]
args = args[1:]
continue LOOP
}
}
break
}
switch args[0] {
case "build", "get", "install", "run", "test":
runGoWithLLVMEnv(args, cc, cxx, gocmd, llgo, cppflags, cxxflags, ldflags, linkmode)
case "print-components":
printComponents()
case "print-config":
printConfig(linkmode)
default:
usage()
}
}