#!/bin/bash

#

# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

#

# This code is free software; you can redistribute it and/or modify it

# under the terms of the GNU General Public License version 2 only, as

# published by the Free Software Foundation.

#

# This code is distributed in the hope that it will be useful, but WITHOUT

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

# version 2 for more details (a copy is included in the LICENSE file that

# accompanied this code).

#

# You should have received a copy of the GNU General Public License version

# 2 along with this work; if not, write to the Free Software Foundation,

# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

#

# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

# or visit www.oracle.com if you need additional information or have any

# questions.

#

# This script is processed by configure before it's usable. It is run from

# the root of the build directory.

################################################################################

# Check that we are run via the wrapper generated by configure

if [ -z "$TOPDIR" ]; then

    echo "Error: You must run this script using build/[conf]/compare.sh"

    exit 1

fi

if [ "$OPENJDK_TARGET_OS" = "macosx" ]; then

    FULLDUMP_CMD="$OTOOL -v -V -h -X -d"

    LDD_CMD="$OTOOL -L"

    DIS_CMD="$OTOOL -v -V -t"

    STAT_PRINT_SIZE="-f %z"

elif [ "$OPENJDK_TARGET_OS" = "windows" ]; then

    FULLDUMP_CMD="$DUMPBIN -all"

    LDD_CMD="$DUMPBIN -dependents"

    DIS_CMD="$DUMPBIN -disasm:nobytes"

    STAT_PRINT_SIZE="-c %s"

elif [ "$OPENJDK_TARGET_OS" = "aix" ]; then

    FULLDUMP_CMD="dump -h -r -t -n -X64"

    LDD_CMD="$LDD"

    DIS_CMD="$OBJDUMP -d"

    STAT_PRINT_SIZE="-c %s"

else

    FULLDUMP_CMD="$READELF -a"

    LDD_CMD="$LDD"

    DIS_CMD="$OBJDUMP -d"

    STAT_PRINT_SIZE="-c %s"

fi

COMPARE_EXCEPTIONS_INCLUDE="$TOPDIR/make/scripts/compare_exceptions.sh.incl"

if [ ! -e "$COMPARE_EXCEPTIONS_INCLUDE" ]; then

    echo "Error: Cannot locate the exceptions file, it should have been here: $COMPARE_EXCEPTIONS_INCLUDE"

    exit 1

fi

# Include exception definitions

. "$COMPARE_EXCEPTIONS_INCLUDE"

################################################################################

#

# Disassembly diff filters. These filters try to filter out ephemeral parts of the

# disassembly, such as hard-coded addresses, to be able to catch "actual" differences.

if [ "$OPENJDK_TARGET_OS" = "solaris" ]; then

  if [ "$OPENJDK_TARGET_CPU" = "sparcv9" ]; then

    DIS_DIFF_FILTER="$SED \

        -e 's/^[0-9a-f]\{16\}/<ADDR>:/' \

        -e 's/^ *[0-9a-f]\{3,12\}:/  <ADDR>:/' \

        -e 's/:	[0-9a-f][0-9a-f]\( [0-9a-f][0-9a-f]\)\{2,10\}/:	<NUMS>/' \

        -e 's/\$[a-zA-Z0-9_\$]\{15\}\./<SYM>./' \

        -e 's/, [0-9a-fx\-]\{1,8\}/, <ADDR>/g' \

        -e 's/0x[0-9a-f]\{1,8\}/<HEX>/g' \

        -e 's/\! [0-9a-f]\{1,8\} /! <ADDR> /' \

        -e 's/call  [0-9a-f]\{4,7\}/call  <ADDR>/' \

        -e 's/%hi(0),/%hi(<HEX>),/' \

        "

  elif [ "$OPENJDK_TARGET_CPU" = "x86_64" ]; then

    # Random strings looking like this differ: <.XAKoKoPIac2W0OA.

    DIS_DIFF_FILTER="$SED \

        -e 's/<\.[A-Za-z0-9]\{\15}\./<.SYM./' \

        "

  fi

