506f51cc0d
When a change makes really hard to keep ABI compatibility, instead of waiting next release to break the ABI, it is smoother to introduce the new code as a preview and disable it when packaging. The flag RTE_NEXT_ABI must be used to "ifdef" the new code. When the release is out, a dynamically linked application can use the new shared libraries with the old ABI while developpers can prepare their application for the next ABI by reading the deprecation notice and easily testing the new code. When starting the next release cycle, the "ifdefs" will be removed and the ABI break will be marked by incrementing LIBABIVER. The map files will also be updated. The default value is enabled to be developer compliant. The packagers must disable it as done in pkg/dpdk.spec. When enabled, all shared library numbers are incremented by appending a minor .1 to the old ABI number. In the next release, only impacted libraries will have a major +1 increment. The impacted libraries must provide an alternative map file to use with this option. The ABI policy is updated. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Neil Horman <nhorman@tuxdriver.com>
246 lines
6.0 KiB
Bash
Executable File
246 lines
6.0 KiB
Bash
Executable File
#!/bin/sh
|
|
# BSD LICENSE
|
|
#
|
|
# Copyright(c) 2015 Neil Horman. All rights reserved.
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions
|
|
# are met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above copyright
|
|
# notice, this list of conditions and the following disclaimer in
|
|
# the documentation and/or other materials provided with the
|
|
# distribution.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
TAG1=$1
|
|
TAG2=$2
|
|
TARGET=$3
|
|
ABI_DIR=`mktemp -d -p /tmp ABI.XXXXXX`
|
|
|
|
usage() {
|
|
echo "$0 <TAG1> <TAG2> <TARGET>"
|
|
}
|
|
|
|
log() {
|
|
local level=$1
|
|
shift
|
|
echo "$*"
|
|
}
|
|
|
|
validate_tags() {
|
|
git tag -l | grep -q "$TAG1"
|
|
if [ $? -ne 0 ]
|
|
then
|
|
echo "$TAG1 is invalid"
|
|
return
|
|
fi
|
|
git tag -l | grep -q "$TAG2"
|
|
if [ $? -ne 0 ]
|
|
then
|
|
echo "$TAG2 is invalid"
|
|
return
|
|
fi
|
|
}
|
|
|
|
validate_args() {
|
|
if [ -z "$TAG1" ]
|
|
then
|
|
echo "Must Specify TAG1"
|
|
return
|
|
fi
|
|
if [ -z "$TAG2" ]
|
|
then
|
|
echo "Must Specify TAG2"
|
|
return
|
|
fi
|
|
if [ -z "$TARGET" ]
|
|
then
|
|
echo "Must Specify a build target"
|
|
fi
|
|
}
|
|
|
|
|
|
cleanup_and_exit() {
|
|
rm -rf $ABI_DIR
|
|
git checkout $CURRENT_BRANCH
|
|
exit $1
|
|
}
|
|
|
|
###########################################
|
|
#START
|
|
############################################
|
|
|
|
#trap on ctrl-c to clean up
|
|
trap cleanup_and_exit SIGINT
|
|
|
|
#Save the current branch
|
|
CURRENT_BRANCH=`git branch | grep \* | cut -d' ' -f2`
|
|
|
|
if [ -z "$CURRENT_BRANCH" ]
|
|
then
|
|
CURRENT_BRANCH=`git log --pretty=format:%H HEAD~1..HEAD`
|
|
fi
|
|
|
|
if [ -n "$VERBOSE" ]
|
|
then
|
|
export VERBOSE=/dev/stdout
|
|
else
|
|
export VERBOSE=/dev/null
|
|
fi
|
|
|
|
# Validate that we have all the arguments we need
|
|
res=$(validate_args)
|
|
if [ -n "$res" ]
|
|
then
|
|
echo $res
|
|
usage
|
|
cleanup_and_exit 1
|
|
fi
|
|
|
|
# Make sure our tags exist
|
|
res=$(validate_tags)
|
|
if [ -n "$res" ]
|
|
then
|
|
echo $res
|
|
cleanup_and_exit 1
|
|
fi
|
|
|
|
ABICHECK=`which abi-compliance-checker 2>/dev/null`
|
|
if [ $? -ne 0 ]
|
|
then
|
|
log "INFO" "Cant find abi-compliance-checker utility"
|
|
cleanup_and_exit 1
|
|
fi
|
|
|
|
ABIDUMP=`which abi-dumper 2>/dev/null`
|
|
if [ $? -ne 0 ]
|
|
then
|
|
log "INFO" "Cant find abi-dumper utility"
|
|
cleanup_and_exit 1
|
|
fi
|
|
|
|
log "INFO" "We're going to check and make sure that applications built"
|
|
log "INFO" "against DPDK DSOs from tag $TAG1 will still run when executed"
|
|
log "INFO" "against DPDK DSOs built from tag $TAG2."
|
|
log "INFO" ""
|
|
|
|
# Check to make sure we have a clean tree
|
|
git status | grep -q clean
|
|
if [ $? -ne 0 ]
|
|
then
|
|
log "WARN" "Working directory not clean, aborting"
|
|
cleanup_and_exit 1
|
|
fi
|
|
|
|
# Move to the root of the git tree
|
|
cd $(dirname $0)/..
|
|
|
|
log "INFO" "Checking out version $TAG1 of the dpdk"
|
|
# Move to the old version of the tree
|
|
git checkout $TAG1
|
|
|
|
# Make sure we configure SHARED libraries
|
|
# Also turn off IGB and KNI as those require kernel headers to build
|
|
sed -i -e"$ a\CONFIG_RTE_BUILD_SHARED_LIB=y" config/defconfig_$TARGET
|
|
sed -i -e"$ a\CONFIG_RTE_NEXT_ABI=n" config/defconfig_$TARGET
|
|
sed -i -e"$ a\CONFIG_RTE_EAL_IGB_UIO=n" config/defconfig_$TARGET
|
|
sed -i -e"$ a\CONFIG_RTE_LIBRTE_KNI=n" config/defconfig_$TARGET
|
|
|
|
# Checking abi compliance relies on using the dwarf information in
|
|
# The shared objects. Thats only included in the DSO's if we build
|
|
# with -g
|
|
export EXTRA_CFLAGS=-g
|
|
export EXTRA_LDFLAGS=-g
|
|
|
|
# Now configure the build
|
|
log "INFO" "Configuring DPDK $TAG1"
|
|
make config T=$TARGET O=$TARGET > $VERBOSE 2>&1
|
|
|
|
log "INFO" "Building DPDK $TAG1. This might take a moment"
|
|
make O=$TARGET > $VERBOSE 2>&1
|
|
|
|
if [ $? -ne 0 ]
|
|
then
|
|
log "INFO" "THE BUILD FAILED. ABORTING"
|
|
cleanup_and_exit 1
|
|
fi
|
|
|
|
# Move to the lib directory
|
|
cd $TARGET/lib
|
|
log "INFO" "COLLECTING ABI INFORMATION FOR $TAG1"
|
|
for i in `ls *.so`
|
|
do
|
|
$ABIDUMP $i -o $ABI_DIR/$i-ABI-0.dump -lver $TAG1
|
|
done
|
|
cd ../..
|
|
|
|
# Now clean the tree, checkout the second tag, and rebuild
|
|
git clean -f -d
|
|
git reset --hard
|
|
# Move to the new version of the tree
|
|
log "INFO" "Checking out version $TAG2 of the dpdk"
|
|
git checkout $TAG2
|
|
|
|
# Make sure we configure SHARED libraries
|
|
# Also turn off IGB and KNI as those require kernel headers to build
|
|
sed -i -e"$ a\CONFIG_RTE_BUILD_SHARED_LIB=y" config/defconfig_$TARGET
|
|
sed -i -e"$ a\CONFIG_RTE_NEXT_ABI=n" config/defconfig_$TARGET
|
|
sed -i -e"$ a\CONFIG_RTE_EAL_IGB_UIO=n" config/defconfig_$TARGET
|
|
sed -i -e"$ a\CONFIG_RTE_LIBRTE_KNI=n" config/defconfig_$TARGET
|
|
|
|
# Now configure the build
|
|
log "INFO" "Configuring DPDK $TAG2"
|
|
make config T=$TARGET O=$TARGET > $VERBOSE 2>&1
|
|
|
|
log "INFO" "Building DPDK $TAG2. This might take a moment"
|
|
make O=$TARGET > $VERBOSE 2>&1
|
|
|
|
if [ $? -ne 0 ]
|
|
then
|
|
log "INFO" "THE BUILD FAILED. ABORTING"
|
|
cleanup_and_exit 1
|
|
fi
|
|
|
|
cd $TARGET/lib
|
|
log "INFO" "COLLECTING ABI INFORMATION FOR $TAG2"
|
|
for i in `ls *.so`
|
|
do
|
|
$ABIDUMP $i -o $ABI_DIR/$i-ABI-1.dump -lver $TAG2
|
|
done
|
|
cd ../..
|
|
|
|
# Start comparison of ABI dumps
|
|
for i in `ls $ABI_DIR/*-1.dump`
|
|
do
|
|
NEWNAME=`basename $i`
|
|
OLDNAME=`basename $i | sed -e"s/1.dump/0.dump/"`
|
|
LIBNAME=`basename $i | sed -e"s/-ABI-1.dump//"`
|
|
|
|
if [ ! -f $ABI_DIR/$OLDNAME ]
|
|
then
|
|
log "INFO" "$OLDNAME DOES NOT EXIST IN $TAG1. SKIPPING..."
|
|
fi
|
|
|
|
#compare the abi dumps
|
|
$ABICHECK -l $LIBNAME -old $ABI_DIR/$OLDNAME -new $ABI_DIR/$NEWNAME
|
|
done
|
|
|
|
git reset --hard
|
|
log "INFO" "ABI CHECK COMPLETE. REPORTS ARE IN compat_report directory"
|
|
cleanup_and_exit 0
|