Commit 061f38f6 authored by Narayanan V's avatar Narayanan V
Browse files

WL#4380: abi_check rule (using gcc -E) for storage engine API 

Added a rule that uses gcc to generate preprocessor
output (gcc -E) that can be compared to an already
generated output using the diff utility.

icheck has been removed and replaced by gcc -E
because icheck does not support C++.
parents 565c4d2b 9e8851b1

Makefile.am

+78 −0
Original line number Diff line number Diff line
@@ -59,6 +59,8 @@ dist-hook: 
		--srcdir=$(top_srcdir)

	storage/myisam/myisamchk --silent --fast $(distdir)/win/data/mysql/*.MYI



all-local:		@ABI_CHECK@	



tags:

	support-files/build-tags
@@ -232,5 +234,81 @@ test-full-qa: 
	    test-binlog-statement test-ext test-fast-view \

	        test-fast-cursor test-unit



#

# Headers which need to be checked for abi/api compatibility.

# API_PREPROCESSOR_HEADER will be used until mysql_priv.h stablizes

# after which TEST_PREPROCESSOR_HEADER will be used.

#



API_PREPROCESSOR_HEADER = $(top_srcdir)/include/mysql/plugin.h \

                           $(top_srcdir)/include/mysql.h



TEST_PREPROCESSOR_HEADER = $(top_srcdir)/include/mysql/plugin.h \

                            $(top_srcdir)/sql/mysql_priv.h \

                            $(top_srcdir)/include/mysql.h



#

# 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.

#



abi_check:	$(API_PREPROCESSOR_HEADER)

	$(MAKE) abi_headers="$^" do_abi_check



abi_check_all:	$(TEST_PREPROCESSOR_HEADER)

	$(MAKE) abi_headers="$^" do_abi_check



do_abi_check:

	set -ex; \

	for file in $(abi_headers); do \

	         @CC@ -E -nostdinc -dI \

	                  -I$(top_srcdir)/include \

	                  -I$(top_srcdir)/include/mysql \

	                  -I$(top_srcdir)/sql \

	                  -I$(top_builddir)/include \

	                  -I$(top_builddir)/include/mysql \

	                  -I$(top_builddir)/sql \

	                                 $$file 2>/dev/null | \

	                  @SED@ -e '/^# /d' \

	                            -e '/^[ 	]*$$/d' \

	                            -e '/^#pragma GCC set_debug_pwd/d' \

	                            -e '/^#ident/d' > \

	                                       $(top_builddir)/abi_check.out; \

	                  @DIFF@ -w $$file.pp $(top_builddir)/abi_check.out; \

	                  @RM@ $(top_builddir)/abi_check.out; \

	done



# Don't update the files from bitkeeper

%::SCCS/s.%

configure.in

+10 −18
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ AC_CANONICAL_SYSTEM 
#

# When changing major version number please also check switch statement

# in mysqlbinlog::check_master_version().

AM_INIT_AUTOMAKE(mysql, 5.1.28)

AM_INIT_AUTOMAKE(mysql, 5.1.30)

AM_CONFIG_HEADER([include/config.h:config.h.in])



PROTOCOL_VERSION=10
@@ -419,6 +419,7 @@ AC_PATH_PROG(SED, sed, sed) 
AC_PATH_PROG(CMP, cmp, cmp)

AC_PATH_PROG(CHMOD, chmod, chmod)

AC_PATH_PROG(HOSTNAME, hostname, hostname)

AC_PATH_PROG(DIFF, diff, diff)

# Check for a GNU tar named 'gtar', or 'gnutar' (MacOS X) and

# fall back to 'tar' otherwise and hope that it's a GNU tar as well

AC_CHECK_PROGS(TAR, gnutar gtar tar)
@@ -443,25 +444,16 @@ AC_SUBST(HOSTNAME) 
AC_SUBST(PERL)

AC_SUBST(PERL5)



# icheck, used for ABI check

AC_PATH_PROG(ICHECK, icheck, no)

# "icheck" is also the name of a file system check program on Tru64.

# Verify the program found is really the interface checker.

if test "x$ICHECK" != "xno"

then

  AC_MSG_CHECKING(if $ICHECK works as expected)

  echo "int foo;" > conftest.h

  $ICHECK --canonify -o conftest.ic conftest.h 2>/dev/null

  if test -f "conftest.ic"

# Enable the abi_check rule only if gcc is available



if expr "$CC" : ".*gcc.*"

then

    AC_MSG_RESULT(yes)

  ABI_CHECK="abi_check"

else

    AC_MSG_RESULT(no)

    ICHECK=no

  fi

  rm -f conftest.ic conftest.h

  ABI_CHECK=""

fi

AC_SUBST(ICHECK)



AC_SUBST(ABI_CHECK)



# Lock for PS

AC_PATH_PROG(PS, ps, ps)

include/Makefile.am

+2 −14
Original line number Diff line number Diff line
@@ -38,10 +38,11 @@ noinst_HEADERS = config-win.h config-netware.h my_bit.h \ 
			atomic/rwlock.h atomic/x86-gcc.h atomic/x86-msvc.h \

			atomic/gcc_builtins.h my_libwrap.h my_stacktrace.h



EXTRA_DIST =        mysql.h.pp mysql/plugin.h.pp



# Remove built files and the symlinked directories

CLEANFILES =            $(BUILT_SOURCES) readline openssl



EXTRA_DIST =            mysql_h.ic



# Some include files that may be moved and patched by configure

DISTCLEANFILES =	sched.h $(CLEANFILES)
@@ -63,18 +64,5 @@ my_config.h: config.h 
dist-hook:

	$(RM) -f $(distdir)/mysql_version.h $(distdir)/my_config.h



#

# Rules for checking that ABI has not changed

#



# Create a icheck file and compare it to the reference

abi_check: $(HEADERS_ABI) mysql_version.h mysql_h.ic

	@set -ex; \

	if [ @ICHECK@ != no ] ; then \

	  @ICHECK@ --canonify --skip-from-re /usr/ -o $@ $(HEADERS_ABI); \

	  @ICHECK@ --compare mysql_h.ic $@; \

	fi; \

	touch abi_check;



# Don't update the files from bitkeeper

%::SCCS/s.%

include/mysql.h.pp

0 → 100644
+674 −0

File added.

Preview size limit exceeded, changes collapsed.

include/mysql/plugin.h.pp

0 → 100644
+139 −0
Original line number Diff line number Diff line 
struct st_mysql_lex_string

{

  char *str;

  unsigned int length;

};

typedef struct st_mysql_lex_string MYSQL_LEX_STRING;

struct st_mysql_xid {

  long formatID;

  long gtrid_length;

  long bqual_length;

  char data[128];

};

typedef struct st_mysql_xid MYSQL_XID;

enum enum_mysql_show_type

{

  SHOW_UNDEF, SHOW_BOOL, SHOW_INT, SHOW_LONG,

  SHOW_LONGLONG, SHOW_CHAR, SHOW_CHAR_PTR,

  SHOW_ARRAY, SHOW_FUNC, SHOW_DOUBLE

};

struct st_mysql_show_var {

  const char *name;

  char *value;

  enum enum_mysql_show_type type;

};

typedef int (*mysql_show_var_func)(void*, struct st_mysql_show_var*, char *);

struct st_mysql_sys_var;

struct st_mysql_value;

typedef int (*mysql_var_check_func)(void* thd,

                                    struct st_mysql_sys_var *var,

                                    void *save, struct st_mysql_value *value);

typedef void (*mysql_var_update_func)(void* thd,

                                      struct st_mysql_sys_var *var,

                                      void *var_ptr, const void *save);

struct st_mysql_plugin

{

  int type;

  void *info;

  const char *name;

  const char *author;

  const char *descr;

  int license;

  int (*init)(void *);

  int (*deinit)(void *);

  unsigned int version;

  struct st_mysql_show_var *status_vars;

  struct st_mysql_sys_var **system_vars;

  void * __reserved1;

};

enum enum_ftparser_mode

{

  MYSQL_FTPARSER_SIMPLE_MODE= 0,

  MYSQL_FTPARSER_WITH_STOPWORDS= 1,

  MYSQL_FTPARSER_FULL_BOOLEAN_INFO= 2

};

enum enum_ft_token_type

{

  FT_TOKEN_EOF= 0,

  FT_TOKEN_WORD= 1,

  FT_TOKEN_LEFT_PAREN= 2,

  FT_TOKEN_RIGHT_PAREN= 3,

  FT_TOKEN_STOPWORD= 4

};

typedef struct st_mysql_ftparser_boolean_info

{

  enum enum_ft_token_type type;

  int yesno;

  int weight_adjust;

  char wasign;

  char trunc;

  char prev;

  char *quot;

} MYSQL_FTPARSER_BOOLEAN_INFO;

typedef struct st_mysql_ftparser_param

{

  int (*mysql_parse)(struct st_mysql_ftparser_param *,

                     char *doc, int doc_len);

  int (*mysql_add_word)(struct st_mysql_ftparser_param *,

                        char *word, int word_len,

                        MYSQL_FTPARSER_BOOLEAN_INFO *boolean_info);

  void *ftparser_state;

  void *mysql_ftparam;

  struct charset_info_st *cs;

  char *doc;

  int length;

  int flags;

  enum enum_ftparser_mode mode;

} MYSQL_FTPARSER_PARAM;

struct st_mysql_ftparser

{

  int interface_version;

  int (*parse)(MYSQL_FTPARSER_PARAM *param);

  int (*init)(MYSQL_FTPARSER_PARAM *param);

  int (*deinit)(MYSQL_FTPARSER_PARAM *param);

};

struct st_mysql_storage_engine

{

  int interface_version;

};

struct handlerton;

struct st_mysql_daemon

{

  int interface_version;

};

struct st_mysql_information_schema

{

  int interface_version;

};

struct st_mysql_value

{

  int (*value_type)(struct st_mysql_value *);

  const char *(*val_str)(struct st_mysql_value *, char *buffer, int *length);

  int (*val_real)(struct st_mysql_value *, double *realbuf);

  int (*val_int)(struct st_mysql_value *, long long *intbuf);

};

int thd_in_lock_tables(const void* thd);

int thd_tablespace_op(const void* thd);

long long thd_test_options(const void* thd, long long test_options);

int thd_sql_command(const void* thd);

const char *thd_proc_info(void* thd, const char *info);

void **thd_ha_data(const void* thd, const struct handlerton *hton);

int thd_tx_isolation(const void* thd);

char *thd_security_context(void* thd, char *buffer, unsigned int length,

                           unsigned int max_query_len);

void thd_inc_row_count(void* thd);

int mysql_tmpfile(const char *prefix);

int thd_killed(const void* thd);

unsigned long thd_get_thread_id(const void* thd);

void *thd_alloc(void* thd, unsigned int size);

void *thd_calloc(void* thd, unsigned int size);

char *thd_strdup(void* thd, const char *str);

char *thd_strmake(void* thd, const char *str, unsigned int size);

void *thd_memdup(void* thd, const void* str, unsigned int size);

MYSQL_LEX_STRING *thd_make_lex_string(void* thd, MYSQL_LEX_STRING *lex_str,

                                      const char *str, unsigned int size,

                                      int allocate_lex_string);

void thd_get_xid(const void* thd, MYSQL_XID *xid);

void mysql_query_cache_invalidate4(void* thd,

                                   const char *key, unsigned int key_length,

                                   int using_trx);