elif [ "$OPENJDK_TARGET_OS" = "windows" ]; then

  if [ "$OPENJDK_TARGET_CPU" = "x86" ]; then

    DIS_DIFF_FILTER="$SED -r \

        -e 's/^  [0-9A-F]{16}: //' \

        -e 's/^  [0-9A-F]{8}: /  <ADDR>: /' \

        -e 's/(offset \?\?)_C@_.*/\1<SYM>/' \

        -e 's/[@?][A-Za-z0-9_]{1,25}/<SYM>/' \

        -e 's/([-,+])[0-9A-F]{2,16}/\1<HEXSTR>/g' \

        -e 's/\[[0-9A-F]{4,16}h\]/[<HEXSTR>]/' \

        -e 's/: ([a-z]{2}[a-z ]{2})        [0-9A-F]{2,16}h?$/: \1        <HEXSTR>/' \

        -e 's/_20[0-9]{2}_[0-1][0-9]_[0-9]{2}/_<DATE>/' \

        "

  elif [ "$OPENJDK_TARGET_CPU" = "x86_64" ]; then

    DIS_DIFF_FILTER="$SED -r \

        -e 's/^  [0-9A-F]{16}: //' \

        -e 's/\[[0-9A-F]{4,16}h\]/[<HEXSTR>]/' \

        -e 's/([,+])[0-9A-F]{2,16}h/\1<HEXSTR>/' \

        -e 's/([a-z]{2}[a-z ]{2})        [0-9A-F]{4,16}$/\1        <HEXSTR>/' \

        -e 's/\[\?\?_C@_.*/[<SYM>]/' \

        "

  fi

elif [ "$OPENJDK_TARGET_OS" = "macosx" ]; then

  DIS_DIFF_FILTER="LANG=C $SED \

      -e 's/0x[0-9a-f]\{3,16\}/<HEXSTR>/g' -e 's/^[0-9a-f]\{12,20\}/<ADDR>/' \

      -e 's/-20[0-9][0-9]-[0-1][0-9]-[0-3][0-9]-[0-2][0-9]\{5\}/<DATE>/g' \

      -e 's/), built on .*/), <DATE>/' \

      "

fi

################################################################################

# Compare text files and ignore specific differences:

#

#  * Timestamps in Java sources generated by idl2java

#  * Sorting order and cleanup style in .properties files

