// 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 (
 "github.com/google/blueprint/depset"
 "github.com/google/blueprint/proptools"

 "android/soong/android"
)

func init() {
 RegisterPrebuiltBuildComponents(android.InitRegistrationContext)
}

func RegisterPrebuiltBuildComponents(ctx android.RegistrationContext) {
 ctx.RegisterModuleType("cc_prebuilt_library", PrebuiltLibraryFactory)
 ctx.RegisterModuleType("cc_prebuilt_library_shared", PrebuiltSharedLibraryFactory)
 ctx.RegisterModuleType("cc_prebuilt_library_static", PrebuiltStaticLibraryFactory)
 ctx.RegisterModuleType("cc_prebuilt_test_library_shared", PrebuiltSharedTestLibraryFactory)
 ctx.RegisterModuleType("cc_prebuilt_object", PrebuiltObjectFactory)
 ctx.RegisterModuleType("cc_prebuilt_binary", PrebuiltBinaryFactory)
 ctx.RegisterModuleType("cc_prebuilt_test_binary", PrebuiltTestBinaryFactory)
}

type prebuiltLinkerInterface interface {
 Name(string) string
 prebuilt() *android.Prebuilt
 sourceModuleName() string
}

type prebuiltLinkerProperties struct {
 // Name of the source soong module that gets shadowed by this prebuilt
 // If unspecified, follows the naming convention that the source module of
 // the prebuilt is Name() without "prebuilt_" prefix
 Source_module_name *string

 // a prebuilt library or binary. Can reference a genrule module that generates an executable file.
 Srcs proptools.Configurable[[]string] `android:"path,arch_variant"`

 Sanitized Sanitized `android:"arch_variant"`

 // Check the prebuilt ELF files (e.g. DT_SONAME, DT_NEEDED, resolution of undefined
 // symbols, etc), default true.
 Check_elf_files *bool `android:"arch_variant"`

 // if set, add an extra objcopy --prefix-symbols= step
 Prefix_symbols *string

 // Optionally provide an import library if this is a Windows PE DLL prebuilt.
 // This is needed only if this library is linked by other modules in build time.
 // Only makes sense for the Windows target.
 Windows_import_lib *string `android:"path,arch_variant"`
}

type prebuiltLinker struct {
 android.Prebuilt

 properties prebuiltLinkerProperties
}

func (p *prebuiltLinker) prebuilt() *android.Prebuilt {
 return &p.Prebuilt
}

type prebuiltLibraryInterface interface {
 libraryInterface
 prebuiltLinkerInterface
 disablePrebuilt()
}

type prebuiltLibraryLinker struct {
 *libraryDecorator
 prebuiltLinker
}

var _ prebuiltLinkerInterface = (*prebuiltLibraryLinker)(nil)
var _ prebuiltLibraryInterface = (*prebuiltLibraryLinker)(nil)

func (p *prebuiltLibraryLinker) linkerInit(ctx BaseModuleContext) {}

func (p *prebuiltLibraryLinker) linkerDeps(ctx DepsContext, deps Deps) Deps {
 return p.libraryDecorator.linkerDeps(ctx, deps)
}

func (p *prebuiltLibraryLinker) linkerProps() []interface{} {
 return p.libraryDecorator.linkerProps()
}

