WL#5030: Split and remove mysql_priv.h

This patch:

- Moves all definitions from the mysql_priv.h file into
  header files for the component where the variable is
  defined
- Creates header files if the component lacks one
- Eliminates all include directives from mysql_priv.h
- Eliminates all circular include cycles
- Rename time.cc to sql_time.cc
- Rename mysql_priv.h to sql_priv.h

Author: Mats Kindahl

.bzrignore

@@ -394,6 +394,7 @@ client/rpl_tblmap.cc
 client/rpl_utility.h
 client/rpl_utility.cc
 client/select_test
+client/sql_const.h
 client/sql_string.cpp
 client/ssl_test
 client/thimble
@@ -1209,7 +1210,7 @@ libmysqld/stacktrace.c
 libmysqld/strfunc.cc
 libmysqld/table.cc
 libmysqld/thr_malloc.cc
-libmysqld/time.cc
+libmysqld/sql_time.cc
 libmysqld/tztime.cc
 libmysqld/uniques.cc
 libmysqld/unireg.cc
@@ -1414,7 +1415,7 @@ mysql-test/var/*
 mysql-test/windows_sys_vars.inc
 mysql.kdevprj
 mysql.proj
-mysql_priv.h
+sql_priv.h
 mysqlbinlog/*.ds?
 mysqlbinlog/*.vcproj
 mysqlcheck/*.ds?

client/Makefile.am

@@ -103,13 +103,13 @@ DEFS =			-DMYSQL_CLIENT_NO_THREADS \
 			-DDEFAULT_MYSQL_HOME="\"$(prefix)\"" \
 			-DMYSQL_DATADIR="\"$(localstatedir)\""
 
-sql_src=log_event.h mysql_priv.h rpl_constants.h \
+sql_src=log_event.h sql_priv.h rpl_constants.h \
 	rpl_tblmap.h rpl_tblmap.cc \
 	log_event.cc my_decimal.h my_decimal.cc \
 	log_event_old.h log_event_old.cc \
 	rpl_record_old.h rpl_record_old.cc \
 	rpl_utility.h rpl_utility.cc \
-	transaction.h
+	transaction.h sql_const.h
 strings_src=decimal.c dtoa.c
 
 link_sources:

client/client_priv.h

@@ -19,7 +19,6 @@
 #include <my_sys.h>
 #include <m_string.h>
 #include <mysql.h>
-#include <mysql_embed.h>
 #include <errmsg.h>
 #include <my_getopt.h>
 

client/mysqlbinlog.cc

@@ -31,7 +31,7 @@
 #include "client_priv.h"
 #include <my_time.h>
 /* That one is necessary for defines of OPTION_NO_FOREIGN_KEY_CHECKS etc */
-#include "mysql_priv.h" 
+#include "sql_priv.h"
 #include "log_event.h"
 #include "sql_common.h"
 

include/Makefile.am

@@ -34,7 +34,7 @@ pkginclude_HEADERS =	$(HEADERS_ABI) my_dbug.h m_string.h my_sys.h \
 			$(HEADERS_GEN_MAKE) probes_mysql.h probes_mysql_nodtrace.h
 
 noinst_HEADERS =	config-win.h config-netware.h lf.h my_bit.h \
-			heap.h my_bitmap.h my_uctype.h \
+			heap.h my_bitmap.h my_uctype.h password.h \
 			myisam.h myisampack.h myisammrg.h ft_global.h\
 			mysys_err.h my_base.h help_start.h help_end.h \
 			my_nosys.h my_alarm.h queues.h rijndael.h sha1.h \

include/hash.h

@@ -17,6 +17,21 @@
 
 #ifndef _hash_h
 #define _hash_h