diff_text() {

    OTHER_FILE=$1

    THIS_FILE=$2

    SUFFIX="${THIS_FILE##*.}"

    NAME="${THIS_FILE##*/}"

    TMP=1

    if [[ "$THIS_FILE" = *"META-INF/MANIFEST.MF" ]]; then

        # Filter out date string, ant version and java version differences.

        TMP=$(LC_ALL=C $DIFF $OTHER_FILE $THIS_FILE | \

            $GREP '^[<>]' | \

            $SED -e '/[<>] Ant-Version: Apache Ant .*/d' \

                 -e '/[<>] Created-By: .* (Oracle [Corpatin)]*/d' \

                 -e '/[<>]  [Corpatin]*)/d' \

                 -e '/[<>].*[0-9]\{4\}_[0-9]\{2\}_[0-9]\{2\}_[0-9]\{2\}_[0-9]\{2\}-b[0-9]\{2\}.*/d')

    fi

    if test "x$SUFFIX" = "xjava"; then

        TMP=$(LC_ALL=C $DIFF $OTHER_FILE $THIS_FILE | \

            $GREP '^[<>]' | \

            $SED -e '/[<>] \* from.*\.idl/d' \

                 -e '/[<>] .*[0-9]\{4\}_[0-9]\{2\}_[0-9]\{2\}_[0-9]\{2\}_[0-9]\{2\}-b[0-9]\{2\}.*/d' \

                 -e '/[<>] .*[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}-[0-9]\{6\}.*/d' \

                 -e '/[<>] \*.*[0-9]\{4\} \(at \)*[0-9][0-9]*:[0-9]\{2\}:[0-9]\{2\}.*/d' \

                 -e '/\/\/ Generated from input file.*/d' \

                 -e '/\/\/ This file was generated AUTOMATICALLY from a template file.*/d' \

                 -e '/\/\/ java GenerateCharacter.*/d')

    fi

    # Ignore date strings in class files.

    # Anonymous lambda classes get randomly assigned counters in their names.

    if test "x$SUFFIX" = "xclass"; then

        if [ "$NAME" = "SystemModules\$all.class" ] \

           || [ "$NAME" = "SystemModules\$default.class" ]; then

            # The SystemModules\$*.classes are not comparable as they contain the

            # module hashes which would require a whole other level of

            # reproducible builds to get reproducible. There is also random

            # order of map initialization.

            TMP=""

        elif [ "$NAME" = "module-info.class" ]; then

            # The module-info.class have several issues with random ordering of

            # elements in HashSets.

            MODULES_CLASS_FILTER="$SED \

                -e 's/,$//' \

                -e 's/;$//' \

                -e 's/^ *[0-9]*://' \

                -e 's/#[0-9]* */#/' \

                -e 's/ *\/\// \/\//' \

                -e 's/aload *[0-9]*/aload X/' \

                -e 's/ldc_w/ldc  /' \

                | $SORT \

                "

            $JAVAP -c -constants -l -p "${OTHER_FILE}" \

                | eval "$MODULES_CLASS_FILTER" >  ${OTHER_FILE}.javap &

            $JAVAP -c -constants -l -p "${THIS_FILE}" \

                | eval "$MODULES_CLASS_FILTER" > ${THIS_FILE}.javap &

            wait

            TMP=$($DIFF ${OTHER_FILE}.javap ${THIS_FILE}.javap)

        # To improve performance when large diffs are found, do a rough filtering of classes

        # elibeble for these exceptions

        elif $GREP -R -e '[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}-[0-9]\{6\}' \

                -e 'lambda\$[a-zA-Z0-9]*\$[0-9]' ${THIS_FILE} > /dev/null

        then

            $JAVAP -c -constants -l -p "${OTHER_FILE}" >  ${OTHER_FILE}.javap &

            $JAVAP -c -constants -l -p "${THIS_FILE}" > ${THIS_FILE}.javap &

            wait

            TMP=$($DIFF ${OTHER_FILE}.javap ${THIS_FILE}.javap | \

                $GREP '^[<>]' | \

                $SED -e '/[<>].*[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}-[0-9]\{6\}.*/d' \

                     -e '/[<>].*lambda\$[a-zA-Z0-9]*\$[0-9]*/d')

        fi

    fi

    if test "x$SUFFIX" = "xproperties"; then

        # Filter out date string differences.

        TMP=$(LC_ALL=C $DIFF $OTHER_FILE $THIS_FILE | \

            $GREP '^[<>]' | \

            $SED -e '/[<>].*[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}-[0-9]\{6\}.*/d')

    fi

    if test "x$SUFFIX" = "xhtml"; then

        # Some javadoc versions do not put quotes around font size

        HTML_FILTER="$SED \

            -e 's/<font size=-1>/<font size=\"-1\">/g'"

        $CAT $THIS_FILE | eval "$HTML_FILTER" > $THIS_FILE.filtered

        $CAT $OTHER_FILE | eval "$HTML_FILTER" > $OTHER_FILE.filtered

        TMP=$(LC_ALL=C $DIFF $OTHER_FILE.filtered $THIS_FILE.filtered | \

            $GREP '^[<>]' | \

            $SED -e '/[<>] <!-- Generated by javadoc .* on .* -->/d' \

                 -e '/[<>] <meta name="date" content=".*">/d' )

    fi

    if test "$NAME" = "BenchmarkList"; then

        $SORT $THIS_FILE > $THIS_FILE.sorted

        $SORT $OTHER_FILE > $OTHER_FILE.sorted

        TMP=$($DIFF $THIS_FILE.sorted $OTHER_FILE.sorted)

    fi

    if test -n "$TMP"; then

        echo Files $OTHER_FILE and $THIS_FILE differ

        return 1

    fi

    return 0

}