func (p *prebuiltLibraryLinker) link(ctx ModuleContext,
 flags Flags, deps PathDeps, objs Objects) android.Path {

 p.libraryDecorator.flagExporter.exportIncludes(ctx)
 p.libraryDecorator.flagExporter.reexportDirs(deps.ReexportedDirs...)
 p.libraryDecorator.flagExporter.reexportSystemDirs(deps.ReexportedSystemDirs...)
 p.libraryDecorator.flagExporter.reexportFlags(deps.ReexportedFlags...)
 p.libraryDecorator.flagExporter.reexportDeps(deps.ReexportedDeps...)
 p.libraryDecorator.flagExporter.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)

 p.libraryDecorator.flagExporter.setProvider(ctx)

 srcs := p.prebuiltSrcs(ctx)
 stubInfo := AddStubDependencyProviders(ctx)

 // Stub variants will create a stub .so file from stub .c files
 if p.BuildStubs() && objs.objFiles != nil {
  // TODO (b/275273834): Make objs.objFiles == nil a hard error when the symbol files have been added to module sdk.
  return p.linkShared(ctx, flags, deps, objs)
 }

 if len(srcs) > 0 {
  if len(srcs) > 1 {
   ctx.PropertyErrorf("srcs", "multiple prebuilt source files")
   return nil
  }

  p.libraryDecorator.exportVersioningMacroIfNeeded(ctx)

  in := android.PathForModuleSrc(ctx, srcs[0])

  if String(p.prebuiltLinker.properties.Prefix_symbols) != "" {
   prefixed := android.PathForModuleOut(ctx, "prefixed", srcs[0])
   transformBinaryPrefixSymbols(ctx, String(p.prebuiltLinker.properties.Prefix_symbols),
    in, flagsToBuilderFlags(flags), prefixed)
   in = prefixed
  }

  if p.static() {
   depSet := depset.NewBuilder[android.Path](depset.TOPOLOGICAL).Direct(in).Build()
   android.SetProvider(ctx, StaticLibraryInfoProvider, StaticLibraryInfo{
    StaticLibrary: in,

    TransitiveStaticLibrariesForOrdering: depSet,
   })
   return in
  }

  if p.shared() {
   p.unstrippedOutputFile = in
   libName := p.libraryDecorator.getLibName(ctx) + flags.Toolchain.ShlibSuffix()

   var validations android.Paths
   if p.shouldCheckElfFile(ctx) {
    validations = append(validations, p.checkElfFile(ctx, libName, deps, in))
   }
   outputFile := android.PathForModuleOut(ctx, libName)
   var implicits android.Paths

   if p.stripper.NeedsStrip(ctx) {
    stripFlags := flagsToStripFlags(flags)
    stripped := android.PathForModuleOut(ctx, "stripped", libName)
    p.stripper.StripExecutableOrSharedLib(ctx, in, stripped, stripFlags)
    in = stripped
   }

   // Optimize out relinking against shared libraries whose interface hasn't changed by
   // depending on a table of contents file instead of the library itself.
   tocFile := android.PathForModuleOut(ctx, libName+".toc")
   p.tocFile = android.OptionalPathForPath(tocFile)
   TransformSharedObjectToToc(ctx, outputFile, tocFile)

   if ctx.Windows() && p.properties.Windows_import_lib != nil {
    // Consumers of this library actually links to the import library in build
    // time and dynamically links to the DLL in run time. i.e.
    // a.exe <-- static link --> foo.lib <-- dynamic link --> foo.dll
    importLibSrc := android.PathForModuleSrc(ctx, String(p.properties.Windows_import_lib))
    importLibName := p.libraryDecorator.getLibName(ctx) + ".lib"
    importLibOutputFile := android.PathForModuleOut(ctx, importLibName)
    implicits = append(implicits, importLibOutputFile)

    ctx.Build(pctx, android.BuildParams{
     Rule:        android.CpExecutable,
     Description: "prebuilt import library",
     Input:       importLibSrc,
     Output:      importLibOutputFile,
     Args: map[string]string{
      "cpFlags": "-L",
     },
    })
   }

   ctx.Build(pctx, android.BuildParams{
    Rule:        android.CpExecutable,
    Description: "prebuilt shared library",
    Implicits:   implicits,
    Input:       in,
    Output:      outputFile,
    Validations: validations,
    Args: map[string]string{
     "cpFlags": "-L",
    },
   })

   android.SetProvider(ctx, SharedLibraryInfoProvider, SharedLibraryInfo{
    SharedLibrary: outputFile,
    Target:        ctx.Target(),

    TableOfContents: p.tocFile,
    IsStubs:         p.BuildStubs(),
   })

   return outputFile
  }
 } else if p.shared() && len(stubInfo) > 0 {
  // This is a prebuilt which does not have any implementation (nil `srcs`), but provides APIs.
  // Provide the latest (i.e. `current`) stubs to reverse dependencies.
  latestStub := stubInfo[len(stubInfo)-1].SharedLibraryInfo.SharedLibrary
  android.SetProvider(ctx, SharedLibraryInfoProvider, SharedLibraryInfo{
   SharedLibrary: latestStub,
   Target:        ctx.Target(),
   IsStubs:       true,
  })

  return latestStub
 }

 if p.header() {
  android.SetProvider(ctx, HeaderLibraryInfoProvider, HeaderLibraryInfo{})

  // Need to return an output path so that the AndroidMk logic doesn't skip
  // the prebuilt header. For compatibility, in case Android.mk files use a
  // header lib in LOCAL_STATIC_LIBRARIES, create an empty ar file as
  // placeholder, just like non-prebuilt header modules do in linkStatic().
  ph := android.PathForModuleOut(ctx, ctx.ModuleName()+staticLibraryExtension)
  transformObjToStaticLib(ctx, nil, nil, builderFlags{}, ph, nil, nil)
  return ph
 }

 return nil
}

