Merge "Remove ijar"

CKATI := $(prebuilt_build_tools_bin)/ckati

DEPMOD := $(HOST_OUT_EXECUTABLES)/depmod

FILESLIST := $(SOONG_HOST_OUT_EXECUTABLES)/fileslist

IJAR := $(prebuilt_build_tools_bin)/ijar

MAKEPARALLEL := $(prebuilt_build_tools_bin)/makeparallel

SOONG_JAVAC_WRAPPER := $(SOONG_HOST_OUT_EXECUTABLES)/soong_javac_wrapper

SOONG_ZIP := $(SOONG_HOST_OUT_EXECUTABLES)/soong_zip

// Copyright 2015 The Android Open Source Project

//

// The rest of files in this directory comes from

// https://github.com/bazelbuild/bazel/tree/master/third_party/ijar

cc_binary_host {

    srcs: [

        "classfile.cc",

        "ijar.cc",

        "zip.cc",

    ],

    cflags: [

        "-Wall",

        "-Werror",

    ],

    host_ldlibs: ["-lz"],

    name: "ijar",

}

                                 Apache License

                           Version 2.0, January 2004

                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,

      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by

      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all

      other entities that control, are controlled by, or are under common

      control with that entity. For the purposes of this definition,

      "control" means (i) the power, direct or indirect, to cause the

      direction or management of such entity, whether by contract or

      otherwise, or (ii) ownership of fifty percent (50%) or more of the

      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity

      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,

      including but not limited to software source code, documentation

      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical

      transformation or translation of a Source form, including but

      not limited to compiled object code, generated documentation,

      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or

      Object form, made available under the License, as indicated by a

      copyright notice that is included in or attached to the work

      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object

      form, that is based on (or derived from) the Work and for which the

      editorial revisions, annotations, elaborations, or other modifications

      represent, as a whole, an original work of authorship. For the purposes

      of this License, Derivative Works shall not include works that remain

      separable from, or merely link (or bind by name) to the interfaces of,

      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including

      the original version of the Work and any modifications or additions

      to that Work or Derivative Works thereof, that is intentionally

      submitted to Licensor for inclusion in the Work by the copyright owner

      or by an individual or Legal Entity authorized to submit on behalf of

      the copyright owner. For the purposes of this definition, "submitted"

      means any form of electronic, verbal, or written communication sent

      to the Licensor or its representatives, including but not limited to

      communication on electronic mailing lists, source code control systems,

      and issue tracking systems that are managed by, or on behalf of, the

      Licensor for the purpose of discussing and improving the Work, but

      excluding communication that is conspicuously marked or otherwise

      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity

      on behalf of whom a Contribution has been received by Licensor and

      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of

      this License, each Contributor hereby grants to You a perpetual,

      worldwide, non-exclusive, no-charge, royalty-free, irrevocable

      copyright license to reproduce, prepare Derivative Works of,

      publicly display, publicly perform, sublicense, and distribute the

      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of

      this License, each Contributor hereby grants to You a perpetual,

      worldwide, non-exclusive, no-charge, royalty-free, irrevocable

      (except as stated in this section) patent license to make, have made,

      use, offer to sell, sell, import, and otherwise transfer the Work,

      where such license applies only to those patent claims licensable

      by such Contributor that are necessarily infringed by their

      Contribution(s) alone or by combination of their Contribution(s)

      with the Work to which such Contribution(s) was submitted. If You

      institute patent litigation against any entity (including a

      cross-claim or counterclaim in a lawsuit) alleging that the Work

      or a Contribution incorporated within the Work constitutes direct

      or contributory patent infringement, then any patent licenses

      granted to You under this License for that Work shall terminate

      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the

      Work or Derivative Works thereof in any medium, with or without

      modifications, and in Source or Object form, provided that You

      meet the following conditions:

      (a) You must give any other recipients of the Work or

          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices

          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works

          that You distribute, all copyright, patent, trademark, and

          attribution notices from the Source form of the Work,

          excluding those notices that do not pertain to any part of

          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its

          distribution, then any Derivative Works that You distribute must

          include a readable copy of the attribution notices contained

          within such NOTICE file, excluding those notices that do not

          pertain to any part of the Derivative Works, in at least one

          of the following places: within a NOTICE text file distributed

          as part of the Derivative Works; within the Source form or

          documentation, if provided along with the Derivative Works; or,

          within a display generated by the Derivative Works, if and

          wherever such third-party notices normally appear. The contents

          of the NOTICE file are for informational purposes only and

          do not modify the License. You may add Your own attribution

          notices within Derivative Works that You distribute, alongside

          or as an addendum to the NOTICE text from the Work, provided

          that such additional attribution notices cannot be construed

          as modifying the License.

      You may add Your own copyright statement to Your modifications and

      may provide additional or different license terms and conditions

      for use, reproduction, or distribution of Your modifications, or

      for any such Derivative Works as a whole, provided Your use,

      reproduction, and distribution of the Work otherwise complies with

      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,

      any Contribution intentionally submitted for inclusion in the Work

      by You to the Licensor shall be under the terms and conditions of

      this License, without any additional terms or conditions.

      Notwithstanding the above, nothing herein shall supersede or modify

      the terms of any separate license agreement you may have executed

      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade

      names, trademarks, service marks, or product names of the Licensor,

      except as required for reasonable and customary use in describing the

      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or

      agreed to in writing, Licensor provides the Work (and each

      Contributor provides its Contributions) on an "AS IS" BASIS,

      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

      implied, including, without limitation, any warranties or conditions

      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A

      PARTICULAR PURPOSE. You are solely responsible for determining the

      appropriateness of using or redistributing the Work and assume any

      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,

      whether in tort (including negligence), contract, or otherwise,

      unless required by applicable law (such as deliberate and grossly

      negligent acts) or agreed to in writing, shall any Contributor be

      liable to You for damages, including any direct, indirect, special,

      incidental, or consequential damages of any character arising as a

      result of this License or out of the use or inability to use the

      Work (including but not limited to damages for loss of goodwill,

      work stoppage, computer failure or malfunction, or any and all

      other commercial damages or losses), even if such Contributor

      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing

      the Work or Derivative Works thereof, You may choose to offer,

      and charge a fee for, acceptance of support, warranty, indemnity,

      or other liability obligations and/or rights consistent with this

      License. However, in accepting such obligations, You may act only

      on Your own behalf and on Your sole responsibility, not on behalf

      of any other Contributor, and only if You agree to indemnify,

      defend, and hold each Contributor harmless for any liability

      incurred by, or claims asserted against, such Contributor by reason

      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following

      boilerplate notice, with the fields enclosed by brackets "[]"

      replaced with your own identifying information. (Don't include

      the brackets!)  The text should be enclosed in the appropriate

      comment syntax for the file format. We also recommend that a

      file or class name and description of purpose be included on the

      same "printed page" as the copyright notice for easier

      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   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.

