diff options
Diffstat (limited to 'contrib/reghunt/date_based')
| -rw-r--r-- | contrib/reghunt/date_based/README | 16 | ||||
| -rwxr-xr-x | contrib/reghunt/date_based/reg_periodic | 171 | ||||
| -rwxr-xr-x | contrib/reghunt/date_based/reg_search | 300 | ||||
| -rwxr-xr-x | contrib/reghunt/date_based/reg_test_template | 41 |
4 files changed, 528 insertions, 0 deletions
diff --git a/contrib/reghunt/date_based/README b/contrib/reghunt/date_based/README new file mode 100644 index 000000000..c674ffc6c --- /dev/null +++ b/contrib/reghunt/date_based/README @@ -0,0 +1,16 @@ +This directory contains scripts that are used for identifying the +patch that introduced a regression. General information about such +searches is covered in http://gcc.gnu.org/bugs/reghunt.html. + + reg_search searches for a small time interval within a range of + dates in which results for a test changed, using a binary search. + The functionality for getting sources, building the component to + test, and running the test are in other scripts that are run from + here. + + reg_periodic invokes separate tools (the same scripts invoked by + reg_search) over a range of dates at specified intervals. + + reg_test_template shows the format for the script that runs a test + and determines whether to continue the search with a later or + earlier date. diff --git a/contrib/reghunt/date_based/reg_periodic b/contrib/reghunt/date_based/reg_periodic new file mode 100755 index 000000000..a77567d4d --- /dev/null +++ b/contrib/reghunt/date_based/reg_periodic @@ -0,0 +1,171 @@ +#! /bin/bash + +######################################################################## +# +# File: reg_periodic +# Author: Janis Johnson +# Date: 2002/12/28 +# +# Over a range of dates at specified intervals, invoke separate tools to +# update sources, do a build, and run one or more tests. +# +# Define these in a file whose name is the argument to this script: +# LOW_DATE: Date string recognized by the date command. +# HIGH_DATE: Date string recognized by the date command. +# INTERVAL: Time (in seconds) between dates for which to build. +# REG_UPDATE: Pathname of script to update your source tree. +# REG_BUILD: Pathname of script to build enough of the product to run +# the test. +# REG_TEST: Pathname of script to run one or more tests. +# Optional: +# VERBOSITY: Default is 0, to print only errors and final message. +# DATE_IN_MSG If set to anything but 0, include the time and date in +# messages +# REG_STOP Pathname of a file whose existence says to quit; default +# is STOP in the current directory. +# +# +# Copyright (c) 2002, 2003, 2005, 2009, 2010 Free Software Foundation, Inc. +# +# This file is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; see the file COPYING3. If not see +# <http://www.gnu.org/licenses/>. +# +######################################################################## + +######################################################################## +# Functions +######################################################################## + +# Issue a message if its verbosity level is high enough. + +msg() { + test ${1} -gt ${VERBOSITY} && return + + if [ "x${DATE_IN_MSG}" = "x" ]; then + echo "${2}" + else + echo "`${DATE}` ${2}" + fi +} + +# Issue an error message and exit with a nonzero status. + +error() { + msg 0 "error: ${1}" + exit 1 +} + +# Turn seconds since the epoch into a date we can use with source +# control tools and report to the user. + +make_date() { + MADE_DATE=`${DATE} -u +"%Y-%m-%d %H:%M %Z" --date "1970-01-01 ${1} seconds"` \ + || error "make_date: date command failed" +} + +# Build the components to test using sources as of a particular date and +# run a test case. Pass each of the scripts the date that we're +# testing; the first one needs it, the others can ignore it if they want. + +process_date() { + TEST_DATE="${1}" + + ${REG_UPDATE} "${TEST_DATE}" + if [ $? -ne 0 ]; then + msg 0 "source update failed for ${TEST_DATE}" + return + fi + ${REG_BUILD} "${TEST_DATE}" + if [ $? -ne 0 ]; then + msg 0 "build failed for ${TEST_DATE}" + return + fi + ${REG_TEST} "${TEST_DATE}" +} + +######################################################################## +# Main program (so to speak) +######################################################################## + +# If DATE isn't defined, use the default date command; the configuration +# file can override this. + +if [ "x${DATE}" = "x" ]; then + DATE=date +fi + +# Process the configuration file. + +if [ $# -ne 1 ]; then + echo Usage: $0 config_file + exit 1 +fi + +CONFIG=${1} +if [ ! -f ${CONFIG} ]; then + error "configuration file ${CONFIG} does not exist" +fi + +# OK, the config file exists. Source it, make sure required parameters +# are defined and their files exist, and give default values to optional +# parameters. + +. ${CONFIG} + +test "x${REG_UPDATE}" = "x" && error "REG_UPDATE is not defined" +test "x${REG_BUILD}" = "x" && error "REG_BUILD is not defined" +test "x${REG_TEST}" = "x" && error "REG_TEST is not defined" +test "x${INTERVAL}" = "x" && error "INTERVAL is not defined" +test -x ${REG_TEST} || error "REG_TEST is not an executable file" +test "x${VERBOSITY}" = "x" && VERBOSITY=0 +test "x${REG_STOP}" = "x" && REG_STOP="STOP" + +msg 2 "LOW_DATE = ${LOW_DATE}" +msg 2 "HIGH_DATE = ${HIGH_DATE}" +msg 2 "INTERVAL = ${INTERVAL}" +msg 2 "REG_UPDATE = ${REG_UPDATE}" +msg 2 "REG_BUILD = ${REG_BUILD}" +msg 2 "REG_TEST = ${REG_TEST}" +msg 2 "VERBOSITY = ${VERBOSITY}" + +# Change the dates into seconds since the epoch. This uses an extension +# in GNU date. + +LOW_DATE=`${DATE} +%s --date "${LOW_DATE}"` || \ + error "date command failed for \"${LOW_DATE}\"" +HIGH_DATE=`${DATE} +%s --date "${HIGH_DATE}"` || \ + error "date command failed for \"${LOW_DATE}\"" + +# Process each date in the range. + +while [ ${LOW_DATE} -le ${HIGH_DATE} ]; do + + # If a file called STOP appears, stop; this allows a clean way to + # interrupt a search. + + if [ -f ${REG_STOP} ]; then + msg 0 "STOP file detected" + rm -f ${REG_STOP} + exit 1 + fi + + # Get a version of the date that is usable by tools and readable + # by people, then process it. + + make_date ${LOW_DATE} + process_date "${MADE_DATE}" + let LOW_DATE=LOW_DATE+INTERVAL +done + +msg 1 "done" diff --git a/contrib/reghunt/date_based/reg_search b/contrib/reghunt/date_based/reg_search new file mode 100755 index 000000000..46602054d --- /dev/null +++ b/contrib/reghunt/date_based/reg_search @@ -0,0 +1,300 @@ +#! /bin/bash + +######################################################################## +# +# File: reg_search +# Author: Janis Johnson <janis187@us.ibm.com> +# Date: 2002/12/15 +# +# Search for a small time interval within a range of dates in which +# results for a test changed, using a binary search. The functionality +# for getting sources, building the component to test, and running the +# test are in other scripts that are run from here. Before the search +# begins, we verify that we get the expected behavior for the first and +# last dates. +# +# Define these in a file whose name is the argument to this script: +# LOW_DATE: Date string recognized by the date command (local time). +# HIGH_DATE: Date string recognized by the date command (local time). +# REG_UPDATE: Pathname of script to update your source tree; returns +# zero for success, nonzero for failure. +# REG_BUILD: Pathname of script to build enough of the product to run +# the test; returns zero for success, nonzero for failure. +# REG_TEST: Pathname of script to run the test; returns 1 if we +# should search later dates, 0 if we should search earlier +# dates. +# Optional: +# DELTA: Search to an interval within this many seconds; default +# is one hour (although 300 works well). +# REG_FINISH Pathname of script to call at the end with the two final +# dates as arguments. +# SKIP_LOW If 1, skip verifying the low date of the range; +# define this only if you're restarting and have already +# tested the low date. +# SKIP_HIGH If 1, skip verifying the high date of the range; +# define this only if you're restarting and have already +# tested the high date. +# FIRST_MID Use this as the first midpoint, to avoid a midpoint that +# is known not to build. +# HAS_CHANGES Pathname of script to report whether the current date has +# no differences from one of the ends of the current range +# to skip unnecessary build and testing; default is "true". +# VERBOSITY Default is 0, to print only errors and final message. +# DATE_IN_MSG If set to anything but 0, include the time and date in +# messages. +# +# +# +# Copyright (c) 2002, 2003, 2005, 2009, 2010 Free Software Foundation, Inc. +# +# This file is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; see the file COPYING3. If not see +# <http://www.gnu.org/licenses/>. +# +######################################################################## + +######################################################################## +# Functions +######################################################################## + +# Issue a message if its verbosity level is high enough. + +msg() { + test ${1} -gt ${VERBOSITY} && return + + if [ "x${DATE_IN_MSG}" = "x" ]; then + echo "${2}" + else + echo "`${DATE}` ${2}" + fi +} + +# Issue an error message and exit with a non-zero status. If there +# is a valid current range whose end points have been tested, report +# it so the user can start again from there. + +error() { + msg 0 "error: ${1}" + test ${VALID_RANGE} -eq 1 && \ + echo "current range:" + echo "LOW_DATE=\"${LATER_THAN}\"" + echo "HIGH_DATE=\"${EARLIER_THAN}\"" + exit 1 +} + +# Turn seconds since the epoch into a date we can use with source +# control tools and report to the user. + +make_date() { + MADE_DATE=`${DATE} -u +"%Y-%m-%d %H:%M %Z" --date "1970-01-01 ${1} seconds"` \ + || error "make_date: date command failed" +} + +# Build the components to test using sources as of a particular date and +# run a test case. Pass each of the scripts the date that we're +# testing; the first one needs it, the others can ignore it if they want. + +process_date() { + TEST_DATE="${1}" + + ${REG_UPDATE} "${TEST_DATE}" || error "source update failed for ${TEST_DATE}" + + # If we're already in a valid range, skip this date if there are no + # differences from either end of the range and adjust LATER. + + if [ ${VALID_RANGE} = 1 ]; then + ${HAS_CHANGES} "${TEST_DATE}" "${LATER_THAN}" "${EARLIER_THAN}" + RET=$? + case ${RET} in + 0) ;; + 1) LATER=1; return;; + 2) LATER=0; return;; + *) error "process_date: unexpected return value from ${HAS_CHANGES}";; + esac + fi + + ${REG_BUILD} "${TEST_DATE}" || error "build failed for ${TEST_DATE}" + ${REG_TEST} "${TEST_DATE}" + LATER=$? +} + +# Perform a binary search on dates within the range specified by +# the arguments, bounded by the number of seconds in DELTA. + +search_dates() { + let LOW=$1 + let HIGH=$2 + let DIFF=HIGH-LOW + + # Get the date in the middle of the range; MID is in seconds since + # the epoch, DATE is readable by humans and tools. The user can + # override the initial mid date if it is known to have problems, + # e.g., if a build fails for that date. + + if [ ${FIRST_MID} -ne 0 ]; then + let MID=${FIRST_MID} + else + let MID=LOW/2+HIGH/2 + fi + + while [ ${DIFF} -ge ${DELTA} ]; do + make_date ${MID} + TEST_DATE="${MADE_DATE}" + + # Test it. + + process_date "${TEST_DATE}" + + # Narrow the search based on the outcome of testing DATE. + + if [ ${LATER} -eq 1 ]; then + msg 1 "search dates later than \"${TEST_DATE}\"" + LATER_THAN="${TEST_DATE}" + let LOW=MID + else + msg 1 "search dates earlier than \"${TEST_DATE}\"" + EARLIER_THAN="${TEST_DATE}" + let HIGH=MID + fi + + let DIFF=HIGH-LOW + let MID=LOW/2+HIGH/2 + done +} + +######################################################################## +# Main program (so to speak) +######################################################################## + +# If DATE isn't defined, use the default date command; the configuration +# file can override this. + +if [ "x${DATE}" = "x" ]; then + DATE=date +fi + +# The error function uses this. + +VALID_RANGE=0 + +# Process the configuration file. + +if [ $# != 1 ]; then + echo Usage: $0 config_file + exit 1 +fi + +CONFIG=${1} +if [ ! -f ${CONFIG} ]; then + error "configuration file ${CONFIG} does not exist" +fi + +# OK, the config file exists. Source it, make sure required parameters +# are defined and their files exist, and give default values to optional +# parameters. + +. ${CONFIG} + +test "x${REG_UPDATE}" = "x" && error "REG_UPDATE is not defined" +test "x${REG_BUILD}" = "x" && error "REG_BUILD is not defined" +test "x${REG_TEST}" = "x" && error "REG_TEST is not defined" +test -x ${REG_TEST} || error "REG_TEST is not an executable file" +test "x${SKIP_LOW}" = "x" && SKIP_LOW=0 +test "x${SKIP_HIGH}" = "x" && SKIP_HIGH=0 +test "x${DELTA}" = "x" && DELTA=3600 +test "x${VERBOSITY}" = "x" && VERBOSITY=0 +test "x${HAS_CHANGES}" = "x" && HAS_CHANGES=true +test "x${REG_FINISH}" = "x" && REG_FINISH=true + +msg 2 "LOW_DATE = ${LOW_DATE}" +msg 2 "HIGH_DATE = ${HIGH_DATE}" +msg 2 "REG_UPDATE = ${REG_UPDATE}" +msg 2 "REG_BUILD = ${REG_BUILD}" +msg 2 "REG_TEST = ${REG_TEST}" +msg 2 "SKIP_LOW = ${SKIP_LOW}" +msg 2 "SKIP_HIGH = ${SKIP_HIGH}" +msg 2 "FIRST_MID = ${FIRST_MID}" +msg 2 "VERBOSITY = ${VERBOSITY}" +msg 2 "DELTA = ${DELTA}" + +# Verify that DELTA is at least two minutes. + +test ${DELTA} -lt 120 && \ + error "DELTA is ${DELTA}, must be at least 120 (two minutes)" + +# Change the dates into seconds since the epoch. This uses an extension +# in GNU date. + +LOW_DATE=`${DATE} +%s --date "${LOW_DATE}"` || \ + error "date command failed for \"${LOW_DATE}\"" +HIGH_DATE=`${DATE} +%s --date "${HIGH_DATE}"` || \ + error "date command failed for \"${LOW_DATE}\"" + +# If FIRST_MID was defined, convert it and make sure it's in the range. + +if [ "x${FIRST_MID}" != "x" ]; then + FIRST_MID=`${DATE} +%s --date "${FIRST_MID}"` || \ + error "date command failed for \"${FIRST_MID}\"" + test ${FIRST_MID} -le ${LOW_DATE} && \ + error "FIRST_MID date is earlier than LOW_DATE" + test ${FIRST_MID} -ge ${HIGH_DATE} && \ + error "FIRST_MID is later than HIGH_DATE" +else + FIRST_MID=0 +fi + +# Keep track of the bounds of the range where the test behavior changes, +# using a human-readable version of each date. + +make_date ${LOW_DATE} +LATER_THAN="${MADE_DATE}" +make_date ${HIGH_DATE} +EARLIER_THAN="${MADE_DATE}" + +msg 2 "LATER_THAN = ${LATER_THAN}" +msg 2 "EARLIER_THAN = ${EARLIER_THAN}" + +# Verify that the range isn't backwards. + +test ${LOW_DATE} -lt ${HIGH_DATE} || error "date range is backwards" + +# Verify that the first and last date in the range get the results we +# expect. If not, quit, because any of several things could be wrong. + +if [ ${SKIP_LOW} -eq 0 ]; then + process_date "${LATER_THAN}" + test ${LATER} -ne 1 && \ + error "unexpected result for low date ${LATER_THAN}" + msg 1 "result for low date is as expected" +fi + +if [ ${SKIP_HIGH} -eq 0 ]; then + process_date "${EARLIER_THAN}" + test ${LATER} -ne 0 && \ + error "unexpected result for high date ${EARLIER_THAN}" + msg 1 "result for high date is as expected" +fi + +# Search within the range, now that we know that the end points are valid. + +VALID_RANGE=1 +search_dates ${LOW_DATE} ${HIGH_DATE} + +# Report the range that's left to investigate. + +echo "Continue search between ${LATER_THAN} and ${EARLIER_THAN}" + +# Invoke the optional script to report additional information about +# changes between the two dates. + +${REG_FINISH} "${LATER_THAN}" "${EARLIER_THAN}" diff --git a/contrib/reghunt/date_based/reg_test_template b/contrib/reghunt/date_based/reg_test_template new file mode 100755 index 000000000..ab5bbc106 --- /dev/null +++ b/contrib/reghunt/date_based/reg_test_template @@ -0,0 +1,41 @@ +#! /bin/sh + +# Template for the test script specified for REG_TEST. + +# Run the test case for a regression search. The argument is the date +# of the sources. The return value is 1 if the binary search should +# continue with later dates, 0 if it should continue with earlier +# dates. + +DATE="${1}" + +# Specify the PR number and the directory where the test should be run. +PR=xxxx +DIR=xxxx + +LOG_DATE="`echo ${DATE} | sed 's/[-: ]/_/g'`" +LOG="${PR}.${LOG_DATE}.out" + +echo "`date` running test for PR ${PR}" +cd ${DIR} + +# Compile the test case with whatever options are needed to trigger the +# error. + +<compiler_to_run> <options> ${PR}.<x> > ${LOG} 2>&1 + +# Some tests will require additional commands to determine whether the +# test passed or failed, such as grepping compiler output for a +# particular message, or running the test and possibly comparing its +# output with the expected output. + +xxxxx + +# The return value depends on whether the last command is expected to be +# zero or nonzero for a passing test, and whether we're looking for a +# regression or for the patch that fixed the bug. + +# Return 1 to continue the search with later dates, 0 for earlier dates. + +test $? -eq 0 && exit 1 +exit 0 |