func (p *prebuiltLibraryLinker) prebuiltSrcs(ctx android.BaseModuleContext) []string {
 sanitize := ctx.Module().(*Module).sanitize
 srcs := p.properties.Srcs.GetOrDefault(ctx, nil)
 srcs = append(srcs, srcsForSanitizer(sanitize, p.properties.Sanitized)...)
 if p.static() {
  srcs = append(srcs, p.libraryDecorator.StaticProperties.Static.Srcs.GetOrDefault(ctx, nil)...)
  srcs = append(srcs, srcsForSanitizer(sanitize, p.libraryDecorator.StaticProperties.Static.Sanitized)...)
 }
 if p.shared() {
  srcs = append(srcs, p.libraryDecorator.SharedProperties.Shared.Srcs.GetOrDefault(ctx, nil)...)
  srcs = append(srcs, srcsForSanitizer(sanitize, p.libraryDecorator.SharedProperties.Shared.Sanitized)...)
 }
 return srcs
}

func (p *prebuiltLibraryLinker) shared() bool {
 return p.libraryDecorator.shared()
}

func (p *prebuiltLibraryLinker) nativeCoverage() bool {
 return false
}

func (p *prebuiltLibraryLinker) disablePrebuilt() {
 p.properties.Srcs = proptools.NewConfigurable[[]string](nil, nil)
 p.properties.Sanitized.None.Srcs = nil
 p.properties.Sanitized.Address.Srcs = nil
 p.properties.Sanitized.Hwaddress.Srcs = nil
}

// Implements versionedInterface
func (p *prebuiltLibraryLinker) ImplementationModuleName(name string) string {
 return android.RemoveOptionalPrebuiltPrefix(name)
}

func NewPrebuiltLibrary(hod android.HostOrDeviceSupported, srcsProperty string) (*Module, *libraryDecorator) {
 module, library := NewLibrary(hod)

 prebuilt := &prebuiltLibraryLinker{
  libraryDecorator: library,
 }
 module.compiler = prebuilt
 module.linker = prebuilt
 module.library = prebuilt

 module.AddProperties(&prebuilt.properties)

 if srcsProperty == "" {
  android.InitPrebuiltModuleWithoutSrcs(module)
 } else {
  srcsSupplier := func(ctx android.BaseModuleContext, _ android.Module) []string {
   return prebuilt.prebuiltSrcs(ctx)
  }

  android.InitPrebuiltModuleWithSrcSupplier(module, srcsSupplier, srcsProperty)
 }

 return module, library
}

func (p *prebuiltLibraryLinker) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
 if p.BuildStubs() && p.StubsVersion() != "" {
  return p.compileModuleLibApiStubs(ctx, flags, deps)
 }
 return Objects{}
}

// cc_prebuilt_library installs a precompiled shared library that are
// listed in the srcs property in the device's directory.
func PrebuiltLibraryFactory() android.Module {
 module, _ := NewPrebuiltLibrary(android.HostAndDeviceSupported, "srcs")

 // Prebuilt shared libraries can be included in APEXes
 android.InitApexModule(module)

 return module.Init()
}

// cc_prebuilt_library_shared installs a precompiled shared library that are
// listed in the srcs property in the device's directory.
func PrebuiltSharedLibraryFactory() android.Module {
 module, _ := NewPrebuiltSharedLibrary(android.HostAndDeviceSupported)
 return module.Init()
}

