Bug#12981100 PERFORMANCE_SCHEMA NET IO IDLE AND RECV EVENTS NEST WITHIN THE WRONG STATEMENT

This bug is caused by the lack of integration between:
- the IDLE instrumentation
- the SOCKET instrumentation
- the STATEMENT instrumentation
- the STAGE instrumentation
in the server.

While each instrumentation taken individually works,
the overall result is events that do not properly relate to each others.

The fix consist of several parts.

1) Define a network call back interface for the NET structure,
   so that the network layer can notify events when a packet header is seen.

This part is critical to isolate all the SQL layer performance schema related
instrumentation from the NET code.

2) Use this call back interface internally in mysqld,
to call the IDLE / SOCKET / STATEMENT / STAGE instrumentation
in a coherent way, respecting the logical order or events.

3) IDLE instrumentation:
- IDLE events are generated with a NULL NESTING_EVENT_ID parent
- HAVE_PSI_IDLE_INTERFACE was missing and has been added,
to facilitate building without the IDLE instrumentation.

4) STATEMENT instrumentation:
Statements are now created (MYSQL_START_STATEMENT) much sooner,
when a new packet header is seen.
As a result, a new statement instrument "statement/com/",
has been defined to represent a statement just started.

Also, in release builds only, a spurious "statement/sql/"
statement existed, due to a bug related to SHOW PROCEDURE CODE
and SHOW FUNCTION CODE, for which no statement name was defined in release builds.
This has been fixed.

4) SOCKET instrumentation:
no changes in the code itself.
SOCKET events are now properly recorded as childrens of a statement,
due to the reordering of MYSQL_START_STATEMENT.

5) STAGES instrumentation
no changes in the code itself.
The first stage ("stage/sql/init") is now started right after a statement starts.

6) Existing test cases

tests events_aggregates* were missing instrumentation for "statement/com/Query",
so that SQL statements that were intended to be recorded were not.
This has been fixed in the tests.

Tests outputs have been adjusted, as there is a new statement class.

A new test, nesting.test, shows precise events dependencies between all events.

Author: marcalff

include/CMakeLists.txt

@@ -54,6 +54,7 @@ SET(HEADERS
   m_ctype.h
   my_attribute.h 
   my_compiler.h
+  mysql_com_server.h
   ${HEADERS_GEN_CONFIGURE}
 )
 

include/mysql.h.pp

@@ -27,7 +27,7 @@
   unsigned int *return_status;
   unsigned char reading_or_writing;
   char save_char;
-  my_bool mysql_socket_idle;
+  my_bool unused1;
   my_bool unused2;
   my_bool compress;
   my_bool unused3;

include/mysql/psi/mysql_idle.h