################################################################################

# Compare directory structure

compare_dirs() {

    THIS_DIR=$1

    OTHER_DIR=$2

    WORK_DIR=$3

    mkdir -p $WORK_DIR

    (cd $OTHER_DIR && $FIND . -type d | $SORT > $WORK_DIR/dirs_other)

    (cd $THIS_DIR && $FIND . -type d | $SORT > $WORK_DIR/dirs_this)

    $DIFF $WORK_DIR/dirs_other $WORK_DIR/dirs_this > $WORK_DIR/dirs_diff

    echo -n Directory structure...

    if [ -s $WORK_DIR/dirs_diff ]; then

        echo Differences found.

        REGRESSIONS=true

        # Differences in directories found.

        ONLY_OTHER=$($GREP '<' $WORK_DIR/dirs_diff)

        if [ "$ONLY_OTHER" ]; then

            echo Only in $OTHER

            $GREP '<' $WORK_DIR/dirs_diff | $SED 's|< ./|    |g'

        fi

        ONLY_THIS=$($GREP '>' $WORK_DIR/dirs_diff)

        if [ "$ONLY_THIS" ]; then

            echo Only in $THIS

            $GREP '>' $WORK_DIR/dirs_diff | $SED 's|> ./|    |g'

        fi

    else

        echo Identical!

    fi

}

################################################################################

# Compare file structure

compare_files() {

    THIS_DIR=$1

    OTHER_DIR=$2

    WORK_DIR=$3

    $MKDIR -p $WORK_DIR

    (cd $OTHER_DIR && $FIND . ! -type d | $SORT > $WORK_DIR/files_other)

    (cd $THIS_DIR && $FIND . ! -type d | $SORT > $WORK_DIR/files_this)

    $DIFF $WORK_DIR/files_other $WORK_DIR/files_this > $WORK_DIR/files_diff

    echo -n File names...

    if [ -s $WORK_DIR/files_diff ]; then

        echo Differences found.

        REGRESSIONS=true

        # Differences in files found.

        ONLY_OTHER=$($GREP '<' $WORK_DIR/files_diff)

        if [ "$ONLY_OTHER" ]; then

            echo Only in $OTHER

            $GREP '<' $WORK_DIR/files_diff | $SED 's|< ./|    |g'

        fi

        ONLY_THIS=$($GREP '>' $WORK_DIR/files_diff)

        if [ "$ONLY_THIS" ]; then

            echo Only in $THIS

            $GREP '>' $WORK_DIR/files_diff | $SED 's|> ./|    |g'

        fi

    else

        echo Identical!

    fi

}

################################################################################

# Compare permissions

compare_permissions() {

    THIS_DIR=$1

    OTHER_DIR=$2

    WORK_DIR=$3

    mkdir -p $WORK_DIR

    echo -n Permissions...

    found=""

    for f in `cd $OTHER_DIR && $FIND . -type f`

    do

        if [ ! -f ${OTHER_DIR}/$f ]; then continue; fi

        if [ ! -f ${THIS_DIR}/$f ]; then continue; fi

        OP=`ls -l ${OTHER_DIR}/$f | awk '{printf("%.10s\n", $1);}'`

        TP=`ls -l ${THIS_DIR}/$f | awk '{printf("%.10s\n", $1);}'`

        if [ "$OP" != "$TP" ]

        then

            if [ -z "$found" ]; then echo ; found="yes"; fi

            $PRINTF "\tother: ${OP} this: ${TP}\t$f\n"

        fi

    done

    if [ -z "$found" ]; then

        echo "Identical!"

    else

        REGRESSIONS=true

    fi

}