ijar: A tool for generating interface .jars from normal .jars

=============================================================

Alan Donovan, 26 May 2007.

Rationale:

  In order to improve the speed of compilation of Java programs in

  Bazel, the output of build steps is cached.

  This works very nicely for C++ compilation: a compilation unit

  includes a .cc source file and typically dozens of header files.

  Header files change relatively infrequently, so the need for a

  rebuild is usually driven by a change in the .cc file.  Even after

  syncing a slightly newer version of the tree and doing a rebuild,

  many hits in the cache are still observed.

  In Java, by contrast, a compilation unit involves a set of .java

  source files, plus a set of .jar files containing already-compiled

  JVM .class files.  Class files serve a dual purpose: from the JVM's

  perspective, they are containers of executable code, but from the

  compiler's perspective, they are interface definitions.  The problem

  here is that .jar files are very much more sensitive to change than

  C++ header files, so even a change that is insignificant to the

  compiler (such as the addition of a print statement to a method in a

  prerequisite class) will cause the jar to change, and any code that

  depends on this jar's interface will be recompiled unnecessarily.

  The purpose of ijar is to produce, from a .jar file, a much smaller,

  simpler .jar file containing only the parts that are significant for

  the purposes of compilation.  In other words, an interface .jar

  file.  By changing ones compilation dependencies to be the interface

  jar files, unnecessary recompilation is avoided when upstream

  changes don't affect the interface.

Details:

  ijar is a tool that reads a .jar file and emits a .jar file

  containing only the parts that are relevant to Java compilation.

  For example, it throws away:

  - Files whose name does not end in ".class".

  - All executable method code.

  - All private methods and fields.

  - All constants and attributes except the minimal set necessary to

    describe the class interface.

  - All debugging information

    (LineNumberTable, SourceFile, LocalVariableTables attributes).

  It also sets to zero the file modification times in the index of the

  .jar file.

Implementation:

  ijar is implemented in C++, and runs very quickly.  For example

  (when optimized) it takes only 530ms to process a 42MB

  .jar file containing 5878 classe, resulting in an interface .jar

  file of only 11.4MB in size.  For more usual .jar sizes of a few

  megabytes, a runtime of 50ms is typical.

  The implementation strategy is to mmap both the input jar and the

  newly-created _interface.jar, and to scan through the former and

  emit the latter in a single pass. There are a couple of locations

  where some kind of "backpatching" is required:

  - in the .zip file format, for each file, the size field precedes

    the data.  We emit a zero but note its location, generate and emit

    the stripped classfile, then poke the correct size into the

    location.

  - for JVM .class files, the header (including the constant table)

    precedes the body, but cannot be emitted before it because it's

    not until we emit the body that we know which constants are

    referenced and which are garbage.  So we emit the body into a

    temporary buffer, then emit the header to the output jar, followed

    by the contents of the temp buffer.

  Also note that the zip file format has unnecessary duplication of

  the index metadata: it has header+data for each file, then another

  set of (similar) headers at the end.  Rather than save the metadata

  explicitly in some datastructure, we just record the addresses of

  the already-emitted zip metadata entries in the output file, and

  then read from there as necessary.

Notes:

  This code has no dependency except on the STL and on zlib.

  Almost all of the getX/putX/ReadX/WriteX functions in the code

  advance their first argument pointer, which is passed by reference.

  It's tempting to discard package-private classes and class members.

  However, this would be incorrect because they are a necessary part

  of the package interface, as a Java package is often compiled in

  multiple stages.  For example: in Bazel, both java tests and java

  code inhabit the same Java package but are compiled separately.

Assumptions:

  We assume that jar files are uncompressed v1.0 zip files (created

  with 'jar c0f') with a zero general_purpose_bit_flag.

  We assume that javap/javac don't need the correct CRC checksums in

  the .jar file.

  We assume that it's better simply to abort in the face of unknown

  input than to risk leaving out something important from the output

  (although in the case of annotations, it should be safe to ignore

  ones we don't understand).

TODO:

  Maybe: ensure a canonical sort order is used for every list (jar

  entries, class members, attributes, etc.)  This isn't essential

  because we can assume the compiler is deterministic and the order in

  the source files changes little.  Also, it would require two passes. :(

  Maybe: delete dynamically-allocated memory.

  Add (a lot) more tests.  Include a test of idempotency.