sp_pcontext.h 18.8 KB
Newer Older
1
/* -*- C++ -*- */
2
/* Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
3 4 5

   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
unknown's avatar
unknown committed
6
   the Free Software Foundation; version 2 of the License.
7 8 9 10 11 12 13 14

   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
15
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
16 17 18 19

#ifndef _SP_PCONTEXT_H_
#define _SP_PCONTEXT_H_

20
#ifdef USE_PRAGMA_INTERFACE
21 22 23
#pragma interface			/* gcc class implementation */
#endif

24 25 26
#include "sql_string.h"                         // LEX_STRING
#include "mysql_com.h"                          // enum_field_types
#include "field.h"                              // Create_field
27
#include "sql_array.h"                          // Dynamic_array
28 29


30 31
/// This class represents a stored program variable or a parameter
/// (also referenced as 'SP-variable').
32

33
class sp_variable : public Sql_alloc
34
{
35 36 37 38 39 40 41
public:
  enum enum_mode
  {
    MODE_IN,
    MODE_OUT,
    MODE_INOUT
  };
42

43 44
  /// Name of the SP-variable.
  LEX_STRING name;
45

46 47
  /// Mode of the SP-variable.
  enum_mode mode;
unknown's avatar
unknown committed
48

49 50 51 52 53 54
  /// The index to the variable's value in the runtime frame.
  ///
  /// It is calculated during parsing and used when creating sp_instr_set
  /// instructions and Item_splocal items. I.e. values are set/referred by
  /// array indexing in runtime.
  uint offset;
55

56 57
  /// Default value of the SP-variable (if any).
  Item *default_value;
58

59
  /// Full type information (field meta-data) of the SP-variable.
Alexander Barkov's avatar
Alexander Barkov committed
60
  Column_definition field_def;
61

62 63
  /// Field-type of the SP-variable.
  enum_field_types sql_type() const { return field_def.sql_type; }
64
public:
65
  sp_variable(LEX_STRING _name, uint _offset)
66 67
   :Sql_alloc(),
    name(_name),
68
    mode(MODE_IN),
69 70 71
    offset(_offset),
    default_value(NULL)
  { }
72
};
73

74
///////////////////////////////////////////////////////////////////////////
75

76 77 78 79 80 81 82 83
/// This class represents an SQL/PSM label. Can refer to the identifier
/// used with the "label_name:" construct which may precede some SQL/PSM
/// statements, or to an implicit implementation-dependent identifier which
/// the parser inserts before a high-level flow control statement such as
/// IF/WHILE/REPEAT/LOOP, when such statement is rewritten into a
/// combination of low-level jump/jump_if instructions and labels.

class sp_label : public Sql_alloc
84
{
85
public:
86
  enum enum_type
87
  {
88 89
    /// Implicit label generated by parser.
    IMPLICIT,
90

91 92
    /// Label at BEGIN.
    BEGIN,
93

94 95 96
    /// Label at iteration control
    ITERATION
  };
97

98 99
  /// Name of the label.
  LEX_STRING name;
100

101 102
  /// Instruction pointer of the label.
  uint ip;
103

104 105
  /// Type of the label.
  enum_type type;
106

107 108
  /// Scope of the label.
  class sp_pcontext *ctx;
109

110
public:
111 112
  sp_label(const LEX_STRING _name,
           uint _ip, enum_type _type, sp_pcontext *_ctx)
113 114 115 116 117 118 119
   :Sql_alloc(),
    name(_name),
    ip(_ip),
    type(_type),
    ctx(_ctx)
  { }
};
120

121 122 123 124 125 126 127 128
///////////////////////////////////////////////////////////////////////////

/// This class represents condition-value term in DECLARE CONDITION or
/// DECLARE HANDLER statements. sp_condition_value has little to do with
/// SQL-conditions.
///
/// In some sense, this class is a union -- a set of filled attributes
/// depends on the sp_condition_value::type value.
129