// cc_prebuilt_test_library_shared installs a precompiled shared library
// to be used as a data dependency of a test-related module (such as cc_test, or
// cc_test_library).
func PrebuiltSharedTestLibraryFactory() android.Module {
 module, library := NewPrebuiltLibrary(android.HostAndDeviceSupported, "srcs")
 library.BuildOnlyShared()
 library.baseInstaller = NewTestInstaller()
 return module.Init()
}

func NewPrebuiltSharedLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
 module, library := NewPrebuiltLibrary(hod, "srcs")
 library.BuildOnlyShared()

 // Prebuilt shared libraries can be included in APEXes
 android.InitApexModule(module)

 return module, library
}

// cc_prebuilt_library_static installs a precompiled static library that are
// listed in the srcs property in the device's directory.
func PrebuiltStaticLibraryFactory() android.Module {
 module, _ := NewPrebuiltStaticLibrary(android.HostAndDeviceSupported)
 return module.Init()
}

func NewPrebuiltStaticLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
 module, library := NewPrebuiltLibrary(hod, "srcs")
 library.BuildOnlyStatic()

 return module, library
}

type prebuiltObjectProperties struct {
 // Name of the source soong module that gets shadowed by this prebuilt
 // If unspecified, follows the naming convention that the source module of
 // the prebuilt is Name() without "prebuilt_" prefix
 Source_module_name *string
 Srcs               []string `android:"path,arch_variant"`
}

type prebuiltObjectLinker struct {
 android.Prebuilt
 objectLinker

 properties prebuiltObjectProperties
}

func (p *prebuiltObjectLinker) prebuilt() *android.Prebuilt {
 return &p.Prebuilt
}

func (p *prebuiltObjectLinker) sourceModuleName() string {
 return proptools.String(p.properties.Source_module_name)
}

var _ prebuiltLinkerInterface = (*prebuiltObjectLinker)(nil)

func (p *prebuiltObjectLinker) link(ctx ModuleContext,
 flags Flags, deps PathDeps, objs Objects) android.Path {
 if len(p.properties.Srcs) > 0 {
  // Copy objects to a name matching the final installed name
  in := p.Prebuilt.SingleSourcePath(ctx)
  outputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".o")
  ctx.Build(pctx, android.BuildParams{
   Rule:        android.CpExecutable,
   Description: "prebuilt",
   Output:      outputFile,
   Input:       in,
  })
  return outputFile
 }
 return nil
}

func (p *prebuiltObjectLinker) object() bool {
 return true
}

func NewPrebuiltObject(hod android.HostOrDeviceSupported) *Module {
 module := newObject(hod)
 prebuilt := &prebuiltObjectLinker{
  objectLinker: objectLinker{
   baseLinker: NewBaseLinker(nil),
  },
 }
 module.linker = prebuilt
 module.AddProperties(&prebuilt.properties)
 android.InitPrebuiltModule(module, &prebuilt.properties.Srcs)
 return module
}

func PrebuiltObjectFactory() android.Module {
 module := NewPrebuiltObject(android.HostAndDeviceSupported)
 return module.Init()
}

type prebuiltBinaryLinker struct {
 *binaryDecorator
 prebuiltLinker

 toolPath android.OptionalPath
}

var _ prebuiltLinkerInterface = (*prebuiltBinaryLinker)(nil)

func (p *prebuiltBinaryLinker) hostToolPath() android.OptionalPath {
 return p.toolPath
}