@@ -29,24 +29,6 @@
   @{
 */
 
-/**
-  @def MYSQL_IDLE_WAIT_VARIABLES
-  Instrumentation helper for idle waits.
-  This instrumentation declares local variables.
-  Do not use a ';' after this macro
-  @param LOCKER the locker
-  @param STATE the locker state
-  @sa MYSQL_START_IDLE_WAIT
-  @sa MYSQL_END_IDLE_WAIT
-*/
-#ifdef HAVE_PSI_INTERFACE
-  #define MYSQL_IDLE_WAIT_VARIABLES(LOCKER, STATE) \
-    struct PSI_idle_locker* LOCKER; \
-    PSI_idle_locker_state STATE;
-#else
-  #define MYSQL_IDLE_WAIT_VARIABLES(LOCKER, STATE)
-#endif
-
 /**
   @def MYSQL_START_IDLE_WAIT
   Instrumentation helper for table io_waits.
@@ -55,7 +37,7 @@
   @param STATE the locker state
   @sa MYSQL_END_IDLE_WAIT.
 */
-#ifdef HAVE_PSI_INTERFACE
+#ifdef HAVE_PSI_IDLE_INTERFACE
   #define MYSQL_START_IDLE_WAIT(LOCKER, STATE) \
     LOCKER= inline_mysql_start_idle_wait(STATE, __FILE__, __LINE__)
 #else
@@ -70,15 +52,15 @@
   @param LOCKER the locker
   @sa MYSQL_START_IDLE_WAIT.
 */
-#ifdef HAVE_PSI_INTERFACE
+#ifdef HAVE_PSI_IDLE_INTERFACE
   #define MYSQL_END_IDLE_WAIT(LOCKER) \
     inline_mysql_end_idle_wait(LOCKER)
 #else
   #define MYSQL_END_IDLE_WAIT(LOCKER) \
     do {} while (0)
 #endif
 
-#ifdef HAVE_PSI_INTERFACE
+#ifdef HAVE_PSI_IDLE_INTERFACE
 /**
   Instrumentation calls for MYSQL_START_IDLE_WAIT.
   @sa MYSQL_END_IDLE_WAIT.

include/mysql/psi/psi.h

@@ -136,6 +136,8 @@ struct PSI_bootstrap
   @sa DISABLE_PSI_TABLE
   @sa DISABLE_PSI_STAGE
   @sa DISABLE_PSI_STATEMENT
+  @sa DISABLE_PSI_SOCKET
+  @sa DISABLE_PSI_IDLE
 */
 
 #ifndef DISABLE_PSI_MUTEX
@@ -221,6 +223,16 @@ struct PSI_bootstrap
 #define HAVE_PSI_SOCKET_INTERFACE
 #endif
 
+/**
+  @def DISABLE_PSI_IDLE
+  Compiling option to disable the idle instrumentation.
+  @sa DISABLE_PSI_MUTEX
+*/
+
+#ifndef DISABLE_PSI_IDLE
+#define HAVE_PSI_IDLE_INTERFACE
+#endif
+
 /**
   @def PSI_VERSION_1
   Performance Schema Interface number for version 1.

include/mysql_com.h

@@ -302,7 +302,7 @@ typedef struct st_net {
   unsigned int *return_status;
   unsigned char reading_or_writing;
   char save_char;
-  my_bool mysql_socket_idle; /* Perfschema: True when socket state is IDLE */
+  my_bool unused1; /* Please remove with the next incompatible ABI change */
   my_bool unused2; /* Please remove with the next incompatible ABI change */
   my_bool compress;
   my_bool unused3; /* Please remove with the next incompatible ABI change. */
@@ -323,6 +323,14 @@ typedef struct st_net {
   char last_error[MYSQL_ERRMSG_SIZE];
   /** Client library sqlstate buffer. Set along with the error message. */
   char sqlstate[SQLSTATE_LENGTH+1];
+  /**
+    Extension pointer, for the caller private use.
+    Any program linking with the networking library can use this pointer,
+    which is handy when private connection specific data needs to be
+    maintained.
+    The mysqld server process uses this pointer internally,
+    to maintain the server internal instrumentation for the connection.
+  */
   void *extension;
 } NET;
 

include/mysql_com_server.h

@@ -0,0 +1,41 @@
+/* Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
+
+   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 */
+
+/*
+  Definitions private to the server,
+  used in the networking layer to notify specific events.
+*/
+
+#ifndef _mysql_com_server_h
+#define _mysql_com_server_h
+
+struct st_net_server;
+
+typedef void (*before_header_callback_fn)
+  (struct st_net *net, void *user_data, size_t count);
+
+typedef void (*after_header_callback_fn)
+  (struct st_net *net, void *user_data, size_t count, my_bool rc);
+
+struct st_net_server
+{
+  before_header_callback_fn m_before_header;
+  after_header_callback_fn m_after_header;
+  void *m_user_data;
+};
+
+typedef struct st_net_server NET_SERVER;
+
+#endif

mysql-test/suite/perfschema/include/event_aggregate_setup.inc

@@ -122,6 +122,8 @@ update performance_schema.setup_instruments set enabled='YES', timed='YES'
 update performance_schema.setup_instruments set enabled='YES', timed='YES'
   where name in ('statement/sql/select',
                  'statement/sql/insert',
+                 'statement/com/',
+                 'statement/com/Query',
                  'statement/com/Quit',
                  'statement/com/error');