################################################################################

# Compare file command output

compare_file_types() {

    THIS_DIR=$1

    OTHER_DIR=$2

    WORK_DIR=$3

    $MKDIR -p $WORK_DIR

    FILE_TYPES_FILTER="$SED \

        -e 's/BuildID[^,]*//' \

        -e 's/last modified: .*//' \

        "

    echo -n File types...

    found=""

    # The file command does not know about jmod files and this sometimes results

    # in different types being detected more or less randomly.

    for f in $(cd $OTHER_DIR && $FIND . ! -type d -a ! -name "*.jmod")

    do

        if [ ! -f ${OTHER_DIR}/$f ]; then continue; fi

        if [ ! -f ${THIS_DIR}/$f ]; then continue; fi

        OF=$(cd ${OTHER_DIR} && $FILE -h $f | eval $FILE_TYPES_FILTER)

        TF=$(cd ${THIS_DIR} && $FILE -h $f | eval $FILE_TYPES_FILTER)

        if [ "$OF" != "$TF" ]

        then

            if [ "`echo $OF | $GREP -c 'Zip archive data'`" -gt 0 ] \

                && [ "`echo $TF | $GREP -c 'Zip archive data'`" -gt 0 ]

            then

                # the way we produce zip-files make it so that directories are stored in

                # old file but not in new (only files with full-path) this makes file

                # report them as different

                continue

            else

                if [ -z "$found" ]; then echo ; found="yes"; fi

                $PRINTF "\tother: ${OF}\n\tthis : ${TF}\n"

            fi

        fi

    done

    if [ -z "$found" ]; then

        echo "Identical!"

    else

        REGRESSIONS=true

    fi

}

################################################################################

# Compare the rest of the files