130 131
class sp_condition_value : public Sql_alloc
{
132 133 134 135
  void init_sql_state()
  {
    sql_state[0]= '\0';
  }
136 137
public:
  enum enum_type
138
  {
139 140 141 142 143 144
    ERROR_CODE,
    SQLSTATE,
    WARNING,
    NOT_FOUND,
    EXCEPTION
  };
145

146 147
  /// Type of the condition value.
  enum_type type;
148

149 150
  /// SQLSTATE of the condition value.
  char sql_state[SQLSTATE_LENGTH+1];
151

152 153
  /// MySQL error code of the condition value.
  uint mysqlerr;
154

155 156 157 158 159
public:
  sp_condition_value(uint _mysqlerr)
   :Sql_alloc(),
    type(ERROR_CODE),
    mysqlerr(_mysqlerr)
160 161 162 163 164 165 166 167 168 169
  { init_sql_state(); }

  sp_condition_value(uint _mysqlerr, const char *_sql_state)
   :Sql_alloc(),
    type(ERROR_CODE),
    mysqlerr(_mysqlerr)
  {
    memcpy(sql_state, _sql_state, SQLSTATE_LENGTH);
    sql_state[SQLSTATE_LENGTH]= 0;
  }
170 171 172

  sp_condition_value(const char *_sql_state)
   :Sql_alloc(),
173 174
    type(SQLSTATE),
    mysqlerr(0)
175
  {
176 177
    memcpy(sql_state, _sql_state, SQLSTATE_LENGTH);
    sql_state[SQLSTATE_LENGTH]= 0;
178 179
  }

180 181
  sp_condition_value(enum_type _type)
   :Sql_alloc(),
182 183
    type(_type),
    mysqlerr(0)
184
  {
185
    DBUG_ASSERT(type != ERROR_CODE && type != SQLSTATE);
186
    init_sql_state();
187 188
  }

189 190 191 192 193 194
  /// Check if two instances of sp_condition_value are equal or not.
  ///
  /// @param cv another instance of sp_condition_value to check.
  ///
  /// @return true if the instances are equal, false otherwise.
  bool equals(const sp_condition_value *cv) const;
195 196

  bool has_sql_state() const { return sql_state[0] != '\0'; }
197
};
198

199
///////////////////////////////////////////////////////////////////////////
200

201 202
/// This class represents 'DECLARE CONDITION' statement.
/// sp_condition has little to do with SQL-conditions.
203

204 205 206 207 208
class sp_condition : public Sql_alloc
{
public:
  /// Name of the condition.
  LEX_STRING name;
209

210 211
  /// Value of the condition.
  sp_condition_value *value;
212

213
public:
214
  sp_condition(const LEX_STRING _name, sp_condition_value *_value)
215 216 217 218
   :Sql_alloc(),
    name(_name),
    value(_value)
  { }
219 220 221 222 223 224 225 226 227 228 229 230 231
  sp_condition(const char *name_arg, size_t name_length_arg,
               sp_condition_value *value_arg)
   :value(value_arg)
  {
    name.str= (char *) name_arg;
    name.length= name_length_arg;
  }
  bool eq_name(const LEX_STRING str) const
  {
    return my_strnncoll(system_charset_info,
                        (const uchar *) name.str, name.length,
                        (const uchar *) str.str, str.length) == 0;
  }
232
};
233

234
///////////////////////////////////////////////////////////////////////////
235

236
/// This class represents 'DECLARE HANDLER' statement.
237

238 239 240 241 242 243
class sp_handler : public Sql_alloc
{
public:
  /// Enumeration of possible handler types.
  /// Note: UNDO handlers are not (and have never been) supported.
  enum enum_type
244
  {
245 246 247
    EXIT,
    CONTINUE
  };
248

249 250
  /// Handler type.
  enum_type type;
251

252 253
  /// Conditions caught by this handler.
  List<sp_condition_value> condition_values;
254

255 256 257 258 259 260 261 262 263
public:
  /// The constructor.
  ///
  /// @param _type SQL-handler type.
  sp_handler(enum_type _type)
   :Sql_alloc(),
    type(_type)
  { }
};
264

265 266 267 268 269
///////////////////////////////////////////////////////////////////////////

