compare.sh revision 1008:9786ef8ca58c
1#!/bin/bash
2#
3# Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
4# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5#
6# This code is free software; you can redistribute it and/or modify it
7# under the terms of the GNU General Public License version 2 only, as
8# published by the Free Software Foundation.
9#
10# This code is distributed in the hope that it will be useful, but WITHOUT
11# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
13# version 2 for more details (a copy is included in the LICENSE file that
14# accompanied this code).
15#
16# You should have received a copy of the GNU General Public License version
17# 2 along with this work; if not, write to the Free Software Foundation,
18# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19#
20# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21# or visit www.oracle.com if you need additional information or have any
22# questions.
23#
24
25# This script is processed by configure before it's usable. It is run from 
26# the root of the build directory.
27
28
29##########################################################################################
30
31# Check that we are run via the wrapper generated by configure
32if [ -z "$SRC_ROOT" ]; then
33    echo "Error: You must run this script using build/[conf]/compare.sh"
34    exit 1
35fi
36
37if [ "$OPENJDK_TARGET_OS" = "macosx" ]; then
38    FULLDUMP_CMD="$OTOOL -v -V -h -X -t -d"
39    LDD_CMD="$OTOOL -L"
40    DIS_CMD="$OTOOL -v -t"
41    STAT_PRINT_SIZE="-f %z"
42elif [ "$OPENJDK_TARGET_OS" = "windows" ]; then
43    FULLDUMP_CMD="$DUMPBIN -all"
44    LDD_CMD="$DUMPBIN -dependants | $GREP .dll"
45    DIS_CMD="$DUMPBIN -disasm:nobytes"
46    STAT_PRINT_SIZE="-c %s"
47else
48    FULLDUMP_CMD="$READELF -a"
49    LDD_CMD="$LDD"
50    DIS_CMD="$OBJDUMP -d"
51    STAT_PRINT_SIZE="-c %s"
52fi
53
54UNARCHIVE="$UNZIP -q"
55
56COMPARE_EXCEPTIONS_INCLUDE="$SRC_ROOT/common/bin/compare_exceptions.sh.incl"
57if [ ! -e "$COMPARE_EXCEPTIONS_INCLUDE" ]; then
58    echo "Error: Cannot locate the exceptions file, it should have been here: $COMPARE_EXCEPTIONS_INCLUDE"
59    exit 1
60fi
61# Include exception definitions
62. "$COMPARE_EXCEPTIONS_INCLUDE"
63
64##########################################################################################
65# Compare text files and ignore specific differences:
66#
67#  * Timestamps in Java sources generated by idl2java
68#  * Sorting order and cleanup style in .properties files
69
70diff_text() {
71    OTHER_FILE=$1
72    THIS_FILE=$2
73
74    SUFFIX="${THIS_FILE##*.}"
75
76    TMP=1
77
78    if [[ "$THIS_FILE" = *"META-INF/MANIFEST.MF" ]]; then
79        TMP=$(LC_ALL=C $DIFF $OTHER_FILE $THIS_FILE | \
80            $GREP '^[<>]' | \
81            $SED -e '/[<>] Ant-Version: Apache Ant .*/d' \
82	         -e '/[<>] Created-By: .* (Oracle Corporation).*/d')
83    fi
84    if test "x$SUFFIX" = "xjava"; then
85        TMP=$(LC_ALL=C $DIFF $OTHER_FILE $THIS_FILE | \
86            $GREP '^[<>]' | \
87            $SED -e '/[<>] \* from.*\.idl/d' \
88                 -e '/[<>] \*.*[0-9]\{4\}_[0-9]\{2\}_[0-9]\{2\}_[0-9]\{2\}_[0-9]\{2\}-b[0-9]\{2\}.*/d' \
89                 -e '/[<>] \*.*[0-9]\{4\} [0-9][0-9]*:[0-9]\{2\}:[0-9]\{2\}.*/d' \
90                 -e '/\/\/ Generated from input file.*/d' \
91                 -e '/\/\/ This file was generated AUTOMATICALLY from a template file.*/d' \
92                 -e '/\/\/ java GenerateCharacter.*/d')
93    fi
94    # Ignore date strings in class files.
95    # On Macosx the system sources for generated java classes produce different output on 
96    # consequtive invokations seemingly randomly.
97    # For example a method parameter randomly named "thePoint" or "aPoint". Ignore this.
98    if test "x$SUFFIX" = "xclass"; then
99        # To improve performance when large diffs are found, do a rough filtering of classes
100        # elibeble for these exceptions
101        if $GREP -R -e '[0-9]\{4\}_[0-9]\{2\}_[0-9]\{2\}_[0-9]\{2\}_[0-9]\{2\}-b[0-9]\{2\}' \
102	        -e '[0-9]\{2\}/[0-9]\{2\}/[0-9]\{4\}' \
103	        -e thePoint -e aPoint -e setItemsPtr ${THIS_FILE} > /dev/null; then
104            $JAVAP -c -constants -l -p ${OTHER_FILE} >  ${OTHER_FILE}.javap
105            $JAVAP -c -constants -l -p ${THIS_FILE} > ${THIS_FILE}.javap
106            TMP=$($DIFF ${OTHER_FILE}.javap ${THIS_FILE}.javap | \
107                $GREP '^[<>]' | \
108                $SED -e '/[<>].*[0-9]\{4\}_[0-9]\{2\}_[0-9]\{2\}_[0-9]\{2\}_[0-9]\{2\}-b[0-9]\{2\}.*/d' \
109		     -e '/[0-9]\{2\}\/[0-9]\{2\}\/[0-9]\{4\}/d' \
110 	             -e '/[<>].*Point   Lcom\/apple\/jobjc\/foundation\/NSPoint;/d' \
111	             -e '/[<>].*public com\.apple\.jobjc\.Pointer<com\.apple\.jobjc\..*itemsPtr();/d' \
112	             -e '/[<>].*public void setItemsPtr(com\.apple\.jobjc\.Pointer<com\.apple\.jobjc\..*);/d')
113        fi
114    fi
115    if test "x$SUFFIX" = "xproperties"; then
116        # Run through nawk to add possibly missing newline at end of file.
117        $CAT $OTHER_FILE | $NAWK '{ print }' | LC_ALL=C $SORT > $OTHER_FILE.cleaned
118# Disable this exception since we aren't changing the properties cleaning method yet.
119#        $CAT $OTHER_FILE | $SED -e 's/\([^\\]\):/\1\\:/g' -e  's/\([^\\]\)=/\1\\=/g' -e 's/#.*/#/g' \
120#            | $SED -f "$SRC_ROOT/common/makefiles/support/unicode2x.sed" \
121#  	    | $SED -e '/^#/d' -e '/^$/d' \
122#            -e :a -e '/\\$/N; s/\\\n//; ta' \
123#  	    -e 's/^[ \t]*//;s/[ \t]*$//' \
124#	    -e 's/\\=/=/' | LC_ALL=C $SORT > $OTHER_FILE.cleaned
125        TMP=$(LC_ALL=C $DIFF $OTHER_FILE.cleaned $THIS_FILE)
126    fi
127    if test -n "$TMP"; then
128        echo Files $OTHER_FILE and $THIS_FILE differ
129        return 1
130    fi
131
132    return 0
133}
134
135##########################################################################################
136# Compare directory structure
137
138compare_dirs() {
139    THIS_DIR=$1
140    OTHER_DIR=$2
141    WORK_DIR=$3
142
143    mkdir -p $WORK_DIR
144
145    (cd $OTHER_DIR && $FIND . -type d | $SORT > $WORK_DIR/dirs_other)
146    (cd $THIS_DIR && $FIND . -type d | $SORT > $WORK_DIR/dirs_this)
147
148    $DIFF $WORK_DIR/dirs_other $WORK_DIR/dirs_other > $WORK_DIR/dirs_diff
149    
150    echo -n Directory structure...
151    if [ -s $WORK_DIR/dirs_diff ]; then
152        echo Differences found.
153        REGRESSIONS=true
154        # Differences in directories found.
155        ONLY_OTHER=$($GREP '<' $WORK_DIR/dirs_diff)
156        if [ "$ONLY_OTHER" ]; then
157            echo Only in $OTHER
158            $GREP '<' $WORK_DIR/dirs_diff | $SED 's|< ./|    |g'
159        fi
160        ONLY_THIS=$($GREP '>' $WORK_DIR/dirs_diff)
161        if [ "$ONLY_THIS" ]; then
162            echo Only in $THIS
163            $GREP '>' $WORK_DIR/dirs_diff | $SED 's|> ./|    |g'
164        fi
165    else
166        echo Identical!
167    fi
168}
169
170
171##########################################################################################
172# Compare file structure
173
174compare_files() {
175    THIS_DIR=$1
176    OTHER_DIR=$2
177    WORK_DIR=$3
178
179    $MKDIR -p $WORK_DIR
180
181    (cd $OTHER_DIR && $FIND . ! -type d | $SORT > $WORK_DIR/files_other)
182    (cd $THIS_DIR && $FIND . ! -type d | $SORT > $WORK_DIR/files_this)
183    
184    $DIFF $WORK_DIR/files_other $WORK_DIR/files_this > $WORK_DIR/files_diff
185
186    echo -n File names...
187    if [ -s $WORK_DIR/files_diff ]; then
188        echo Differences found.
189        REGRESSIONS=true
190        # Differences in files found.
191        ONLY_OTHER=$($GREP '<' $WORK_DIR/files_diff)
192        if [ "$ONLY_OTHER" ]; then
193            echo Only in $OTHER
194            $GREP '<' $WORK_DIR/files_diff | $SED 's|< ./|    |g'
195        fi
196        ONLY_THIS=$($GREP '>' $WORK_DIR/files_diff)
197        if [ "$ONLY_THIS" ]; then
198            echo Only in $THIS
199            $GREP '>' $WORK_DIR/files_diff | $SED 's|> ./|    |g'
200        fi
201    else
202        echo Identical!
203    fi
204}
205
206
207##########################################################################################
208# Compare permissions
209
210compare_permissions() {
211    THIS_DIR=$1
212    OTHER_DIR=$2
213    WORK_DIR=$3
214
215    mkdir -p $WORK_DIR
216
217    echo -n Permissions...
218    found=""
219    for f in `cd $OTHER_DIR && $FIND . -type f`
220    do
221        if [ ! -f ${OTHER_DIR}/$f ]; then continue; fi
222        if [ ! -f ${THIS_DIR}/$f ]; then continue; fi
223        OP=`ls -l ${OTHER_DIR}/$f | awk '{printf("%.10s\n", $1);}'`
224        TP=`ls -l ${THIS_DIR}/$f | awk '{printf("%.10s\n", $1);}'`
225        if [ "$OP" != "$TP" ]
226        then
227	    if [ -z "$found" ]; then echo ; found="yes"; fi
228	    $PRINTF "\told: ${OP} new: ${TP}\t$f\n"
229        fi
230    done
231    if [ -z "$found" ]; then 
232        echo "Identical!"
233    else
234        REGRESSIONS=true
235    fi
236}
237
238##########################################################################################
239# Compare file command output
240
241compare_file_types() {
242    THIS_DIR=$1
243    OTHER_DIR=$2
244    WORK_DIR=$3
245
246    $MKDIR -p $WORK_DIR
247
248    echo -n File types...
249    found=""
250    for f in `cd $OTHER_DIR && $FIND . ! -type d`
251    do
252        if [ ! -f ${OTHER_DIR}/$f ]; then continue; fi
253        if [ ! -f ${THIS_DIR}/$f ]; then continue; fi
254        OF=`cd ${OTHER_DIR} && $FILE -h $f`
255        TF=`cd ${THIS_DIR} && $FILE -h $f`
256        if [ "$f" = "./src.zip" ] || [[ "$f" = *"/Home/src.zip" ]] || [[ "$f" = *"/lib/JObjC.jar" ]]
257        then
258	    if [ "`echo $OF | $GREP -ic zip`" -gt 0 -a "`echo $TF | $GREP -ic zip`" -gt 0 ]
259	    then
260	        # the way we produces zip-files make it so that directories are stored in old file
261	        # but not in new (only files with full-path)
262	        # this makes file-5.09 report them as different
263	        continue;
264	    fi
265        fi
266        
267        if [ "$OF" != "$TF" ]
268        then
269	    if [ -z "$found" ]; then echo ; found="yes"; fi
270	    $PRINTF "\tother: ${OF}\n\tthis : ${TF}\n"
271        fi
272    done
273    if [ -z "$found" ]; then 
274        echo "Identical!"
275    else
276        REGRESSIONS=true
277    fi
278}
279
280##########################################################################################
281# Compare the rest of the files
282
283compare_general_files() {
284    THIS_DIR=$1
285    OTHER_DIR=$2
286    WORK_DIR=$3
287    
288    GENERAL_FILES=$(cd $THIS_DIR && $FIND . -type f ! -name "*.so" ! -name "*.jar" ! -name "*.zip" \
289        ! -name "*.debuginfo" ! -name "*.dylib" ! -name "jexec" \
290        ! -name "ct.sym" ! -name "*.diz" ! -name "*.dll" \
291        ! -name "*.pdb" ! -name "*.exp" ! -name "*.ilk" \
292        ! -name "*.lib" ! -name "*.war" ! -name "JavaControlPanel" \
293        | $GREP -v "./bin/"  | $SORT | $FILTER)
294
295    echo General files...
296    for f in $GENERAL_FILES
297    do
298        if [ -e $OTHER_DIR/$f ]; then
299            SUFFIX="${f##*.}"
300            if [ "$(basename $f)" = "release" ]; then
301                # Ignore differences in change numbers in release file.
302                OTHER_FILE=$WORK_DIR/$f.other
303                THIS_FILE=$WORK_DIR/$f.this
304                $MKDIR -p $(dirname $OTHER_FILE)
305                $MKDIR -p $(dirname $THIS_FILE)
306                $CAT $OTHER_DIR/$f | $SED 's/\:[0-9a-f]\{12,12\}/:CHANGE/g' > $OTHER_FILE
307                $CAT $THIS_DIR/$f  | $SED 's/\:[0-9a-f]\{12,12\}/:CHANGE/g' > $THIS_FILE
308            elif [ "x$SUFFIX" = "xhtml" ]; then
309                # Ignore time stamps in docs files
310                OTHER_FILE=$WORK_DIR/$f.other
311                THIS_FILE=$WORK_DIR/$f.this
312                $MKDIR -p $(dirname $OTHER_FILE)
313                $MKDIR -p $(dirname $THIS_FILE)
314                #Note that | doesn't work on mac sed.
315                $CAT $OTHER_DIR/$f | $SED -e 's/\(-- Generated by javadoc \).*\( --\)/\1(removed)\2/' \
316                                          -e 's/\(<meta name="date" content="\).*\(">\)/\1(removed)\2/' \
317                                          -e 's/[A-Z][a-z]*, [A-Z][a-z]* [0-9][0-9]*, [12][0-9]* [0-9][0-9:]* [AMP]\{2,2\} [A-Z][A-Z]*/(removed)/' \
318                                          -e 's/[A-Z][a-z]* [A-Z][a-z]* [0-9][0-9] [0-9][0-9:]* [A-Z][A-Z]* [12][0-9]*/(removed)/' \
319                                          -e 's/^\( from \).*\(\.idl\)$/\1(removed)\2/' \
320                    > $OTHER_FILE
321                $CAT $THIS_DIR/$f  | $SED -e 's/\(-- Generated by javadoc \).*\( --\)/\1(removed)\2/' \
322                                          -e 's/\(<meta name="date" content="\).*\(">\)/\1(removed)\2/' \
323                                          -e 's/[A-Z][a-z]*, [A-Z][a-z]* [0-9][0-9]*, [12][0-9]* [0-9][0-9:]* [AMP]\{2,2\} [A-Z][A-Z]*/(removed)/' \
324                                          -e 's/[A-Z][a-z]* [A-Z][a-z]* [0-9][0-9] [0-9][0-9:]* [A-Z][A-Z]* [12][0-9]*/(removed)/' \
325                                          -e 's/^\( from \).*\(\.idl\)$/\1(removed)\2/' \
326                    > $THIS_FILE
327            else
328                OTHER_FILE=$OTHER_DIR/$f
329                THIS_FILE=$THIS_DIR/$f
330            fi
331            DIFF_OUT=$($DIFF $OTHER_FILE $THIS_FILE 2>&1)
332            if [ -n "$DIFF_OUT" ]; then
333                echo $f
334                REGRESSIONS=true
335                if [ "$SHOW_DIFFS" = "true" ]; then
336                    echo "$DIFF_OUT"
337                fi
338            fi
339        fi
340    done
341
342
343}
344
345##########################################################################################
346# Compare zip file
347
348compare_zip_file() {
349    THIS_DIR=$1
350    OTHER_DIR=$2
351    WORK_DIR=$3
352    ZIP_FILE=$4
353    # Optionally provide different name for other zipfile
354    OTHER_ZIP_FILE=$5
355
356    THIS_ZIP=$THIS_DIR/$ZIP_FILE
357    if [ -n "$OTHER_ZIP_FILE" ]; then
358        OTHER_ZIP=$OTHER_DIR/$OTHER_ZIP_FILE
359    else
360        OTHER_ZIP=$OTHER_DIR/$ZIP_FILE
361    fi
362
363    THIS_SUFFIX="${THIS_ZIP##*.}"
364    OTHER_SUFFIX="${OTHER_ZIP##*.}"
365    if [ "$THIS_SUFFIX" != "$OTHER_SUFFIX" ]; then
366        echo The files do not have the same suffix type!
367        return 2
368    fi
369
370    TYPE="$THIS_SUFFIX"
371
372    if $CMP $OTHER_ZIP $THIS_ZIP > /dev/null
373    then
374        return 0
375    fi
376    # Not quite identical, the might still contain the same data.
377    # Unpack the jar/zip files in temp dirs
378    
379    THIS_UNZIPDIR=$WORK_DIR/$ZIP_FILE.this
380    OTHER_UNZIPDIR=$WORK_DIR/$ZIP_FILE.other
381    $RM -rf $THIS_UNZIPDIR $OTHER_UNZIPDIR
382    $MKDIR -p $THIS_UNZIPDIR
383    $MKDIR -p $OTHER_UNZIPDIR
384    (cd $THIS_UNZIPDIR && $UNARCHIVE $THIS_ZIP)
385    (cd $OTHER_UNZIPDIR && $UNARCHIVE $OTHER_ZIP)
386
387    # Find all archives inside and unzip them as well to compare the contents rather than
388    # the archives. pie.jar.pack.gz i app3.war is corrupt, skip it.
389    EXCEPTIONS="pie.jar.pack.gz"
390    for pack in $($FIND $THIS_UNZIPDIR \( -name "*.pack" -o -name "*.pack.gz" \) -a ! -name pie.jar.pack.gz); do
391        ($UNPACK200 $pack $pack.jar)
392        # Filter out the unzipped archives from the diff below.
393        EXCEPTIONS="$EXCEPTIONS $pack $pack.jar"
394    done
395    for pack in $($FIND $OTHER_UNZIPDIR \( -name "*.pack" -o -name "*.pack.gz" \) -a ! -name pie.jar.pack.gz); do
396        ($UNPACK200 $pack $pack.jar)
397        EXCEPTIONS="$EXCEPTIONS $pack $pack.jar"
398    done
399    for zip in $($FIND $THIS_UNZIPDIR -name "*.jar" -o -name "*.zip"); do
400        $MKDIR $zip.unzip
401        (cd $zip.unzip && $UNARCHIVE $zip)
402        EXCEPTIONS="$EXCEPTIONS $zip"
403    done
404    for zip in $($FIND $OTHER_UNZIPDIR -name "*.jar" -o -name "*.zip"); do
405        $MKDIR $zip.unzip
406        (cd $zip.unzip && $UNARCHIVE $zip)
407        EXCEPTIONS="$EXCEPTIONS $zip"
408    done
409
410    CONTENTS_DIFF_FILE=$WORK_DIR/$ZIP_FILE.diff
411    # On solaris, there is no -q option.
412    if [ "$OPENJDK_TARGET_OS" = "solaris" ]; then
413        LC_ALL=C $DIFF -r $OTHER_UNZIPDIR $THIS_UNZIPDIR \
414            | $GREP -v -e "^<" -e "^>" -e "^Common subdirectories:" \
415            > $CONTENTS_DIFF_FILE
416    else
417        LC_ALL=C $DIFF -rq $OTHER_UNZIPDIR $THIS_UNZIPDIR > $CONTENTS_DIFF_FILE
418    fi
419
420    ONLY_OTHER=$($GREP "^Only in $OTHER_UNZIPDIR" $CONTENTS_DIFF_FILE)
421    ONLY_THIS=$($GREP "^Only in $THIS_UNZIPDIR" $CONTENTS_DIFF_FILE)
422
423    return_value=0
424
425    if [ -n "$ONLY_OTHER" ]; then
426        echo "        Only OTHER $ZIP_FILE contains:"
427        echo "$ONLY_OTHER" | sed "s|Only in $OTHER_UNZIPDIR|            |"g | sed 's|: |/|g'
428        return_value=1
429    fi
430
431    if [ -n "$ONLY_THIS" ]; then
432        echo "        Only THIS $ZIP_FILE contains:"
433        echo "$ONLY_THIS" | sed "s|Only in $THIS_UNZIPDIR|            |"g | sed 's|: |/|g'
434        return_value=1
435    fi
436
437    if [ "$OPENJDK_TARGET_OS" = "solaris" ]; then
438        DIFFING_FILES=$($GREP -e "differ$" -e "^diff " $CONTENTS_DIFF_FILE \
439            | $CUT -f 3 -d ' ' | $SED "s|$OTHER_UNZIPDIR/||g")
440    else
441        DIFFING_FILES=$($GREP -e "differ$" $CONTENTS_DIFF_FILE \
442            | $CUT -f 2 -d ' ' | $SED "s|$OTHER_UNZIPDIR/||g")
443    fi
444
445    $RM -f $WORK_DIR/$ZIP_FILE.diffs
446    for file in $DIFFING_FILES; do
447	if [[ "$ACCEPTED_JARZIP_CONTENTS $EXCEPTIONS" != *"$file"* ]]; then
448            diff_text $OTHER_UNZIPDIR/$file $THIS_UNZIPDIR/$file >> $WORK_DIR/$ZIP_FILE.diffs
449	fi
450    done
451
452    if [ -s "$WORK_DIR/$ZIP_FILE.diffs" ]; then
453        return_value=1
454        echo "        Differing files in $ZIP_FILE"
455        $CAT $WORK_DIR/$ZIP_FILE.diffs | $GREP differ | cut -f 2 -d ' ' | \
456            $SED "s|$OTHER_UNZIPDIR|            |g" > $WORK_DIR/$ZIP_FILE.difflist
457        $CAT $WORK_DIR/$ZIP_FILE.difflist
458
459        if [ -n "$SHOW_DIFFS" ]; then
460            for i in $(cat $WORK_DIR/$ZIP_FILE.difflist) ; do
461                if [ -f "${OTHER_UNZIPDIR}/$i.javap" ]; then
462                    LC_ALL=C $DIFF ${OTHER_UNZIPDIR}/$i.javap ${THIS_UNZIPDIR}/$i.javap
463                elif [ -f "${OTHER_UNZIPDIR}/$i.cleaned" ]; then
464                    LC_ALL=C $DIFF ${OTHER_UNZIPDIR}/$i.cleaned ${THIS_UNZIPDIR}/$i
465                else
466                    LC_ALL=C $DIFF ${OTHER_UNZIPDIR}/$i ${THIS_UNZIPDIR}/$i
467                fi
468            done
469        fi
470    fi
471
472    return $return_value
473}
474
475
476##########################################################################################
477# Compare all zip files
478
479compare_all_zip_files() {
480    THIS_DIR=$1
481    OTHER_DIR=$2
482    WORK_DIR=$3
483
484    ZIPS=$(cd $THIS_DIR && $FIND . -type f -name "*.zip" | $SORT | $FILTER )
485
486    if [ -n "$ZIPS" ]; then
487        echo Zip files...
488
489        return_value=0
490        for f in $ZIPS; do
491            if [ -f "$OTHER_DIR/$f" ]; then
492                compare_zip_file $THIS_DIR $OTHER_DIR $WORK_DIR $f
493                if [ "$?" != "0" ]; then
494                    return_value=1
495                    REGRESSIONS=true
496                fi
497            fi
498        done
499    fi
500
501    return $return_value
502}
503
504##########################################################################################
505# Compare all jar files
506
507compare_all_jar_files() {
508    THIS_DIR=$1
509    OTHER_DIR=$2
510    WORK_DIR=$3
511
512    # TODO filter?
513    ZIPS=$(cd $THIS_DIR && $FIND . -type f -name "*.jar" -o -name "*.war" | $SORT | $FILTER)
514
515    if [ -n "$ZIPS" ]; then
516        echo Jar files...
517
518        return_value=0
519        for f in $ZIPS; do
520            if [ -f "$OTHER_DIR/$f" ]; then
521                compare_zip_file $THIS_DIR $OTHER_DIR $WORK_DIR $f
522                if [ "$?" != "0" ]; then
523                    return_value=1
524                    REGRESSIONS=true
525                fi
526            fi
527        done
528    fi
529
530    return $return_value
531}
532
533##########################################################################################
534# Compare binary (executable/library) file
535
536compare_bin_file() {
537    THIS_DIR=$1
538    OTHER_DIR=$2
539    WORK_DIR=$3
540    BIN_FILE=$4
541
542    THIS_FILE=$THIS_DIR/$BIN_FILE
543    OTHER_FILE=$OTHER_DIR/$BIN_FILE
544    NAME=$(basename $BIN_FILE)
545    WORK_FILE_BASE=$WORK_DIR/$BIN_FILE
546    FILE_WORK_DIR=$(dirname $WORK_FILE_BASE)
547
548    $MKDIR -p $FILE_WORK_DIR
549
550    ORIG_THIS_FILE="$THIS_FILE"
551    ORIG_OTHER_FILE="$OTHER_FILE"
552
553    if [[ "$STRIP_BEFORE_COMPARE" = *"$BIN_FILE"* ]]; then
554        THIS_STRIPPED_FILE=$FILE_WORK_DIR/this/$NAME
555        OTHER_STRIPPED_FILE=$FILE_WORK_DIR/other/$NAME
556        $MKDIR -p $FILE_WORK_DIR/this $FILE_WORK_DIR/other
557        $CP $THIS_FILE $THIS_STRIPPED_FILE
558        $CP $OTHER_FILE $OTHER_STRIPPED_FILE
559        $STRIP $THIS_STRIPPED_FILE
560        $STRIP $OTHER_STRIPPED_FILE
561        THIS_FILE="$THIS_STRIPPED_FILE"
562        OTHER_FILE="$OTHER_STRIPPED_FILE"
563    fi
564
565    if [ "$OPENJDK_TARGET_OS" = "windows" ]; then
566	unset _NT_SYMBOL_PATH
567	# On windows we need to unzip the debug symbols, if present
568	OTHER_FILE_BASE=${OTHER_FILE/.dll/}
569	OTHER_FILE_BASE=${OTHER_FILE_BASE/.exe/}
570	DIZ_NAME=$(basename $OTHER_FILE_BASE).diz
571        # java.exe and java.dll diz files will have the same name. Have to
572	# make sure java.exe gets the right one. This is only needed for 
573	# OTHER since in the new build, all pdb files are left around.
574	if [ "$NAME" = "java.exe" ] && [ -f "$OTHER/tmp/java/java/obj64/java.diz" ]; then
575	    OTHER_DIZ_FILE="$OTHER/tmp/java/java/obj64/java.diz"
576	elif [ -f "${OTHER_FILE_BASE}.diz" ]; then
577	    OTHER_DIZ_FILE=${OTHER_FILE_BASE}.diz
578	else
579            # Some files, jli.dll, appears twice in the image but only one of
580	    # thme has a diz file next to it.
581	    OTHER_DIZ_FILE="$($FIND $OTHER_DIR -name $DIZ_NAME | $SED 1q)"
582	    if [ ! -f "$OTHER_DIZ_FILE" ]; then
583		# As a last resort, look for diz file in the whole build output
584		# dir.
585		OTHER_DIZ_FILE="$($FIND $OTHER -name $DIZ_NAME | $SED 1q)"
586	    fi
587	fi
588	if [ -n "$OTHER_DIZ_FILE" ]; then
589	    $MKDIR -p $FILE_WORK_DIR/other
590	    (cd $FILE_WORK_DIR/other ; $UNARCHIVE -o $OTHER_DIZ_FILE)
591	    export _NT_SYMBOL_PATH="$FILE_WORK_DIR/other"
592	fi
593	THIS_FILE_BASE=${THIS_FILE/.dll/}
594	THIS_FILE_BASE=${THIS_FILE_BASE/.exe/}
595	if [ -f "${THIS_FILE/.dll/}.diz" ]; then
596	    THIS_DIZ_FILE=${THIS_FILE/.dll/}.diz
597	else
598	    THIS_DIZ_FILE="$($FIND $THIS_DIR -name $DIZ_NAME | $SED 1q)"
599	    if [ ! -f "$THIS_DIZ_FILE" ]; then
600		# As a last resort, look for diz file in the whole build output
601		# dir.
602		THIS_DIZ_FILE="$($FIND $THIS -name $DIZ_NAME | $SED 1q)"
603	    fi
604	fi
605	if [ -n "$THIS_DIZ_FILE" ]; then
606	    $MKDIR -p $FILE_WORK_DIR/this
607	    (cd $FILE_WORK_DIR/this ; $UNARCHIVE -o $THIS_DIZ_FILE)
608	    export _NT_SYMBOL_PATH="$_NT_SYMBOL_PATH;$FILE_WORK_DIR/this"
609	fi
610    fi
611
612    if [ -z "$SKIP_BIN_DIFF" ]; then
613        if cmp $OTHER_FILE $THIS_FILE > /dev/null; then
614        # The files were bytewise identical.
615            if [ -n "$VERBOSE" ]; then
616                echo "        :           :         :         :          : $BIN_FILE"
617            fi
618            return 0
619        fi
620        BIN_MSG=" diff "
621        if [[ "$ACCEPTED_BIN_DIFF" != *"$BIN_FILE"* ]]; then
622            DIFF_BIN=true
623            if [[ "$KNOWN_BIN_DIFF" != *"$BIN_FILE"* ]]; then
624                BIN_MSG="*$BIN_MSG*"
625                REGRESSIONS=true
626            else
627                BIN_MSG=" $BIN_MSG "
628            fi
629        else
630            BIN_MSG="($BIN_MSG)"
631            DIFF_BIN=
632        fi
633    fi
634
635    if [ -n "$STAT" ]; then
636        THIS_SIZE=$($STAT $STAT_PRINT_SIZE "$THIS_FILE")
637        OTHER_SIZE=$($STAT $STAT_PRINT_SIZE "$OTHER_FILE")
638    else
639        THIS_SIZE=$(ls -l "$THIS_FILE" | awk '{ print $5 }')
640        OTHER_SIZE=$(ls -l "$OTHER_FILE" | awk '{ print $5 }')
641    fi
642    if [ $THIS_SIZE -ne $OTHER_SIZE ]; then
643        DIFF_SIZE_NUM=$($EXPR $THIS_SIZE - $OTHER_SIZE)
644        DIFF_SIZE_REL=$($EXPR $THIS_SIZE \* 100 / $OTHER_SIZE)
645        SIZE_MSG=$($PRINTF "%3d%% %4d" $DIFF_SIZE_REL $DIFF_SIZE_NUM)
646        if [[ "$ACCEPTED_SMALL_SIZE_DIFF" = *"$BIN_FILE"* ]] && [ "$DIFF_SIZE_REL" -gt 98 ] \
647	    && [ "$DIFF_SIZE_REL" -lt 102 ]; then
648            SIZE_MSG="($SIZE_MSG)"
649            DIFF_SIZE=
650        elif [ "$OPENJDK_TARGET_OS" = "windows" ] \
651	    && [[ "$ACCEPTED_SMALL_SIZE_DIFF" = *"$BIN_FILE"* ]] \
652	    && [ "$DIFF_SIZE_NUM" = 512 ]; then
653	    # On windows, size of binaries increase in 512 increments.
654            SIZE_MSG="($SIZE_MSG)"
655            DIFF_SIZE=
656        elif [ "$OPENJDK_TARGET_OS" = "windows" ] \
657	    && [[ "$ACCEPTED_SMALL_SIZE_DIFF" = *"$BIN_FILE"* ]] \
658	    && [ "$DIFF_SIZE_NUM" = -512 ]; then
659	    # On windows, size of binaries increase in 512 increments.
660            SIZE_MSG="($SIZE_MSG)"
661            DIFF_SIZE=
662        else
663            if [[ "$ACCEPTED_SIZE_DIFF" != *"$BIN_FILE"* ]]; then
664                DIFF_SIZE=true
665                if [[ "$KNOWN_SIZE_DIFF" != *"$BIN_FILE"* ]]; then
666                    SIZE_MSG="*$SIZE_MSG*"
667                    REGRESSIONS=true
668                else
669                    SIZE_MSG=" $SIZE_MSG "
670                fi
671            else
672                SIZE_MSG="($SIZE_MSG)"
673                DIFF_SIZE=
674            fi
675        fi
676    else
677        SIZE_MSG="           "
678        DIFF_SIZE=
679        if [[ "$KNOWN_SIZE_DIFF $ACCEPTED_SIZE_DIFF" = *"$BIN_FILE"* ]]; then
680            SIZE_MSG="     !     "
681        fi
682    fi
683
684    if [[ "$SORT_SYMBOLS" = *"$BIN_FILE"* ]]; then
685        SYM_SORT_CMD="sort"
686    else
687        SYM_SORT_CMD="cat"
688    fi
689
690    # Check symbols
691    if [ "$OPENJDK_TARGET_OS" = "windows" ]; then
692        # The output from dumpbin on windows differs depending on if the debug symbol
693        # files are still around at the location the binary is pointing too. Need
694	# to filter out that extra information.
695	$DUMPBIN -exports $OTHER_FILE | $GREP  -E '^ +[0-9A-F]+ +[0-9A-F]+ [0-9A-F]+' | sed 's/ = .*//g' | cut -c27- | $SYM_SORT_CMD > $WORK_FILE_BASE.symbols.other
696	$DUMPBIN -exports $THIS_FILE  | $GREP  -E '^ +[0-9A-F]+ +[0-9A-F]+ [0-9A-F]+' | sed 's/ = .*//g' | cut -c27- | $SYM_SORT_CMD > $WORK_FILE_BASE.symbols.this
697    elif [ "$OPENJDK_TARGET_OS" = "solaris" ]; then
698        # Some symbols get seemingly random 15 character prefixes. Filter them out.
699        $NM -a $ORIG_OTHER_FILE 2> /dev/null | $GREP -v $NAME | $AWK '{print $2, $3, $4, $5}' | $SED 's/^\([a-zA-Z] [\.\$]\)[a-zA-Z0-9_\$]\{15,15\}\./\1./g' | $SYM_SORT_CMD > $WORK_FILE_BASE.symbols.other
700	$NM -a $ORIG_THIS_FILE  2> /dev/null | $GREP -v $NAME | $AWK '{print $2, $3, $4, $5}' | $SED 's/^\([a-zA-Z] [\.\$]\)[a-zA-Z0-9_\$]\{15,15\}\./\1./g' | $SYM_SORT_CMD > $WORK_FILE_BASE.symbols.this
701    else
702	$NM -a $ORIG_OTHER_FILE 2> /dev/null | $GREP -v $NAME | $AWK '{print $2, $3, $4, $5}' | $SYM_SORT_CMD > $WORK_FILE_BASE.symbols.other
703	$NM -a $ORIG_THIS_FILE  2> /dev/null | $GREP -v $NAME | $AWK '{print $2, $3, $4, $5}' | $SYM_SORT_CMD > $WORK_FILE_BASE.symbols.this
704    fi
705    
706    LC_ALL=C $DIFF $WORK_FILE_BASE.symbols.other $WORK_FILE_BASE.symbols.this > $WORK_FILE_BASE.symbols.diff
707    if [ -s $WORK_FILE_BASE.symbols.diff ]; then
708        SYM_MSG=" diff  "
709        if [[ "$ACCEPTED_SYM_DIFF" != *"$BIN_FILE"* ]]; then
710            DIFF_SYM=true
711            if [[ "$KNOWN_SYM_DIFF" != *"$BIN_FILE"* ]]; then
712                SYM_MSG="*$SYM_MSG*"
713                REGRESSIONS=true
714            else
715                SYM_MSG=" $SYM_MSG "
716            fi
717        else
718            SYM_MSG="($SYM_MSG)"            
719            DIFF_SYM=
720        fi
721    else
722        SYM_MSG="         "
723        DIFF_SYM=
724        if [[ "$KNOWN_SYM_DIFF $ACCEPTED_SYM_DIFF" = *"$BIN_FILE"* ]]; then
725            SYM_MSG="    !    "
726        fi
727    fi
728
729    # Check dependencies
730    if [ -n "$LDD_CMD" ]; then
731	(cd $FILE_WORK_DIR && $CP $OTHER_FILE . && $LDD_CMD $NAME 2>/dev/null | $AWK '{ print $1;}' | $SORT | $TEE $WORK_FILE_BASE.deps.other | $UNIQ > $WORK_FILE_BASE.deps.other.uniq)
732	(cd $FILE_WORK_DIR && $CP $THIS_FILE . && $LDD_CMD $NAME 2</dev/null | $AWK '{ print $1;}' | $SORT | $TEE $WORK_FILE_BASE.deps.this | $UNIQ > $WORK_FILE_BASE.deps.this.uniq)
733	(cd $FILE_WORK_DIR && $RM -f $NAME)
734	
735	LC_ALL=C $DIFF $WORK_FILE_BASE.deps.other $WORK_FILE_BASE.deps.this > $WORK_FILE_BASE.deps.diff
736	LC_ALL=C $DIFF $WORK_FILE_BASE.deps.other.uniq $WORK_FILE_BASE.deps.this.uniq > $WORK_FILE_BASE.deps.diff.uniq
737	
738	if [ -s $WORK_FILE_BASE.deps.diff ]; then
739            if [ -s $WORK_FILE_BASE.deps.diff.uniq ]; then
740		DEP_MSG=" diff  "
741            else
742		DEP_MSG=" redun "
743            fi
744            if [[ "$ACCEPTED_DEP_DIFF" != *"$BIN_FILE"* ]]; then
745		DIFF_DEP=true
746		if [[ "$KNOWN_DEP_DIFF" != *"$BIN_FILE"* ]]; then
747                    DEP_MSG="*$DEP_MSG*"
748                    REGRESSIONS=true
749		else
750                    DEP_MSG=" $DEP_MSG "
751		fi
752            else
753		DEP_MSG="($DEP_MSG)"
754		DIFF_DEP=
755            fi
756	else
757	    DEP_MSG="         "
758	    DIFF_DEP=
759            if [[ "$KNOWN_DEP_DIFF $ACCEPTED_DEP_DIFF" = *"$BIN_FILE"* ]]; then
760                DEP_MSG="     !      "
761            fi
762	fi
763    else
764	DEP_MSG="    -    "
765    fi
766    
767    # Compare fulldump output
768    if [ -n "$FULLDUMP_CMD" ] && [ -z "$SKIP_FULLDUMP_DIFF" ]; then
769        $FULLDUMP_CMD $OTHER_FILE > $WORK_FILE_BASE.fulldump.other 2>&1
770        $FULLDUMP_CMD $THIS_FILE > $WORK_FILE_BASE.fulldump.this 2>&1
771        LC_ALL=C $DIFF $WORK_FILE_BASE.fulldump.other $WORK_FILE_BASE.fulldump.this > $WORK_FILE_BASE.fulldump.diff
772        
773        if [ -s $WORK_FILE_BASE.fulldump.diff ]; then
774            ELF_DIFF_SIZE=$(ls -n $WORK_FILE_BASE.fulldump.diff | awk '{print $5}')
775            ELF_MSG=$($PRINTF "%8d" $ELF_DIFF_SIZE)
776            if [[ "$ACCEPTED_ELF_DIFF" != *"$BIN_FILE"* ]]; then
777                DIFF_ELF=true
778                if [[ "$KNOWN_ELF_DIFF" != *"$BIN_FILE"* ]]; then
779                    ELF_MSG="*$ELF_MSG*"
780                    REGRESSIONS=true
781                else
782                    ELF_MSG=" $ELF_MSG "
783                fi
784            else
785                ELF_MSG="($ELF_MSG)"
786                DIFF_ELF=
787            fi
788        else
789            ELF_MSG="          "
790            DIFF_ELF=
791            if [[ "$KNOWN_DEP_DIFF $ACCEPTED_DEP_DIFF" = *"$BIN_FILE"* ]]; then
792                ELF_MSG="    !    "
793            fi
794        fi
795    fi
796
797    # Compare disassemble output
798    if [ -n "$DIS_CMD" ] && [ -z "$SKIP_DIS_DIFF" ]; then
799	if [ -z "$DIS_DIFF_FILTER" ]; then
800	    DIS_DIFF_FILTER="$CAT"
801	fi
802        $DIS_CMD $OTHER_FILE | $GREP -v $NAME | $DIS_DIFF_FILTER > $WORK_FILE_BASE.dis.other 2>&1
803        $DIS_CMD $THIS_FILE  | $GREP -v $NAME | $DIS_DIFF_FILTER > $WORK_FILE_BASE.dis.this  2>&1
804        
805        LC_ALL=C $DIFF $WORK_FILE_BASE.dis.other $WORK_FILE_BASE.dis.this > $WORK_FILE_BASE.dis.diff
806        
807        if [ -s $WORK_FILE_BASE.dis.diff ]; then
808            DIS_DIFF_SIZE=$(ls -n $WORK_FILE_BASE.dis.diff | awk '{print $5}')
809            DIS_MSG=$($PRINTF "%8d" $DIS_DIFF_SIZE)
810            if [[ "$ACCEPTED_DIS_DIFF" != *"$BIN_FILE"* ]]; then
811                DIFF_DIS=true
812                if [[ "$KNOWN_DIS_DIFF" != *"$BIN_FILE"* ]]; then
813                    DIS_MSG="*$DIS_MSG*"
814                    REGRESSIONS=true
815                else
816                    DIS_MSG=" $DIS_MSG "
817                fi
818            else
819                DIS_MSG="($DIS_MSG)"
820                DIFF_DIS=
821            fi
822        else
823            DIS_MSG="          "
824            DIFF_DIS=
825            if [[ "$KNOWN_DEP_DIFF $ACCEPTED_DEP_DIFF" = *"$BIN_FILE"* ]]; then
826                DIS_MSG="    !    "
827            fi
828        fi
829    fi
830
831
832    if [ -n "$DIFF_BIN$DIFF_SIZE$DIFF_SYM$DIFF_DEP$DIFF_ELF$DIFF_DIS" ] || [ -n "$VERBOSE" ]; then
833        if [ -n "$BIN_MSG" ]; then echo -n "$BIN_MSG:"; fi
834        if [ -n "$SIZE_MSG" ]; then echo -n "$SIZE_MSG:"; fi
835        if [ -n "$SYM_MSG" ]; then echo -n "$SYM_MSG:"; fi
836        if [ -n "$DEP_MSG" ]; then echo -n "$DEP_MSG:"; fi
837        if [ -n "$ELF_MSG" ]; then echo -n "$ELF_MSG:"; fi
838        if [ -n "$DIS_MSG" ]; then echo -n "$DIS_MSG:"; fi
839        echo " $BIN_FILE"
840        if [ "$SHOW_DIFFS" = "true" ]; then
841            if [ -s "$WORK_FILE_BASE.symbols.diff" ]; then
842                echo "Symbols diff:"
843                $CAT $WORK_FILE_BASE.symbols.diff
844            fi
845            if [ -s "$WORK_FILE_BASE.deps.diff" ]; then
846                echo "Deps diff:"
847                $CAT $WORK_FILE_BASE.deps.diff
848            fi
849            if [ -s "$WORK_FILE_BASE.fulldump.diff" ]; then
850                echo "Fulldump diff:"
851                $CAT $WORK_FILE_BASE.fulldump.diff
852            fi
853            if [ -s "$WORK_FILE_BASE.dis.diff" ]; then
854                echo "Disassembly diff:"
855                $CAT $WORK_FILE_BASE.dis.diff
856            fi
857        fi
858        return 1
859    fi
860    return 0
861}
862
863##########################################################################################
864# Print binary diff header
865
866print_binary_diff_header() {
867    if [ -z "$SKIP_BIN_DIFF" ]; then echo -n " Binary :"; fi
868    if [ -z "$SKIP_SIZE_DIFF" ]; then echo -n "   Size    :"; fi
869    if [ -z "$SKIP_SYM_DIFF" ]; then echo -n " Symbols :"; fi
870    if [ -z "$SKIP_DEP_DIFF" ]; then echo -n "  Deps   :"; fi
871    if [ -z "$SKIP_FULLDUMP_DIFF" ]; then echo -n " Fulldump :"; fi
872    if [ -z "$SKIP_DIS_DIFF" ]; then echo -n " Disass   :"; fi
873    echo
874}
875
876##########################################################################################
877# Compare all libraries
878
879compare_all_libs() {
880    THIS_DIR=$1
881    OTHER_DIR=$2
882    WORK_DIR=$3
883
884    LIBS=$(cd $THIS_DIR && $FIND . -type f \( -name 'lib*.so' -o -name '*.dylib' -o -name '*.dll' -o -name 'JavaControlPanel' \) | $SORT | $FILTER)
885
886    if [ -n "$LIBS" ]; then
887        echo Libraries...
888        print_binary_diff_header
889        for l in $LIBS; do
890            if [ -f "$OTHER_DIR/$l" ]; then
891                compare_bin_file $THIS_DIR $OTHER_DIR $WORK_DIR $l
892                if [ "$?" != "0" ]; then
893                    return_value=1
894                fi
895            fi
896        done
897    fi
898
899    return $return_value
900}
901
902##########################################################################################
903# Compare all executables
904
905compare_all_execs() {
906    THIS_DIR=$1
907    OTHER_DIR=$2
908    WORK_DIR=$3
909
910    if [ "$OPENJDK_TARGET_OS" = "windows" ]; then
911        EXECS=$(cd $THIS_DIR && $FIND . -type f -name '*.exe' | $SORT | $FILTER)
912    else
913        EXECS=$(cd $THIS_DIR && $FIND . -name db -prune -o -type f -perm -100 \! \
914            \( -name '*.so' -o -name '*.dylib' -o -name '*.dll' -o -name '*.cgi' \
915            -o -name '*.jar' -o -name '*.diz' -o -name 'jcontrol' -o -name '*.properties' \
916            -o -name '*.data' -o -name '*.bfc' -o -name '*.src' -o -name '*.txt' \
917            -o -name '*.cfg' -o -name 'meta-index' -o -name '*.properties.ja' \
918            -o -name 'classlist' \) | $SORT | $FILTER)
919    fi
920
921    if [ -n "$EXECS" ]; then
922        echo Executables...
923        print_binary_diff_header
924        for e in $EXECS; do
925            if [ -f "$OTHER_DIR/$e" ]; then
926                compare_bin_file $THIS_DIR $OTHER_DIR $WORK_DIR $e
927                if [ "$?" != "0" ]; then
928                    return_value=1
929                fi
930            fi
931        done
932    fi
933
934    return $return_value
935}
936
937##########################################################################################
938# Initiate configuration
939
940COMPARE_ROOT=/tmp/cimages.$USER
941$MKDIR -p $COMPARE_ROOT
942if [ "$OPENJDK_TARGET_OS" = "windows" ]; then
943    if [ "$(uname -o)" = "Cygwin" ]; then
944	COMPARE_ROOT=$(cygpath -msa $COMPARE_ROOT)
945    fi
946fi
947
948THIS="$( cd "$( dirname "$0" )" && pwd )"
949echo "$THIS"
950THIS_SCRIPT="$0"
951
952if [ -z "$1" ] || [ "$1" = "-h" ] || [ "$1" = "-?" ] || [ "$1" = "/h" ] || [ "$1" = "/?" ] || [ "$1" = "-help" ] || [ "$1" = "--help" ]; then
953    echo "bash ./compare.sh [OPTIONS] [FILTER]"
954    echo ""
955    echo "-all                Compare all files in all known ways"
956    echo "-names              Compare the file names and directory structure"
957    echo "-perms              Compare the permission bits on all files and directories"
958    echo "-types              Compare the output of the file command on all files"
959    echo "-general            Compare the files not convered by the specialized comparisons"
960    echo "-zips               Compare the contents of all zip files"
961    echo "-jars               Compare the contents of all jar files"
962    echo "-libs               Compare all native libraries"
963    echo "-execs              Compare all executables"
964    echo "-v                  Verbose output, does not hide known differences"
965    echo "-vv                 More verbose output, shows diff output of all comparisons"
966    echo "-o [OTHER]          Compare with build in other directory. Will default to the old build directory"
967    echo ""
968    echo "[FILTER]            List filenames in the image to compare, works for jars, zips, libs and execs"
969    echo "Example:"
970    echo "bash ./common/bin/compareimages.sh CodePointIM.jar"
971    echo ""
972    echo "-2zips <file1> <file2> Compare two zip files only"
973    echo ""
974    exit 10
975fi
976
977CMP_NAMES=false
978CMP_PERMS=false
979CMP_TYPES=false
980CMP_GENERAL=false
981CMP_ZIPS=false
982CMP_JARS=false
983CMP_LIBS=false
984CMP_EXECS=false
985
986while [ -n "$1" ]; do
987    case "$1" in
988        -v)
989            VERBOSE=true
990            ;;
991        -vv)
992            VERBOSE=true
993            SHOW_DIFFS=true
994            ;;
995        -o)
996            OTHER="$2"
997            shift
998            ;;
999        -all)
1000            CMP_NAMES=true
1001            if [ "$OPENJDK_TARGET_OS" != "windows" ]; then
1002                CMP_PERMS=true
1003            fi
1004            CMP_TYPES=true
1005            CMP_GENERAL=true
1006            CMP_ZIPS=true
1007            CMP_JARS=true
1008            CMP_LIBS=true
1009            CMP_EXECS=true
1010            ;;
1011        -names)
1012            CMP_NAMES=true
1013            ;;
1014        -perms)
1015            CMP_PERMS=true
1016            ;;
1017        -types)
1018            CMP_TYPES=true
1019            ;;
1020        -general)
1021            CMP_GENERAL=true
1022            ;;
1023        -zips)
1024            CMP_ZIPS=true
1025            ;;
1026        -jars)
1027            CMP_JARS=true
1028            ;;
1029        -libs)
1030            CMP_LIBS=true
1031            ;;
1032        -execs)
1033            CMP_EXECS=true
1034            ;;
1035        -2zips)
1036            CMP_2_ZIPS=true
1037            THIS_FILE=$2
1038            OTHER_FILE=$3
1039            shift
1040            shift
1041            ;;
1042        *)
1043            CMP_NAMES=false
1044            CMP_PERMS=false
1045            CMP_TYPES=false
1046            CMP_ZIPS=true
1047            CMP_JARS=true
1048            CMP_LIBS=true
1049            CMP_EXECS=true
1050            
1051            if [ -z "$FILTER" ]; then
1052                FILTER="$GREP"
1053            fi
1054            FILTER="$FILTER -e $1"
1055            ;;
1056    esac
1057    shift
1058done
1059
1060if [ "$CMP_2_ZIPS" = "true" ]; then
1061    THIS_DIR="$(dirname $THIS_FILE)"
1062    THIS_DIR="$(cd "$THIS_DIR" && pwd )"
1063    OTHER_DIR="$(dirname $OTHER_FILE)"
1064    OTHER_DIR="$(cd "$OTHER_DIR" && pwd )"
1065    THIS_FILE_NAME="$(basename $THIS_FILE)"
1066    OTHER_FILE_NAME="$(basename $OTHER_FILE)"
1067    echo Comparing $THIS_DIR/$THIS_FILE_NAME and $OTHER_DIR/$OTHER_FILE_NAME
1068    compare_zip_file $THIS_DIR $OTHER_DIR $COMPARE_ROOT/2zips $THIS_FILE_NAME $OTHER_FILE_NAME
1069    exit
1070fi
1071
1072if [ "$CMP_NAMES" = "false" ] && [ "$CMP_TYPES" = "false" ] && [ "$CMP_PERMS" = "false" ] && [ "$CMP_GENERAL" = "false" ] && [ "$CMP_ZIPS" = "false" ] && [ "$CMP_JARS" = "false" ] && [ "$CMP_LIBS" = "false" ] && [ "$CMP_EXECS" = "false" ]; then
1073    CMP_NAMES=true
1074    CMP_PERMS=true
1075    CMP_TYPES=true
1076    CMP_GENERAL=true
1077    CMP_ZIPS=true
1078    CMP_JARS=true
1079    CMP_LIBS=true
1080    CMP_EXECS=true
1081fi
1082
1083if [ -z "$FILTER" ]; then
1084    FILTER="$CAT"
1085fi
1086
1087if [ -z "$OTHER" ]; then
1088    OTHER="$THIS/../$LEGACY_BUILD_DIR"
1089    if [ -d "$OTHER" ]; then
1090        OTHER="$( cd "$OTHER" && pwd )"
1091    else
1092        echo "Default old build directory does not exist:"
1093        echo "$OTHER"
1094        exit 1
1095    fi
1096    echo "Comparing to default old build:"
1097    echo "$OTHER"
1098    echo
1099else
1100    if [ ! -d "$OTHER" ]; then
1101        echo "Other build directory does not exist:"
1102        echo "$OTHER"
1103        exit 1
1104    fi
1105    OTHER="$( cd "$OTHER" && pwd )"
1106    echo "Comparing to:"
1107    echo "$OTHER"
1108    echo
1109fi
1110
1111
1112# Figure out the layout of the this build. Which kinds of images have been produced
1113if [ -d "$THIS/install/j2sdk-image" ]; then
1114    THIS_J2SDK="$THIS/install/j2sdk-image"
1115    THIS_J2RE="$THIS/install/j2re-image"
1116    echo "Selecting install images in this build"
1117elif [ -d "$THIS/deploy/j2sdk-image" ]; then
1118    THIS_J2SDK="$THIS/deploy/j2sdk-image"
1119    THIS_J2RE="$THIS/deploy/j2re-image"
1120    echo "Selecting deploy images in this build"
1121elif [ -d "$THIS/images/j2sdk-image" ]; then
1122    THIS_J2SDK="$THIS/images/j2sdk-image"
1123    THIS_J2RE="$THIS/images/j2re-image"
1124    echo "Selecting jdk images in this build"
1125fi
1126
1127if [ -d "$THIS/images/j2sdk-overlay-image" ]; then
1128    if [ -d "$THIS/install/j2sdk-image" ]; then
1129        # If there is an install image, prefer that, it's also overlay
1130        THIS_J2SDK_OVERLAY="$THIS/install/j2sdk-image"
1131        THIS_J2RE_OVERLAY="$THIS/install/j2re-image"
1132        echo "Selecting install overlay images in this build"
1133    else
1134        THIS_J2SDK_OVERLAY="$THIS/images/j2sdk-overlay-image"
1135        THIS_J2RE_OVERLAY="$THIS/images/j2re-overlay-image"
1136        echo "Selecting jdk overlay images in this build"
1137    fi
1138fi
1139
1140if [ -d "$THIS/images/j2sdk-bundle" ]; then
1141    THIS_J2SDK_BUNDLE="$THIS/images/j2sdk-bundle"
1142    THIS_J2RE_BUNDLE="$THIS/images/j2re-bundle"
1143    echo "Selecting bundles in this build"
1144fi
1145
1146# Figure out the layout of the other build (old or new, normal or overlay image)
1147if [ -d "$OTHER/j2sdk-image" ]; then
1148    if [ -f "$OTHER/j2sdk-image/LICENSE" ]; then
1149        OTHER_J2SDK="$OTHER/j2sdk-image"
1150        OTHER_J2RE="$OTHER/j2re-image"
1151        echo "Selecting old-style images in other build"
1152    else
1153        OTHER_J2SDK_OVERLAY="$OTHER/j2sdk-image"
1154        OTHER_J2RE_OVERLAY="$OTHER/j2re-image"
1155        echo "Selecting overlay images in other build"
1156    fi
1157elif [ -d "$OTHER/install/j2sdk-image" ]; then
1158    OTHER_J2SDK="$OTHER/install/j2sdk-image"
1159    OTHER_J2RE="$OTHER/install/j2re-image"
1160    echo "Selecting install images in other build"
1161elif [ -d "$OTHER/deploy/j2sdk-image" ]; then
1162    OTHER_J2SDK="$OTHER/deploy/j2sdk-image"
1163    OTHER_J2RE="$OTHER/deploy/j2re-image"
1164    echo "Selecting deploy images in other build"
1165elif [ -d "$OTHER/images/j2sdk-image" ]; then
1166    OTHER_J2SDK="$OTHER/images/j2sdk-image"
1167    OTHER_J2RE="$OTHER/images/j2re-image"
1168    echo "Selecting jdk images in other build"
1169fi
1170
1171if [ -d "$OTHER/j2sdk-bundle" ]; then
1172    OTHER_J2SDK_BUNDLE="$OTHER/j2sdk-bundle"
1173    OTHER_J2RE_BUNDLE="$OTHER/j2re-bundle"
1174    echo "Selecting bundles in other build"
1175elif [ -d "$OTHER/images/j2sdk-bundle" ]; then
1176    OTHER_J2SDK_BUNDLE="$OTHER/images/j2sdk-bundle"
1177    OTHER_J2RE_BUNDLE="$OTHER/images/j2re-bundle"
1178    echo "Selecting jdk bundles in other build"
1179fi
1180
1181if [ -z "$THIS_J2SDK" ] || [ -z "$THIS_J2RE" ]; then
1182    if [ -z "$THIS_J2SDK_OVERLAY" ]; then
1183        echo "Cannot locate images for this build. Are you sure you have run 'make images'?"
1184        exit 1
1185    fi
1186fi
1187
1188if [ -z "$OTHER_J2SDK" ] && [ -n "$OTHER_J2SDK_OVERLAY" ] && [ -z "$THIS_J2SDK_OVERLAY" ]; then
1189    echo "OTHER build only has an overlay image while this build does not. Nothing to compare!"
1190    exit 1
1191fi
1192
1193if [ -z "$THIS_J2SDK_BUNDLE" ] && [ -n "$OTHER_J2SDK_BUNDLE" ]; then
1194    echo "WARNING! OTHER build has bundles built while this build does not."
1195    echo "Skipping bundle compare!"
1196fi
1197
1198if [ -d "$THIS/docs" ]; then
1199    THIS_DOCS="$THIS/docs"
1200fi
1201
1202if [ -d "$OTHER/docs" ]; then
1203    OTHER_DOCS="$OTHER/docs"
1204fi
1205
1206if [ -z "$THIS_DOCS" ]; then
1207    echo "WARNING! Docs haven't been built and won't be compared."
1208fi
1209
1210if [ -z "$OTHER_DOCS" ]; then
1211    echo "WARNING! Other build doesn't contain docs, skipping doc compare."
1212fi
1213
1214if [ -d "$OTHER/images" ]; then
1215    OTHER_SEC_DIR="$OTHER/images"
1216else
1217    OTHER_SEC_DIR="$OTHER/tmp"
1218fi
1219OTHER_SEC_BIN="$OTHER_SEC_DIR/sec-bin.zip"
1220THIS_SEC_DIR="$THIS/images"
1221THIS_SEC_BIN="$THIS_SEC_DIR/sec-bin.zip"
1222if [ "$OPENJDK_TARGET_OS" = "windows" ]; then
1223    if [ "$OPENJDK_TARGET_CPU" = "x86_64" ]; then
1224        JGSS_WINDOWS_BIN="jgss-windows-x64-bin.zip"
1225    else
1226        JGSS_WINDOWS_BIN="jgss-windows-i586-bin.zip"
1227    fi
1228    OTHER_SEC_WINDOWS_BIN="$OTHER_SEC_DIR/sec-windows-bin.zip"
1229    OTHER_JGSS_WINDOWS_BIN="$OTHER_SEC_DIR/$JGSS_WINDOWS_BIN"
1230    THIS_SEC_WINDOWS_BIN="$THIS_SEC_DIR/sec-windows-bin.zip"
1231    THIS_JGSS_WINDOWS_BIN="$THIS_SEC_DIR/$JGSS_WINDOWS_BIN"
1232fi
1233
1234##########################################################################################
1235# Do the work
1236
1237if [ "$CMP_NAMES" = "true" ]; then
1238    if [ -n "$THIS_J2SDK" ] && [ -n "$OTHER_J2SDK" ]; then
1239        echo -n "J2SDK "
1240        compare_dirs $THIS_J2SDK $OTHER_J2SDK $COMPARE_ROOT/j2sdk
1241        echo -n "J2RE  "
1242        compare_dirs $THIS_J2RE $OTHER_J2RE $COMPARE_ROOT/j2re
1243        
1244        echo -n "J2SDK "
1245        compare_files $THIS_J2SDK $OTHER_J2SDK $COMPARE_ROOT/j2sdk
1246        echo -n "J2RE  "
1247        compare_files $THIS_J2RE $OTHER_J2RE $COMPARE_ROOT/j2re
1248    fi
1249    if [ -n "$THIS_J2SDK_OVERLAY" ] && [ -n "$OTHER_J2SDK_OVERLAY" ]; then
1250        echo -n "J2SDK Overlay "
1251        compare_dirs $THIS_J2SDK_OVERLAY $OTHER_J2SDK_OVERLAY $COMPARE_ROOT/j2sdk-overlay
1252        echo -n "J2RE  Overlay "
1253        compare_dirs $THIS_J2RE_OVERLAY $OTHER_J2RE_OVERLAY $COMPARE_ROOT/j2re-overlay
1254        
1255        echo -n "J2SDK Overlay "
1256        compare_files $THIS_J2SDK_OVERLAY $OTHER_J2SDK_OVERLAY $COMPARE_ROOT/j2sdk-overlay
1257        echo -n "J2RE  Overlay "
1258        compare_files $THIS_J2RE_OVERLAY $OTHER_J2RE_OVERLAY $COMPARE_ROOT/j2re-overlay
1259    fi
1260    if [ -n "$THIS_J2SDK_BUNDLE" ] && [ -n "$OTHER_J2SDK_BUNDLE" ]; then
1261        echo -n "J2SDK Bundle "
1262        compare_dirs $THIS_J2SDK_BUNDLE $OTHER_J2SDK_BUNDLE $COMPARE_ROOT/j2sdk-bundle
1263        echo -n "J2RE  Bundle "
1264        compare_dirs $THIS_J2RE_BUNDLE $OTHER_J2RE_BUNDLE $COMPARE_ROOT/j2re-bundle
1265        
1266        echo -n "J2SDK Bundle "
1267        compare_files $THIS_J2SDK_BUNDLE $OTHER_J2SDK_BUNDLE $COMPARE_ROOT/j2sdk-bundle
1268        echo -n "J2RE  Bundle "
1269        compare_files $THIS_J2RE_BUNDLE $OTHER_J2RE_BUNDLE $COMPARE_ROOT/j2re-bundle
1270    fi
1271    if [ -n "$THIS_DOCS" ] && [ -n "$OTHER_DOCS" ]; then
1272        echo -n "Docs "
1273        compare_dirs $THIS_DOCS $OTHER_DOCS $COMPARE_ROOT/docs
1274        echo -n "Docs "
1275        compare_files $THIS_DOCS $OTHER_DOCS $COMPARE_ROOT/docs
1276    fi
1277fi
1278
1279if [ "$CMP_PERMS" = "true" ]; then
1280    if [ -n "$THIS_J2SDK" ] && [ -n "$OTHER_J2SDK" ]; then
1281        echo -n "J2SDK "
1282        compare_permissions $THIS_J2SDK $OTHER_J2SDK $COMPARE_ROOT/j2sdk
1283        echo -n "J2RE  "
1284        compare_permissions $THIS_J2RE $OTHER_J2RE $COMPARE_ROOT/j2re
1285    fi
1286    if [ -n "$THIS_J2SDK_OVERLAY" ] && [ -n "$OTHER_J2SDK_OVERLAY" ]; then
1287        echo -n "J2SDK Overlay "
1288        compare_permissions $THIS_J2SDK_OVERLAY $OTHER_J2SDK_OVERLAY $COMPARE_ROOT/j2sdk-overlay
1289        echo -n "J2RE  Overlay "
1290        compare_permissions $THIS_J2RE_OVERLAY $OTHER_J2RE_OVERLAY $COMPARE_ROOT/j2re-overlay
1291    fi
1292    if [ -n "$THIS_J2SDK_BUNDLE" ] && [ -n "$OTHER_J2SDK_BUNDLE" ]; then
1293        echo -n "J2SDK Bundle "
1294        compare_permissions $THIS_J2SDK_BUNDLE $OTHER_J2SDK_BUNDLE $COMPARE_ROOT/j2sdk-bundle
1295        echo -n "J2RE  Bundle "
1296        compare_permissions $THIS_J2RE_BUNDLE $OTHER_J2RE_BUNDLE $COMPARE_ROOT/j2re-bundle
1297    fi
1298fi
1299
1300if [ "$CMP_TYPES" = "true" ]; then
1301    if [ -n "$THIS_J2SDK" ] && [ -n "$OTHER_J2SDK" ]; then
1302        echo -n "J2SDK "
1303        compare_file_types $THIS_J2SDK $OTHER_J2SDK $COMPARE_ROOT/j2sdk
1304        echo -n "J2RE  "
1305        compare_file_types $THIS_J2RE $OTHER_J2RE $COMPARE_ROOT/j2re
1306    fi
1307    if [ -n "$THIS_J2SDK_OVERLAY" ] && [ -n "$OTHER_J2SDK_OVERLAY" ]; then
1308        echo -n "J2SDK Overlay "
1309        compare_file_types $THIS_J2SDK_OVERLAY $OTHER_J2SDK_OVERLAY $COMPARE_ROOT/j2sdk-overlay
1310        echo -n "J2RE  Overlay "
1311        compare_file_types $THIS_J2RE_OVERLAY $OTHER_J2RE_OVERLAY $COMPARE_ROOT/j2re-overlay
1312    fi
1313    if [ -n "$THIS_J2SDK_BUNDLE" ] && [ -n "$OTHER_J2SDK_BUNDLE" ]; then
1314        echo -n "J2SDK Bundle "
1315        compare_file_types $THIS_J2SDK_BUNDLE $OTHER_J2SDK_BUNDLE $COMPARE_ROOT/j2sdk-bundle
1316        echo -n "J2RE  Bundle "
1317        compare_file_types $THIS_J2RE_BUNDLE $OTHER_J2RE_BUNDLE $COMPARE_ROOT/j2re-bundle
1318    fi
1319fi
1320
1321if [ "$CMP_GENERAL" = "true" ]; then
1322    if [ -n "$THIS_J2SDK" ] && [ -n "$OTHER_J2SDK" ]; then
1323        echo -n "J2SDK "
1324        compare_general_files $THIS_J2SDK $OTHER_J2SDK $COMPARE_ROOT/j2sdk
1325        echo -n "J2RE  "
1326        compare_general_files $THIS_J2RE $OTHER_J2RE $COMPARE_ROOT/j2re
1327    fi
1328    if [ -n "$THIS_J2SDK_OVERLAY" ] && [ -n "$OTHER_J2SDK_OVERLAY" ]; then
1329        echo -n "J2SDK Overlay "
1330        compare_general_files $THIS_J2SDK_OVERLAY $OTHER_J2SDK_OVERLAY $COMPARE_ROOT/j2sdk-overlay
1331        echo -n "J2RE  Overlay "
1332        compare_general_files $THIS_J2RE_OVERLAY $OTHER_J2RE_OVERLAY $COMPARE_ROOT/j2re-overlay
1333    fi
1334    if [ -n "$THIS_J2SDK_BUNDLE" ] && [ -n "$OTHER_J2SDK_BUNDLE" ]; then
1335        echo -n "J2SDK Bundle "
1336        compare_general_files $THIS_J2SDK_BUNDLE $OTHER_J2SDK_BUNDLE $COMPARE_ROOT/j2sdk-bundle
1337        echo -n "J2RE  Bundle "
1338        compare_general_files $THIS_J2RE_BUNDLE $OTHER_J2RE_BUNDLE $COMPARE_ROOT/j2re-bundle
1339    fi
1340    if [ -n "$THIS_DOCS" ] && [ -n "$OTHER_DOCS" ]; then
1341        echo -n "Docs "
1342        compare_general_files $THIS_DOCS $OTHER_DOCS $COMPARE_ROOT/docs
1343    fi
1344fi
1345
1346if [ "$CMP_ZIPS" = "true" ]; then
1347    if [ -n "$THIS_J2SDK" ] && [ -n "$OTHER_J2SDK" ]; then
1348        compare_all_zip_files $THIS_J2SDK $OTHER_J2SDK $COMPARE_ROOT/j2sdk
1349    fi
1350    if [ -n "$THIS_SEC_BIN" ] && [ -n "$OTHER_SEC_BIN" ]; then
1351        if [ -n "$(echo $THIS_SEC_BIN | $FILTER)" ]; then
1352            echo "sec-bin.zip..."
1353            compare_zip_file $THIS_SEC_DIR $OTHER_SEC_DIR $COMPARE_ROOT/sec-bin sec-bin.zip
1354        fi
1355    fi
1356    if [ -n "$THIS_SEC_WINDOWS_BIN" ] && [ -n "$OTHER_SEC_WINDOWS_BIN" ]; then
1357        if [ -n "$(echo $THIS_SEC_WINDOWS_BIN | $FILTER)" ]; then
1358            echo "sec-windows-bin.zip..."
1359            compare_zip_file $THIS_SEC_DIR $OTHER_SEC_DIR $COMPARE_ROOT/sec-bin sec-windows-bin.zip
1360        fi
1361    fi
1362    if [ -n "$THIS_JGSS_WINDOWS_BIN" ] && [ -n "$OTHER_JGSS_WINDOWS_BIN" ]; then
1363        if [ -n "$(echo $THIS_JGSS_WINDOWS_BIN | $FILTER)" ]; then
1364            echo "$JGSS_WINDOWS_BIN..."
1365            compare_zip_file $THIS_SEC_DIR $OTHER_SEC_DIR $COMPARE_ROOT/sec-bin $JGSS_WINDOWS_BIN
1366        fi
1367    fi
1368fi
1369
1370if [ "$CMP_JARS" = "true" ]; then
1371    if [ -n "$THIS_J2SDK" ] && [ -n "$OTHER_J2SDK" ]; then
1372        compare_all_jar_files $THIS_J2SDK $OTHER_J2SDK $COMPARE_ROOT/j2sdk
1373    fi
1374fi
1375
1376if [ "$CMP_LIBS" = "true" ]; then
1377    if [ -n "$THIS_J2SDK" ] && [ -n "$OTHER_J2SDK" ]; then
1378        echo -n "J2SDK "
1379        compare_all_libs $THIS_J2SDK $OTHER_J2SDK $COMPARE_ROOT/j2sdk
1380        if [ "$OPENJDK_TARGET_OS" = "macosx" ]; then
1381            echo -n "J2RE  "
1382            compare_all_libs $THIS_J2RE $OTHER_J2RE $COMPARE_ROOT/j2re
1383        fi
1384    fi
1385    if [ -n "$THIS_J2SDK_OVERLAY" ] && [ -n "$OTHER_J2SDK_OVERLAY" ]; then
1386        echo -n "Bundle   "
1387        compare_all_libs $THIS_J2SDK_OVERLAY $OTHER_J2SDK_OVERLAY $COMPARE_ROOT/j2sdk-overlay
1388    fi
1389fi
1390
1391if [ "$CMP_EXECS" = "true" ]; then
1392    if [ -n "$THIS_J2SDK" ] && [ -n "$OTHER_J2SDK" ]; then
1393        compare_all_execs $THIS_J2SDK $OTHER_J2SDK $COMPARE_ROOT/j2sdk
1394    fi
1395    if [ -n "$THIS_J2SDK_OVERLAY" ] && [ -n "$OTHER_J2SDK_OVERLAY" ]; then
1396        echo -n "Overlay "
1397        compare_all_execs $THIS_J2SDK_OVERLAY $OTHER_J2SDK_OVERLAY $COMPARE_ROOT/j2sdk-overlay
1398    fi
1399fi
1400
1401echo
1402
1403if [ -n "$REGRESSIONS" ]; then
1404    echo "REGRESSIONS FOUND!"
1405    echo
1406    exit 1
1407else
1408    echo "No regressions found"
1409    echo
1410    exit 0
1411fi
1412