func (p *prebuiltBinaryLinker) link(ctx ModuleContext,
 flags Flags, deps PathDeps, objs Objects) android.Path {
 // TODO(ccross): verify shared library dependencies
 if len(p.properties.Srcs.GetOrDefault(ctx, nil)) > 0 {
  fileName := p.getStem(ctx) + flags.Toolchain.ExecutableSuffix()
  in := p.Prebuilt.SingleSourcePath(ctx)
  outputFile := android.PathForModuleOut(ctx, fileName)
  p.unstrippedOutputFile = in

  // Don't allow symlinks in srcs, as the later cp rules would only copy the symlink itself,
  // not the target of the symlink.
  verifyNotSymlinkStamp := android.PathForModuleOut(ctx, "verify_not_symlink.stamp")
  ctx.Build(pctx, android.BuildParams{
   Rule:   android.VerifyNotSymlinkRule,
   Output: verifyNotSymlinkStamp,
   Input:  in,
  })

  if ctx.Host() {
   // This copy of a prebuilt binary to the out directory could cause the binary
   // to not run anymore if it used shared libraries with a relative RPATH. However,
   // we have no usages of that in android other than some cuttlefish tools that
   // manually install their shared libraries as well, so it's not a problem.
   // If needed, in the future we could install the shared libraries alongside the
   // binary.
   ctx.Build(pctx, android.BuildParams{
    Rule:        android.CpExecutable,
    Description: "prebuilt",
    Output:      outputFile,
    Input:       in,
    Validation:  verifyNotSymlinkStamp,
   })

   p.toolPath = android.OptionalPathForPath(outputFile)
  } else {
   var validations android.Paths
   if p.shouldCheckElfFile(ctx) {
    validations = append(validations, p.checkElfFile(ctx, "", deps, in))
   }
   validations = append(validations, verifyNotSymlinkStamp)

   if p.stripper.NeedsStrip(ctx) {
    stripped := android.PathForModuleOut(ctx, "stripped", fileName)
    p.stripper.StripExecutableOrSharedLib(ctx, in, stripped, flagsToStripFlags(flags))
    in = stripped
   }

   // Copy binaries to a name matching the final installed name
   ctx.Build(pctx, android.BuildParams{
    Rule:        android.CpExecutable,
    Description: "prebuilt",
    Output:      outputFile,
    Input:       in,
    Validations: validations,
   })
  }

  return outputFile
 }

 return nil
}

func (p *prebuiltBinaryLinker) binary() bool {
 return true
}

// cc_prebuilt_binary installs a precompiled executable in srcs property in the
// device's directory, for both the host and device
func PrebuiltBinaryFactory() android.Module {
 module, _ := NewPrebuiltBinary(android.HostAndDeviceSupported)
 return module.Init()
}

func PrebuiltTestBinaryFactory() android.Module {
 module, binary := NewPrebuiltBinary(android.HostAndDeviceSupported)
 binary.baseInstaller = NewTestInstaller()
 return module.Init()
}

func NewPrebuiltBinary(hod android.HostOrDeviceSupported) (*Module, *binaryDecorator) {
 module, binary := newBinary(hod)
 module.compiler = nil

 prebuilt := &prebuiltBinaryLinker{
  binaryDecorator: binary,
 }
 module.linker = prebuilt
 module.installer = prebuilt

 module.AddProperties(&prebuilt.properties)

 android.InitConfigurablePrebuiltModule(module, &prebuilt.properties.Srcs)
 return module, binary
}

type Sanitized struct {
 None struct {
  Srcs []string `android:"path,arch_variant"`
 } `android:"arch_variant"`
 Address struct {
  Srcs []string `android:"path,arch_variant"`
 } `android:"arch_variant"`
 Hwaddress struct {
  Srcs []string `android:"path,arch_variant"`
 } `android:"arch_variant"`
}

func srcsForSanitizer(sanitize *sanitize, sanitized Sanitized) []string {
 if sanitize == nil {
  return nil
 }
 if sanitize.isSanitizerEnabled(Asan) && sanitized.Address.Srcs != nil {
  return sanitized.Address.Srcs
 }
 if sanitize.isSanitizerEnabled(Hwasan) && sanitized.Hwaddress.Srcs != nil {
  return sanitized.Hwaddress.Srcs
 }
 return sanitized.None.Srcs
}

func (p *prebuiltLinker) sourceModuleName() string {
 return proptools.String(p.properties.Source_module_name)
}

// shouldCheckElfFile returns true if the source ELF file for the current prebuilt module should be checked using
// checkElfFile.
func (p *prebuiltLinker) shouldCheckElfFile(ctx ModuleContext) bool {
 return BoolDefault(p.properties.Check_elf_files, true) &&
  !ctx.Host() && !ctx.DeviceConfig().BuildBrokenPrebuiltELFFiles() &&
  ctx.Config().GetBuildFlagBool("RELEASE_SOONG_CHECK_ELF_FILES")
}