/// The class represents parse-time context, which keeps track of declared
/// variables/parameters, conditions, handlers, cursors and labels.
///
270
/// sp_pcontext objects are organized in a tree according to the following
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
/// rules:
///   - one sp_pcontext object corresponds for for each BEGIN..END block;
///   - one sp_pcontext object corresponds for each exception handler;
///   - one additional sp_pcontext object is created to contain
///     Stored Program parameters.
///
/// sp_pcontext objects are used both at parse-time and at runtime.
///
/// During the parsing stage sp_pcontext objects are used:
///   - to look up defined names (e.g. declared variables and visible
///     labels);
///   - to check for duplicates;
///   - for error checking;
///   - to calculate offsets to be used at runtime.
///
/// During the runtime phase, a tree of sp_pcontext objects is used:
///   - for error checking (e.g. to check correct number of parameters);
///   - to resolve SQL-handlers.
289

290 291 292 293
class sp_pcontext : public Sql_alloc
{
public:
  enum enum_scope
294
  {
295 296
    /// REGULAR_SCOPE designates regular BEGIN ... END blocks.
    REGULAR_SCOPE,
297

298 299 300
    /// HANDLER_SCOPE designates SQL-handler blocks.
    HANDLER_SCOPE
  };
301

302 303 304 305 306 307
  class Lex_for_loop: public Lex_for_loop_st
  {
  public:
    Lex_for_loop() { init(); }
  };

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
public:
  sp_pcontext();
  ~sp_pcontext();


  /// Create and push a new context in the tree.

  /// @param thd   thread context.
  /// @param scope scope of the new parsing context.
  /// @return the node created.
  sp_pcontext *push_context(THD *thd, enum_scope scope);

  /// Pop a node from the parsing context tree.
  /// @return the parent node.
  sp_pcontext *pop_context();

  sp_pcontext *parent_context() const
  { return m_parent; }

  /// Calculate and return the number of handlers to pop between the given
  /// context and this one.
  ///
  /// @param ctx       the other parsing context.
  /// @param exclusive specifies if the last scope should be excluded.
  ///
  /// @return the number of handlers to pop between the given context and
  /// this one.  If 'exclusive' is true, don't count the last scope we are
  /// leaving; this is used for LEAVE where we will jump to the hpop
  /// instructions.
  uint diff_handlers(const sp_pcontext *ctx, bool exclusive) const;

  /// Calculate and return the number of cursors to pop between the given
  /// context and this one.
  ///
  /// @param ctx       the other parsing context.
  /// @param exclusive specifies if the last scope should be excluded.
  ///
  /// @return the number of cursors to pop between the given context and
  /// this one.  If 'exclusive' is true, don't count the last scope we are
  /// leaving; this is used for LEAVE where we will jump to the cpop
  /// instructions.
  uint diff_cursors(const sp_pcontext *ctx, bool exclusive) const;

  /////////////////////////////////////////////////////////////////////////
  // SP-variables (parameters and variables).
  /////////////////////////////////////////////////////////////////////////

  /// @return the maximum number of variables used in this and all child
  /// contexts. For the root parsing context, this gives us the number of
  /// slots needed for variables during the runtime phase.
  uint max_var_index() const
  { return m_max_var_index; }

  /// @return the current number of variables used in the parent contexts
  /// (from the root), including this context.
  uint current_var_count() const
  { return m_var_offset + m_vars.elements(); }

  /// @return the number of variables in this context alone.
  uint context_var_count() const
  { return m_vars.elements(); }

  /// @return map index in this parsing context to runtime offset.
  uint var_context2runtime(uint i) const
  { return m_var_offset + i; }

  /// Add SP-variable to the parsing context.
  ///
  /// @param thd  Thread context.
  /// @param name Name of the SP-variable.
  ///
  /// @return instance of newly added SP-variable.
380
  sp_variable *add_variable(THD *thd, LEX_STRING name);
381 382 383 384 385

  /// Retrieve full type information about SP-variables in this parsing
  /// context and its children.
  ///
  /// @param field_def_lst[out] Container to store type information.
Alexander Barkov's avatar
Alexander Barkov committed
386
  void retrieve_field_definitions(List<Column_definition> *field_def_lst) const;
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441

  /// Find SP-variable by name.
  ///
  /// The function does a linear search (from newer to older variables,
  /// in case we have shadowed names).
  ///
  /// The function is called only at parsing time.
  ///
  /// @param name               Variable name.
  /// @param current_scope_only A flag if we search only in current scope.
  ///
  /// @return instance of found SP-variable, or NULL if not found.
  sp_variable *find_variable(LEX_STRING name, bool current_scope_only) const;