+
+#include "my_global.h"                          /* uchar */
+#include "my_sys.h"                             /* DYNAMIC_ARRAY */
+
+/*
+  This forward declaration is used from C files where the real
+  definition is included before.  Since C does not allow repeated
+  typedef declarations, even when identical, the definition may not be
+  repeated.
+*/
+#ifndef CHARSET_INFO_DEFINED
+#define CHARSET_INFO_DEFINED
+typedef struct charset_info_st CHARSET_INFO;
+#endif  /* CHARSET_INFO_DEFINED */
+
 #ifdef	__cplusplus
 extern "C" {
 #endif

include/keycache.h

@@ -17,6 +17,9 @@
 
 #ifndef _keycache_h
 #define _keycache_h
+
+#include "my_sys.h"                             /* flush_type */
+
 C_MODE_START
 
 /* declare structures that is used by st_key_cache */

include/m_ctype.h

@@ -15,13 +15,13 @@
 
 /*
   A better inplementation of the UNIX ctype(3) library.
-  Notes:   my_global.h should be included before ctype.h
 */
 
 #ifndef _m_ctype_h
 #define _m_ctype_h
 
 #include <my_attribute.h>
+#include "my_global.h"                          /* uint16, uchar */
 
 #ifdef	__cplusplus
 extern "C" {
@@ -265,6 +265,12 @@ extern MY_CHARSET_HANDLER my_charset_8bit_handler;
 extern MY_CHARSET_HANDLER my_charset_ucs2_handler;
 
 
+/*
+  We define this CHARSET_INFO_DEFINED here to prevent a repeat of the
+  typedef in hash.c, which will cause a compiler error.
+*/
+#define CHARSET_INFO_DEFINED
+
 /* See strings/CHARSET_INFO.txt about information on this structure  */
 typedef struct charset_info_st
 {

include/m_string.h

@@ -20,6 +20,9 @@
 
 #ifndef _m_string_h
 #define _m_string_h
+
+#include "my_global.h"                          /* HAVE_* */
+
 #ifndef __USE_GNU
 #define __USE_GNU				/* We want to use stpcpy */
 #endif
@@ -266,13 +269,6 @@ extern ulonglong strtoull(const char *str, char **ptr, int base);
 #endif
 #define longlong2str(A,B,C) ll2str((A),(B),(C),1)
 
-/* my_vsnprintf.c */
-
-extern size_t my_vsnprintf(char *str, size_t n,
-                           const char *format, va_list ap);
-extern size_t my_snprintf(char *to, size_t n, const char *fmt, ...)
-  ATTRIBUTE_FORMAT(printf, 3, 4);
-
 #if defined(__cplusplus)
 }
 #endif
@@ -365,4 +361,10 @@ static inline const uchar *skip_trailing_space(const uchar *ptr,size_t len)
   return (end);
 }
 
+static inline void lex_string_set(LEX_STRING *lex_str, const char *c_str)
+{
+  lex_str->str= (char *) c_str;
+  lex_str->length= strlen(c_str);
+}
+
 #endif

include/my_dbug.h

@@ -145,7 +145,23 @@ extern  const char* _db_get_func_(void);
 #define DBUG_CRASH_VOID_RETURN          do { return; } while(0)
 
 #endif
-#ifdef  __cplusplus
+
+#ifdef EXTRA_DEBUG
+/**
+  Sync points allow us to force the server to reach a certain line of code
+  and block there until the client tells the server it is ok to go on.
+  The client tells the server to block with SELECT GET_LOCK()
+  and unblocks it with SELECT RELEASE_LOCK(). Used for debugging difficult
+  concurrency problems
+*/
+#define DBUG_SYNC_POINT(lock_name,lock_timeout) \
+ debug_sync_point(lock_name,lock_timeout)
+void debug_sync_point(const char* lock_name, uint lock_timeout);
+#else
+#define DBUG_SYNC_POINT(lock_name,lock_timeout)
+#endif /* EXTRA_DEBUG */
+
+#ifdef	__cplusplus
 }
 #endif
 #endif

include/my_dir.h

