# Copyright (C) 2009 Sun Microsystems, Inc # # This program 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; version 2 of the License. # # 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; if not, write to the Free Software # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA # # Rules for checking that the abi/api has not changed. # # The following steps are followed in the do_abi_check rule below # # 1) Generate preprocessor output for the files that need to # be tested for abi/api changes. use -nostdinc to prevent # generation of preprocessor output for system headers. This # results in messages in stderr saying that these headers # were not found. Redirect the stderr output to /dev/null # to prevent seeing these messages. # 2) sed the output to # 2.1) remove blank lines and lines that begin with "# " # 2.2) When gcc -E is run on the Mac OS and solaris sparc platforms it # introduces a line of output that shows up as a difference between # the .pp and .out files. Remove these OS specific preprocessor text # inserted by the preprocessor. # 3) diff the generated file and the canons (.pp files already in # the repository). # 4) delete the .out file that is generated. # # If the diff fails, the generated file is not removed. This will # be useful for analysis of ABI differences (e.g. using a visual # diff tool). # # A ABI change that causes a build to fail will always be accompanied # by new canons (.out files). The .out files that are not removed will # be replaced as the new .pp files. # # e.g. If include/mysql/plugin.h has an ABI change then this rule would # leave a <build directory>/abi_check.out file. # # A developer with a justified API change will then do a # mv <build directory>/abi_check.out include/mysql/plugin.pp # to replace the old canons with the new ones. # SET(abi_check_out ${BINARY_DIR}/abi_check.out) FOREACH(file ${ABI_HEADERS}) GET_FILENAME_COMPONENT(header_basename ${file} NAME) SET(tmpfile ${BINARY_DIR}/${header_basename}.pp.tmp) EXECUTE_PROCESS( COMMAND ${COMPILER} -E -nostdinc -dI -DMYSQL_ABI_CHECK -I${SOURCE_DIR}/include -I${BINARY_DIR}/include -I${SOURCE_DIR}/include/mysql -I${SOURCE_DIR}/sql ${file} ERROR_QUIET OUTPUT_FILE ${tmpfile}) EXECUTE_PROCESS( COMMAND sed -e "/^# /d" -e "/^[ ]*$/d" -e "/^#pragma GCC set_debug_pwd/d" -e "/^#ident/d" RESULT_VARIABLE result OUTPUT_FILE ${abi_check_out} INPUT_FILE ${tmpfile}) IF(NOT ${result} EQUAL 0) MESSAGE(FATAL_ERROR "sed returned error ${result}") ENDIF() FILE(REMOVE ${tmpfile}) EXECUTE_PROCESS( COMMAND diff -w ${file}.pp ${abi_check_out} RESULT_VARIABLE result) IF(NOT ${result} EQUAL 0) MESSAGE(FATAL_ERROR "ABI check found difference between ${file}.pp and ${abi_check_out}") ENDIF() FILE(REMOVE ${abi_check_out}) ENDFOREACH()