  /// Find SP-variable by the offset in the root parsing context.
  ///
  /// The function is used for two things:
  /// - When evaluating parameters at the beginning, and setting out parameters
  ///   at the end, of invocation. (Top frame only, so no recursion then.)
  /// - For printing of sp_instr_set. (Debug mode only.)
  ///
  /// @param offset Variable offset in the root parsing context.
  ///
  /// @return instance of found SP-variable, or NULL if not found.
  sp_variable *find_variable(uint offset) const;

  /// Set the current scope boundary (for default values).
  ///
  /// @param n The number of variables to skip.
  void declare_var_boundary(uint n)
  { m_pboundary= n; }

  /////////////////////////////////////////////////////////////////////////
  // CASE expressions.
  /////////////////////////////////////////////////////////////////////////

  int register_case_expr()
  { return m_num_case_exprs++; }

  int get_num_case_exprs() const
  { return m_num_case_exprs; }

  bool push_case_expr_id(int case_expr_id)
  { return m_case_expr_ids.append(case_expr_id); }

  void pop_case_expr_id()
  { m_case_expr_ids.pop(); }

  int get_current_case_expr_id() const
  { return *m_case_expr_ids.back(); }

  /////////////////////////////////////////////////////////////////////////
  // Labels.
  /////////////////////////////////////////////////////////////////////////

442 443 444 445 446 447 448
  sp_label *push_label(THD *thd, const LEX_STRING name, uint ip,
                       sp_label::enum_type type);

  sp_label *push_label(THD *thd, const LEX_STRING name, uint ip)
  {
    return push_label(thd, name, ip, sp_label::IMPLICIT);
  }
449

450
  sp_label *find_label(const LEX_STRING name);
451

452 453
  sp_label *find_label_current_loop_start();

454
  sp_label *last_label()
455
  {
456
    sp_label *label= m_labels.head();
457

458 459
    if (!label && m_parent)
      label= m_parent->last_label();
460

461
    return label;
462 463
  }

464 465 466
  sp_label *pop_label()
  { return m_labels.pop(); }

467 468 469 470 471 472 473 474 475 476 477
  bool block_label_declare(LEX_STRING label)
  {
    sp_label *lab= find_label(label);
    if (lab)
    {
      my_error(ER_SP_LABEL_REDEFINE, MYF(0), label.str);
      return true;
    }
    return false;
  }

478 479 480 481
  /////////////////////////////////////////////////////////////////////////
  // Conditions.
  /////////////////////////////////////////////////////////////////////////

482 483
  bool add_condition(THD *thd, const LEX_STRING name,
                               sp_condition_value *value);
484 485

  /// See comment for find_variable() above.
486
  sp_condition_value *find_condition(const LEX_STRING name,
487
                                     bool current_scope_only) const;
488 489 490 491 492 493 494 495 496 497

  sp_condition_value *
  find_declared_or_predefined_condition(const LEX_STRING name) const
  {
    sp_condition_value *p= find_condition(name, false);
    if (p)
      return p;
    return find_predefined_condition(name);
  }

498 499 500 501 502 503 504 505 506 507
  bool declare_condition(THD *thd, const LEX_STRING name,
                                   sp_condition_value *val)
  {
    if (find_condition(name, true))
    {
      my_error(ER_SP_DUP_COND, MYF(0), name.str);
      return true;
    }
    return add_condition(thd, name, val);
  }
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547

  /////////////////////////////////////////////////////////////////////////
  // Handlers.
  /////////////////////////////////////////////////////////////////////////

  sp_handler *add_handler(THD* thd, sp_handler::enum_type type);

  /// This is an auxilary parsing-time function to check if an SQL-handler
  /// exists in the current parsing context (current scope) for the given
  /// SQL-condition. This function is used to check for duplicates during
  /// the parsing phase.
  ///
  /// This function can not be used during the runtime phase to check
  /// SQL-handler existence because it searches for the SQL-handler in the
  /// current scope only (during runtime, current and parent scopes
  /// should be checked according to the SQL-handler resolution rules).
  ///
  /// @param condition_value the handler condition value
  ///                        (not SQL-condition!).
  ///
  /// @retval true if such SQL-handler exists.
  /// @retval false otherwise.
  bool check_duplicate_handler(const sp_condition_value *cond_value) const;

