Difference between revisions of "Pack200"

From Eclipsepedia

Jump to: navigation, search
(Jar Processor: Fixed the invalid mdash characters in the commandline args)
Line 28: Line 28:
 
!width="500"|Effect
 
!width="500"|Effect
 
|-
 
|-
|<b>&ndash;processAll</b>
+
|<b>-processAll</b>
 
|Process all jars.  If this is not specified only previously conditioned and marked jars are processed.
 
|Process all jars.  If this is not specified only previously conditioned and marked jars are processed.
 
|-
 
|-
|&ndash;repack
+
| -repack
 
|Normalize the jar by calling the pack200 tool with the -repack option.  The -processAll option must be specified in order to normalize a jar for the first time.
 
|Normalize the jar by calling the pack200 tool with the -repack option.  The -processAll option must be specified in order to normalize a jar for the first time.
 
|-
 
|-
|&ndash;pack
+
| -pack
 
|Pack the jar using the pack200 tool
 
|Pack the jar using the pack200 tool
 
|-
 
|-
|&ndash;sign <command>
+
| -sign <command>
 
|Sign the jar using the provided command.  The sign command will be provided the name of the jar to sign as its first argument.
 
|Sign the jar using the provided command.  The sign command will be provided the name of the jar to sign as its first argument.
 
|-
 
|-
|&ndash;unpack
+
| -unpack
 
|Unpack a pack.gz file into a jar using the unpack200 tool.
 
|Unpack a pack.gz file into a jar using the unpack200 tool.
 
|-
 
|-
|&ndash;outputDir <directory>
+
| -outputDir <directory>
 
|The directory in which to place the results.
 
|The directory in which to place the results.
 
|-
 
|-
|&ndash;verbose
+
| -verbose
 
|Use verbose mode
 
|Use verbose mode
 
|}
 
|}

Revision as of 06:24, 29 September 2009

Contents

Overview

Pack200 is a compression technology included in Java 1.5.0. It was designed for compressing jars and works most efficiently on Java class files. Using Pack200 compression can reduce the size of a jar by about 60%. By packing the jars placed on an update site and enabling update to unpack those jars after download, the amount of data downloaded during an update can be greatly reduced.


Compression and Signing

Pack200 is not a lossless compression. Packing and unpacking will produce a jar that is semantically the same as the original, but classfile structures will be rearranged; the resulting jar will not be identical to the original. However, this reordering is idempotent so a second pack-unpack will not further change the jar.

Pack200 reduces the size of a JAR file by:

  1. Merging and sorting the constant-pool data in the class files and co-locating them in the archive.
  2. Removing redundant class attributes.
  3. Storing internal data structures.
  4. Using delta and variable length encoding.
  5. Choosing optimum coding types for secondary compression.

Signing a jar hashes the contents and stores the hash codes in the manifest. Since packing and unpacking a jar will modify the contents, the jar must be normalized prior to signing. Normalizing the jar will also be refered to as repacking or conditioning the jar.

Jar Processor

The Jar Processor is a tool provided by the org.eclipse.update.core bundle that will recursively run the pack200, signing, and unpack200 tools on a jar and its nested jars. The jar processor can be used during a build to repack, sign and pack jars for an update site. It is also used by eclipse itself to unpack compressed jars downloaded from an update site.

The jar processor can be exported into a self contained jar using the org.eclipse.update.internal.jarprocessor/jarprocessor.jardesc jar description file. The jar processor can also be accessed through the org.eclipse.update.core.siteOptimizer application. The jar processor requires a 1.5 jre to perform the pack and unpack.

By default the Jar Processor will only process jars that have been previously marked as conditioned. This allows the Jar Processor to be run on an entire update site and only process those jars that have been previously conditioned. Marking a jar is done by the -repack option by placing a META-INF/eclipse.inf file in the jar. Repacking must be done using the -processAll option since the jars won't be marked before repacking.

java -jar /eclipse/startup.jar -application org.eclipse.update.core.siteOptimizer -jarProcessor [options] [input] 