@@ -22,6 +22,8 @@ extern "C" {
 #ifndef MY_DIR_H
 #define MY_DIR_H
 
+#include "my_global.h"
+
 #include <sys/stat.h>
 
 	/* Defines for my_dir and my_stat */

include/my_getopt.h

@@ -16,6 +16,8 @@
 #ifndef _my_getopt_h
 #define _my_getopt_h
 
+#include "my_sys.h"                             /* loglevel */
+
 C_MODE_START
 
 #define GET_NO_ARG     1

include/my_global.h

@@ -1205,6 +1205,12 @@ typedef unsigned long my_off_t;
 #endif /*_WIN32*/
 #define MY_FILEPOS_ERROR	(~(my_off_t) 0)
 
+/*
+  TODO Convert these to use Bitmap class.
+ */
+typedef ulonglong table_map;          /* Used for table bits in join */
+typedef ulong nesting_map;  /* Used for flags of nesting constructs */
+
 #if defined(__WIN__)
 #define socket_errno	WSAGetLastError()
 #define SOCKET_EINTR	WSAEINTR
@@ -1675,7 +1681,13 @@ inline void  operator delete[](void*, void*) { /* Do nothing */ }
 #if !defined(max)
 #define max(a, b)	((a) > (b) ? (a) : (b))
 #define min(a, b)	((a) < (b) ? (a) : (b))
-#endif
+#endif  
+
+#define x_free(A) \
+  do { my_free((uchar*)(A), MYF(MY_WME|MY_FAE|MY_ALLOW_ZERO_PTR)); } while (0)
+#define safeFree(X) \
+    do { if (X) { my_free((uchar*)(X), MYF(0)); (X) = NULL; } } while (0)
+
 /*
   Only Linux is known to need an explicit sync of the directory to make sure a
   file creation/deletion/renaming in(from,to) this directory durable.
@@ -1755,4 +1767,20 @@ static inline double rint(double x)
 #endif
 #endif
 
+/* Defines that are unique to the embedded version of MySQL */
+
+#ifdef EMBEDDED_LIBRARY
+
+/* Things we don't need in the embedded version of MySQL */
+/* TODO HF add #undef HAVE_VIO if we don't want client in embedded library */
+
+#undef HAVE_PSTACK				/* No stacktrace */
+#undef HAVE_OPENSSL
+#undef HAVE_SMEM				/* No shared memory */
+#undef HAVE_NDBCLUSTER_DB /* No NDB cluster */
+
+#define DONT_USE_RAID
+
+#endif /* EMBEDDED_LIBRARY */
+
 #endif /* my_global_h */

include/my_handler.h

@@ -23,6 +23,8 @@
 extern "C" {
 #endif
 
+#include "m_ctype.h"                            /* CHARSET_INFO */
+
 /*
   There is a hard limit for the maximum number of keys as there are only
   8 bits in the index file header for the number of keys in a table.

include/my_net.h

@@ -24,6 +24,9 @@
 
 #ifndef _my_net_h
 #define _my_net_h
+
+#include "my_global.h"                  /* C_MODE_START, C_MODE_END */
+
 C_MODE_START
 
 #include <errno.h>

include/my_pthread.h

@@ -18,6 +18,8 @@
 #ifndef _my_pthread_h
 #define _my_pthread_h
 
+#include "my_global.h"                          /* myf */
+
 #ifndef ETIME
 #define ETIME ETIMEDOUT				/* For FreeBSD */
 #endif

include/my_sys.h

@@ -15,6 +15,9 @@
 
 #ifndef _my_sys_h
 #define _my_sys_h
+
+#include "my_global.h"                  /* C_MODE_START, C_MODE_END */
+
 C_MODE_START
 
 #ifdef HAVE_AIOWAIT

include/my_tree.h

@@ -20,6 +20,7 @@ extern "C" {
 #endif
 
 #include "my_base.h"		/* get 'enum ha_rkey_function' */
+#include "my_alloc.h"           /* MEM_ROOT */
 
 /* Worst case tree is half full. This gives use 2^(MAX_TREE_HEIGHT/2) leafs */
 #define MAX_TREE_HEIGHT	64

include/mysql/psi/mysql_file.h

@@ -20,6 +20,8 @@
 #include <string.h>
 /* For MY_STAT */
 #include <my_dir.h>
+/* For my_chsize */
+#include <my_sys.h>
 
 /**
   @file mysql/psi/mysql_file.h

include/mysys_err.h

@@ -16,6 +16,9 @@
 #ifndef _mysys_err_h
 #define _mysys_err_h
 #ifdef	__cplusplus
+
+#include "my_global.h"                          /* NEAR */
+
 extern "C" {
 #endif
 

include/password.h

@@ -0,0 +1,32 @@
+/* Copyright 2006-2008 MySQL AB, 2008-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 */
+
+#ifndef PASSWORD_INCLUDED
+#define PASSWORD_INCLUDED
+
+#include "my_global.h"
+
+C_MODE_START
+
+void my_make_scrambled_password_323(char *to, const char *password,
+                                    size_t pass_len);
+void my_make_scrambled_password(char *to, const char *password,
+                                size_t pass_len);
+
+void hash_password(ulong *result, const char *password, uint password_len);
+
+C_MODE_END
+
+#endif /* PASSWORD_INCLUDED */

include/queues.h

@@ -22,6 +22,9 @@
 
 #ifndef _queues_h
 #define _queues_h
+
+#include "my_global.h"                          /* uchar */
+
 #ifdef	__cplusplus
 extern "C" {
 #endif

include/violite.h

@@ -30,6 +30,10 @@
 extern "C" {
 #endif /* __cplusplus */
 
+#ifdef __cplusplus
+typedef struct st_vio Vio;
+#endif /* __cplusplus */
+
 enum enum_vio_type
 {
   VIO_CLOSED, VIO_TYPE_TCPIP, VIO_TYPE_SOCKET, VIO_TYPE_NAMEDPIPE,

libmysql/Makefile.am

@@ -83,7 +83,7 @@ link_sources:
 #
 # A list of needed headers collected from the deps information 000213
 nh =		my_global.h config-win32.h dbug.h errmsg.h \
-		m_ctype.h m_string.h \
+		m_ctype.h m_string.h password.h \
 		my_alarm.h my_config.h my_dir.h my_list.h my_net.h my_sys.h \
 		mysql.h mysql_com.h mysql_version.h mysqld_error.h \
 		mysys_err.h my_pthread.h thr_alarm.h violite.h hash.h \

libmysqld/CMakeLists.txt

@@ -76,7 +76,7 @@ SET(SQL_EMBEDDED_SOURCES emb_qcache.cc libmysqld.c lib_sql.cc
            ../sql/sql_trigger.cc ../sql/sql_udf.cc ../sql/sql_union.cc
            ../sql/sql_update.cc ../sql/sql_view.cc ../sql/sql_profile.cc
            ../sql/strfunc.cc ../sql/table.cc ../sql/thr_malloc.cc
-           ../sql/time.cc ../sql/tztime.cc ../sql/uniques.cc ../sql/unireg.cc
+           ../sql/sql_time.cc ../sql/tztime.cc ../sql/uniques.cc ../sql/unireg.cc
            ../sql/partition_info.cc ../sql/sql_connect.cc 
            ../sql/scheduler.cc ../sql/sql_audit.cc
            ../sql/event_parse_data.cc