  /// Find an SQL handler for the given SQL condition according to the
  /// SQL-handler resolution rules. This function is used at runtime.
  ///
  /// @param sql_state        The SQL condition state
  /// @param sql_errno        The error code
  /// @param level            The SQL condition level
  ///
  /// @return a pointer to the found SQL-handler or NULL.
  sp_handler *find_handler(const char *sql_state,
                           uint sql_errno,
                           Sql_condition::enum_warning_level level) const;

  /////////////////////////////////////////////////////////////////////////
  // Cursors.
  /////////////////////////////////////////////////////////////////////////

548
  bool add_cursor(const LEX_STRING name);
549 550

  /// See comment for find_variable() above.
551 552
  bool find_cursor(const LEX_STRING name,
                   uint *poff, bool current_scope_only) const;
553 554 555 556 557 558 559 560 561

  /// Find cursor by offset (for debugging only).
  const LEX_STRING *find_cursor(uint offset) const;

  uint max_cursor_index() const
  { return m_max_cursor_index + m_cursors.elements(); }

  uint current_cursor_count() const
  { return m_cursor_offset + m_cursors.elements(); }
562

563 564 565 566 567 568 569 570 571
  void set_for_loop(const Lex_for_loop_st &for_loop)
  {
    m_for_loop.init(for_loop);
  }
  const Lex_for_loop_st &for_loop()
  {
    return m_for_loop;
  }

572 573 574 575 576
private:
  /// Constructor for a tree node.
  /// @param prev the parent parsing context
  /// @param scope scope of this parsing context
  sp_pcontext(sp_pcontext *prev, enum_scope scope);
577

578
  void init(uint var_offset, uint cursor_offset, int num_case_expressions);
579

580 581 582
  /* Prevent use of these */
  sp_pcontext(const sp_pcontext &);
  void operator=(sp_pcontext &);
583

584 585
  sp_condition_value *find_predefined_condition(const LEX_STRING name) const;

586
private:
587 588 589 590 591 592 593 594 595 596 597
  /// m_max_var_index -- number of variables (including all types of arguments)
  /// in this context including all children contexts.
  ///
  /// m_max_var_index >= m_vars.elements().
  ///
  /// m_max_var_index of the root parsing context contains number of all
  /// variables (including arguments) in all enclosed contexts.
  uint m_max_var_index;

  /// The maximum sub context's framesizes.
  uint m_max_cursor_index;
598

599 600
  /// Parent context.
  sp_pcontext *m_parent;
601

602 603 604 605 606 607
  /// An index of the first SP-variable in this parsing context. The index
  /// belongs to a runtime table of SP-variables.
  ///
  /// Note:
  ///   - m_var_offset is 0 for root parsing context;
  ///   - m_var_offset is different for all nested parsing contexts.
608
  uint m_var_offset;
609

610 611
  /// Cursor offset for this context.
  uint m_cursor_offset;
612

613 614 615 616
  /// Boundary for finding variables in this context. This is the number of
  /// variables currently "invisible" to default clauses. This is normally 0,
  /// but will be larger during parsing of DECLARE ... DEFAULT, to get the
  /// scope right for DEFAULT values.
617
  uint m_pboundary;
618

619 620
  int m_num_case_exprs;

621 622
  /// SP parameters/variables.
  Dynamic_array<sp_variable *> m_vars;
623

624 625
  /// Stack of CASE expression ids.
  Dynamic_array<int> m_case_expr_ids;
626

627 628
  /// Stack of SQL-conditions.
  Dynamic_array<sp_condition *> m_conditions;
629

630 631
  /// Stack of cursors.
  Dynamic_array<LEX_STRING> m_cursors;
632

633 634 635 636 637 638 639 640 641 642 643
  /// Stack of SQL-handlers.
  Dynamic_array<sp_handler *> m_handlers;

  /// List of labels.
  List<sp_label> m_labels;

  /// Children contexts, used for destruction.
  Dynamic_array<sp_pcontext *> m_children;

  /// Scope of this parsing context.
  enum_scope m_scope;
644 645 646

  /// FOR LOOP characteristics
  Lex_for_loop m_for_loop;
647 648 649 650
}; // class sp_pcontext : public Sql_alloc


#endif /* _SP_PCONTEXT_H_ */