The jarprocessor understands the following command-line options:

Option Effect
-processAll Process all jars. If this is not specified only previously conditioned and marked jars are processed.
-repack Normalize the jar by calling the pack200 tool with the -repack option. The -processAll option must be specified in order to normalize a jar for the first time.
-pack Pack the jar using the pack200 tool
-sign <command> Sign the jar using the provided command. The sign command will be provided the name of the jar to sign as its first argument.
-unpack Unpack a pack.gz file into a jar using the unpack200 tool.
-outputDir <directory> The directory in which to place the results.
-verbose Use verbose mode

The repack, sign and pack options can be specified together. When specifying all 3, the input jar will first be normalized, then signed, then packed. The output will be the signed jar and a packed jar.pack.gz file.


Options

In addition to command line arguments, options can also be supplied to JarProcessor on a per-jar basis using configurations files nested within the jars being processed. These options give complete control of what jars are signed and packed within a recursive tree of zips/jars. See the options page for details on these options available for the jar processor.

Input

The jar processor takes as input either a .zip file, a .jar (or .pack.gz) file, or a directory.

  • If the input is a zip file, then each contained .jar (or .pack.gz if unpacking) will be processed. A new .zip file will be created in the output directory containing the results.
  • If the input is a single .jar (or .pack.gz file) then that file is processed.
  • If the input is a directory then all .jar (or .pack.gz files) in that directory, and its subdirectories, will be processed.



Examples

java -jar /eclipse/startup.jar -application org.eclipse.update.core.siteOptimizer -jarProcessor
 -processAll -repack -sign signing-script.sh -outputDir ./out eclipse-SDK.zip

This will run the jar processor using the siteOptimizer application. For each jar file in eclipse-SDK.zip, the jar processor will normalize the jar by repacking it, mark the jar as conditioned by placing a META-INF/eclipse.inf file in the jar, then sign it by executing signing-script.sh <jar>. A zip ./out/eclipse-SDK.zip will be created containing the repacked signed jars. Any non-jar file in the input eclipse-SDK.zip will be copied over to the ./out/eclipse-SDK.zip as is.

java -jar /eclipse/startup.jar -application org.eclipse.update.core.siteOptimizer -jarProcessor
 -processAll -repack -sign signing-script.sh -pack -outputDir ./out eclipse-SDK.zip

This command will do the same as the first example, but will also pack the signed jars. The output ./out/eclipse-SDK.zip file will contain both the signed jars and the .jar.pack.gz versions.

java -jar /eclipse/startup.jar -application org.eclipse.update.core.siteOptimizer -jarProcessor
 -pack myJar.jar

java -jar /eclipse/startup.jar -application org.eclipse.update.core.siteOptimizer -jarProcessor
 -unpack myJar.jar.pack.gz

These two commands are the inverses of each other. The first will pack myJar.jar and produce a myJar.jar.pack.gz if the original myJar.jar was marked as conditioned. Since no outputDir is specified, the .pack.gz file will be created in the current directory. If myJar.jar contained a nested jar, then that nested jar will be packed first and the resulting myJar.jar.pack.gz would contain a nested nested.jar.pack.gz. The second command will unpack the myJar.jar.pack.gz file and produce a myJar.jar. The nested nested.jar.pack.gz will also be unpacked. Again, because no outputDir is specified, the output will be in the current directory, overwriting the original myJar.jar.


Pack200 Executable location

By default, the jar processor will look for the pack200 and unpack200 executables first in the ${java.home}/bin directory and then on the system search path. However, the location of these tools can also be specified using the java system property org.eclipse.update.jarprocessor.pack200. The value is expected to be the directory containing the pack200 and unpack200 executables or one of the following special values:

  • "@jre" - find unpack200 in ${java.home}/bin
  • "@path" - find unpack200 on the search path
  • "@none" - pack200 not supported, download normal jars from update sites.


Related Pages

External Links

Pack200 and Compression
JAR Packing tool
JAR Unpacking tool
JAR Signing and Verification tool