compare_general_files() {

    THIS_DIR=$1

    OTHER_DIR=$2

    WORK_DIR=$3

    GENERAL_FILES=$(cd $THIS_DIR && $FIND . -type f ! -name "*.so" ! -name "*.jar" \

        ! -name "*.zip" ! -name "*.debuginfo" ! -name "*.dylib" ! -name "jexec" \

        ! -name "modules" ! -name "ct.sym" ! -name "*.diz" ! -name "*.dll" \

        ! -name "*.cpl" ! -name "*.pdb" ! -name "*.exp" ! -name "*.ilk" \

        ! -name "*.lib" ! -name "*.war" ! -name "*.jmod" ! -name "*.exe" \

        ! -name "*.obj" ! -name "*.o" ! -name "jspawnhelper" ! -name "*.a" \

        ! -name "*.tar.gz" ! -name "classes.jsa" ! -name "gtestLauncher" \

        ! -name "*.map" \

        | $GREP -v "./bin/"  | $SORT | $FILTER)

    echo Other files with binary differences...

    for f in $GENERAL_FILES

    do

        # Skip all files in test/*/native

        if [[ "$f" == */native/* ]]; then

            continue

        fi

        if [ -e $OTHER_DIR/$f ]; then

            SUFFIX="${f##*.}"

            if [ "$(basename $f)" = "release" ]; then

                # In release file, ignore differences in change numbers and order

                # of modules in list.

                OTHER_FILE=$WORK_DIR/$f.other

                THIS_FILE=$WORK_DIR/$f.this

                $MKDIR -p $(dirname $OTHER_FILE)

                $MKDIR -p $(dirname $THIS_FILE)

                RELEASE_FILTER="$SED \

                    -e 's/\:[0-9a-f]\{12,12\}/:CHANGE/g' \

                    -e 's/[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}-[0-9]\{6\}/<DATE>/g' \

                    -e 's/^#.*/#COMMENT/g' \

                    -e 's/MODULES=/MODULES=\'$'\n/' \

                    -e 's/,/\'$'\n/g' \

                    | $SORT

                    "

                $CAT $OTHER_DIR/$f | eval "$RELEASE_FILTER" > $OTHER_FILE

                $CAT $THIS_DIR/$f  | eval "$RELEASE_FILTER" > $THIS_FILE

            elif [ "x$SUFFIX" = "xhtml" ]; then

                # Ignore time stamps in docs files

                OTHER_FILE=$WORK_DIR/$f.other

                THIS_FILE=$WORK_DIR/$f.this

                $MKDIR -p $(dirname $OTHER_FILE) $(dirname $THIS_FILE)

                # Older versions of compare might have left soft links with

                # these names.

                $RM $OTHER_FILE $THIS_FILE

                #Note that | doesn't work on mac sed.

                HTML_FILTER="$SED \

                    -e 's/20[0-9]\{2\}-[0-9]\{2\}-[0-9]\{2\}-[0-9]\{6,7\}/<DATE>/g' \

                    -e 's/20[0-9]\{2\}-[0-9]\{2\}-[0-9]\{2\}/<DATE>/g' \

                    -e 's/\(-- Generated by javadoc \).*\( --\)/\1(removed)\2/' \

                    -e 's/[A-Z][a-z]*, [A-Z][a-z]* [0-9][0-9]*, [0-9]\{4\} [0-9][0-9:]* [AMP]\{2,2\} [A-Z][A-Z]*/<DATE>/' \

                    -e 's/from .*\.idl/\.idl/' \

                    "

                $CAT $OTHER_DIR/$f | eval "$HTML_FILTER" > $OTHER_FILE &

                $CAT $THIS_DIR/$f  | eval "$HTML_FILTER" > $THIS_FILE &

                wait

            elif [[ "$f" = *"/lib/classlist" ]] || [ "$SUFFIX" = "jar_contents" ]; then

                # The classlist files may have some lines in random order

                OTHER_FILE=$WORK_DIR/$f.other

                THIS_FILE=$WORK_DIR/$f.this

                $MKDIR -p $(dirname $OTHER_FILE) $(dirname $THIS_FILE)

                $RM $OTHER_FILE $THIS_FILE

                $CAT $OTHER_DIR/$f | $SORT > $OTHER_FILE

                $CAT $THIS_DIR/$f  | $SORT > $THIS_FILE

            else

                OTHER_FILE=$OTHER_DIR/$f

                THIS_FILE=$THIS_DIR/$f

            fi

            DIFF_OUT=$($DIFF $OTHER_FILE $THIS_FILE 2>&1)

            if [ -n "$DIFF_OUT" ]; then

                echo $f

                REGRESSIONS=true

                if [ "$SHOW_DIFFS" = "true" ]; then

                    echo "$DIFF_OUT"

                fi

            fi

        fi

    done

}

################################################################################

# Compare zip file

compare_zip_file() {

    THIS_DIR=$1

    OTHER_DIR=$2

    WORK_DIR=$3

    ZIP_FILE=$4

    # Optionally provide different name for other zipfile

    OTHER_ZIP_FILE=$5

    THIS_ZIP=$THIS_DIR/$ZIP_FILE

    if [ -n "$OTHER_ZIP_FILE" ]; then

        OTHER_ZIP=$OTHER_DIR/$OTHER_ZIP_FILE

    else

        OTHER_ZIP=$OTHER_DIR/$ZIP_FILE

    fi

    THIS_SUFFIX="${THIS_ZIP##*.}"

    OTHER_SUFFIX="${OTHER_ZIP##*.}"

    if [ "$THIS_SUFFIX" != "$OTHER_SUFFIX" ]; then

        echo "The files do not have the same suffix type! ($THIS_SUFFIX != $OTHER_SUFFIX)"

        return 2

    fi

    TYPE="$THIS_SUFFIX"

    if $CMP $OTHER_ZIP $THIS_ZIP > /dev/null

    then

        return 0

    fi

    # Not quite identical, the might still contain the same data.