blob: 30f9612d36a42a54f87408d8f68d8f8997ea44ff [file] [log] [blame]
// Copyright 2016 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cc
import (
"path/filepath"
"android/soong/android"
)
// This file handles installing files into their final location
type InstallerProperties struct {
// install to a subdirectory of the default install path for the module
Relative_install_path *string `android:"arch_variant"`
// Install output directly in {partition}/, not in any subdir. This is only intended for use by
// init_first_stage.
Install_in_root *bool `android:"arch_variant"`
// Install output directly in {partition}/xbin
Install_in_xbin *bool `android:"arch_variant"`
}
type installLocation int
const (
InstallInSystem installLocation = 0
InstallInData = iota
InstallInSanitizerDir = iota
)
func NewBaseInstaller(dir, dir64 string, location installLocation) *baseInstaller {
return &baseInstaller{
dir: dir,
dir64: dir64,
location: location,
}
}
type baseInstaller struct {
Properties InstallerProperties
dir string
dir64 string
subDir string
relative string
location installLocation
installDeps android.InstallPaths
path android.InstallPath
}
var _ installer = (*baseInstaller)(nil)
func (installer *baseInstaller) installerProps() []interface{} {
return []interface{}{&installer.Properties}
}
func (installer *baseInstaller) installDir(ctx ModuleContext) android.InstallPath {
dir := installer.dir
if ctx.toolchain().Is64Bit() && installer.dir64 != "" {
dir = installer.dir64
}
if installer.installInRoot() {
dir = ""
} else if installer.installInXbin() {
dir = "xbin"
}
if ctx.Target().NativeBridge == android.NativeBridgeEnabled {
dir = filepath.Join(dir, ctx.Target().NativeBridgeRelativePath)
} else if !ctx.Host() && ctx.Config().HasMultilibConflict(ctx.Arch().ArchType) {
dir = filepath.Join(dir, ctx.Arch().ArchType.String())
}
if installer.location == InstallInData && ctx.InVendorOrProduct() {
if ctx.inProduct() {
dir = filepath.Join(dir, "product")
} else {
dir = filepath.Join(dir, "vendor")
}
}
return android.PathForModuleInstall(ctx, dir, installer.subDir,
installer.relativeInstallPath(), installer.relative)
}
func (installer *baseInstaller) install(ctx ModuleContext, file android.Path) {
installer.path = ctx.InstallFile(installer.installDir(ctx), file.Base(), file, installer.installDeps...)
}
func (installer *baseInstaller) installTestData(ctx ModuleContext, data []android.DataPath) {
installedData := ctx.InstallTestData(installer.installDir(ctx), data)
installer.installDeps = append(installer.installDeps, installedData...)
}
func (installer *baseInstaller) everInstallable() bool {
// Most cc modules are installable.
return true
}
func (installer *baseInstaller) inData() bool {
return installer.location == InstallInData
}
func (installer *baseInstaller) inSanitizerDir() bool {
return installer.location == InstallInSanitizerDir
}
func (installer *baseInstaller) hostToolPath() android.OptionalPath {
return android.OptionalPath{}
}
func (installer *baseInstaller) relativeInstallPath() string {
return String(installer.Properties.Relative_install_path)
}
func (installer *baseInstaller) makeUninstallable(mod *Module) {
mod.ModuleBase.MakeUninstallable()
}
func (installer *baseInstaller) installInRoot() bool {
return Bool(installer.Properties.Install_in_root)
}
func (installer *baseInstaller) installInXbin() bool {
return Bool(installer.Properties.Install_in_xbin)
}