structs.h 11.5 KB
Newer Older
1
/* Copyright (C) 2000-2006 MySQL AB
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
2

bk@work.mysql.com's avatar
bk@work.mysql.com committed
3 4
   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
5
   the Free Software Foundation; version 2 of the License.
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
6

bk@work.mysql.com's avatar
bk@work.mysql.com committed
7 8 9 10
   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.
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
11

bk@work.mysql.com's avatar
bk@work.mysql.com committed
12 13 14 15 16 17 18
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */


/* The old structures from unireg */

Konstantin Osipov's avatar
Konstantin Osipov committed
19
struct TABLE;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
20
class Field;
Konstantin Osipov's avatar
Konstantin Osipov committed
21
class THD;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
22

23 24 25 26 27 28
typedef struct st_date_time_format {
  uchar positions[8];
  char  time_separator;			/* Separator between hour and minute */
  uint flag;				/* For future */
  LEX_STRING format;
} DATE_TIME_FORMAT;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
29 30 31


typedef struct st_keyfile_info {	/* used with ha_info() */
32 33
  uchar ref[MAX_REFLENGTH];		/* Pointer to current row */
  uchar dupp_ref[MAX_REFLENGTH];	/* Pointer to dupp row */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
  uint ref_length;			/* Length of ref (1-8) */
  uint block_size;			/* index block size */
  File filenr;				/* (uniq) filenr for table */
  ha_rows records;			/* Records i datafilen */
  ha_rows deleted;			/* Deleted records */
  ulonglong data_file_length;		/* Length off data file */
  ulonglong max_data_file_length;	/* Length off data file */
  ulonglong index_file_length;
  ulonglong max_index_file_length;
  ulonglong delete_length;		/* Free bytes */
  ulonglong auto_increment_value;
  int errkey,sortkey;			/* Last errorkey and sorted by */
  time_t create_time;			/* When table was created */
  time_t check_time;
  time_t update_time;
  ulong mean_rec_length;		/* physical reclength */
} KEYFILE_INFO;


typedef struct st_key_part_info {	/* Info about a key part */
  Field *field;
  uint	offset;				/* offset in record (from 0) */
salle@geopard.online.bg's avatar
salle@geopard.online.bg committed
56
  uint	null_offset;			/* Offset to null_bit in record */
57 58 59 60 61 62 63
  uint16 length;                        /* Length of keypart value in bytes */
  /* 
    Number of bytes required to store the keypart value. This may be
    different from the "length" field as it also counts
     - possible NULL-flag byte (see HA_KEY_NULL_LENGTH)
     - possible HA_KEY_BLOB_LENGTH bytes needed to store actual value length.
  */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
64 65 66
  uint16 store_length;
  uint16 key_type;
  uint16 fieldnr;			/* Fieldnum in UNIREG */
monty@mysql.com's avatar
monty@mysql.com committed
67
  uint16 key_part_flag;			/* 0 or HA_REVERSE_SORT */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
68
  uint8 type;
salle@geopard.online.bg's avatar
salle@geopard.online.bg committed
69
  uint8 null_bit;			/* Position to null_bit */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
70 71 72 73 74
} KEY_PART_INFO ;


typedef struct st_key {
  uint	key_length;			/* Tot length of key */
75
  ulong flags;                          /* dupp key and pack flags */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
76 77 78
  uint	key_parts;			/* How many key_parts */
  uint  extra_length;
  uint	usable_key_parts;		/* Should normally be = key_parts */
79
  uint  block_size;
80
  enum  ha_key_alg algorithm;
81 82 83 84 85 86
  /*
    Note that parser is used when the table is opened for use, and
    parser_name is used when the table is being created.
  */
  union
  {
antony@ppcg5.local's avatar
antony@ppcg5.local committed
87
    plugin_ref parser;                  /* Fulltext [pre]parser */
88 89
    LEX_STRING *parser_name;            /* Fulltext [pre]parser name */
  };
bk@work.mysql.com's avatar
bk@work.mysql.com committed
90 91
  KEY_PART_INFO *key_part;
  char	*name;				/* Name of key */
92 93 94 95 96 97
  /*
    Array of AVG(#records with the same field value) for 1st ... Nth key part.
    0 means 'not known'.
    For temporary heap tables this member is NULL.
  */
  ulong *rec_per_key;
98
  union {
99
    int  bdb_return_if_eq;
100
  } handler;
Konstantin Osipov's avatar
Konstantin Osipov committed
101
  TABLE *table;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
102 103 104 105 106 107 108 109 110
} KEY;


struct st_join_table;

typedef struct st_reginfo {		/* Extra info about reg */
  struct st_join_table *join_tab;	/* Used by SELECT() */
  enum thr_lock_type lock_type;		/* How database is used */
  bool not_exists_optimize;
111 112 113 114
  /*
    TRUE <=> range optimizer found that there is no rows satisfying
    table conditions.
  */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
115 116 117 118
  bool impossible_range;
} REGINFO;


119
/*
120
  Originally MySQL used MYSQL_TIME structure inside server only, but since
121 122 123 124 125
  4.1 it's exported to user in the new client API. Define aliases for
  new names to keep existing code simple.
*/

typedef enum enum_mysql_timestamp_type timestamp_type;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
126

127

bk@work.mysql.com's avatar
bk@work.mysql.com committed
128
typedef struct {
129 130
  ulong year,month,day,hour;
  ulonglong minute,second,second_part;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
131 132 133 134
  bool neg;
} INTERVAL;


135 136 137 138 139 140 141
typedef struct st_known_date_time_format {
  const char *format_name;
  const char *date_format;
  const char *datetime_format;
  const char *time_format;
} KNOWN_DATE_TIME_FORMAT;

142
enum SHOW_COMP_OPTION { SHOW_OPTION_YES, SHOW_OPTION_NO, SHOW_OPTION_DISABLED};
143 144 145

extern const char *show_comp_option_name[];

146
typedef int *(*update_var)(THD *, struct st_mysql_show_var *);
147

bk@work.mysql.com's avatar
bk@work.mysql.com committed
148 149 150 151
typedef struct	st_lex_user {
  LEX_STRING user, host, password;
} LEX_USER;

152 153 154 155 156
/*
  This structure specifies the maximum amount of resources which
  can be consumed by each account. Zero value of a member means
  there is no limit.
*/
157
typedef struct user_resources {
158 159 160 161
  /* Maximum number of queries/statements per hour. */
  uint questions;
  /*
     Maximum number of updating statements per hour (which statements are
162
     updating is defined by sql_command_flags array).
163 164 165 166 167 168 169 170 171 172 173 174 175
  */
  uint updates;
  /* Maximum number of connections established per hour. */
  uint conn_per_hour;
  /* Maximum number of concurrent connections. */
  uint user_conn;
  /*
     Values of this enum and specified_limits member are used by the
     parser to store which user limits were specified in GRANT statement.
  */
  enum {QUERIES_PER_HOUR= 1, UPDATES_PER_HOUR= 2, CONNECTIONS_PER_HOUR= 4,
        USER_CONNECTIONS= 8};
  uint specified_limits;
176 177
} USER_RESOURCES;

178 179 180 181 182

/*
  This structure is used for counting resources consumed and for checking
  them against specified user limits.
*/
183
typedef struct  user_conn {
184 185 186 187 188 189 190 191 192
  /*
     Pointer to user+host key (pair separated by '\0') defining the entity
     for which resources are counted (By default it is user account thus
     priv_user/priv_host pair is used. If --old-style-user-limits option
     is enabled, resources are counted for each user+host separately).
  */
  char *user;
  /* Pointer to host part of the key. */
  char *host;
193
  /**
194 195 196 197
     The moment of time when per hour counters were reset last time
     (i.e. start of "hour" for conn_per_hour, updates, questions counters).
  */
  ulonglong reset_utime;
198 199 200 201 202 203 204 205 206 207
  /* Total length of the key. */
  uint len;
  /* Current amount of concurrent connections for this account. */
  uint connections;
  /*
     Current number of connections per hour, number of updating statements
     per hour and total number of statements per hour for this account.
  */
  uint conn_per_hour, updates, questions;
  /* Maximum amount of resources which account is allowed to consume. */
208 209
  USER_RESOURCES user_resources;
} USER_CONN;
210

bk@work.mysql.com's avatar
bk@work.mysql.com committed
211 212 213 214 215
	/* Bits in form->update */
#define REG_MAKE_DUPP		1	/* Make a copy of record when read */
#define REG_NEW_RECORD		2	/* Write a new record if not found */
#define REG_UPDATE		4	/* Uppdate record */
#define REG_DELETE		8	/* Delete found record */
paul@teton.kitebird.com's avatar
paul@teton.kitebird.com committed
216
#define REG_PROG		16	/* User is updating database */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
217 218 219 220
#define REG_CLEAR_AFTER_WRITE	32
#define REG_MAY_BE_UPDATED	64
#define REG_AUTO_UPDATE		64	/* Used in D-forms for scroll-tables */
#define REG_OVERWRITE		128
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
221
#define REG_SKIP_DUP		256
bk@work.mysql.com's avatar
bk@work.mysql.com committed
222 223 224 225

	/* Bits in form->status */
#define STATUS_NO_RECORD	(1+2)	/* Record isn't usably */
#define STATUS_GARBAGE		1
226
#define STATUS_NOT_FOUND	2	/* No record in database when needed */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
227 228 229
#define STATUS_NO_PARENT	4	/* Parent record wasn't found */
#define STATUS_NOT_READ		8	/* Record isn't read */
#define STATUS_UPDATED		16	/* Record is updated by formula */
230
#define STATUS_NULL_ROW		32	/* table->null_row is set */
231
#define STATUS_DELETED		64
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297

/*
  Such interval is "discrete": it is the set of
  { auto_inc_interval_min + k * increment,
    0 <= k <= (auto_inc_interval_values-1) }
  Where "increment" is maintained separately by the user of this class (and is
  currently only thd->variables.auto_increment_increment).
  It mustn't derive from Sql_alloc, because SET INSERT_ID needs to
  allocate memory which must stay allocated for use by the next statement.
*/
class Discrete_interval {
private:
  ulonglong interval_min;
  ulonglong interval_values;
  ulonglong  interval_max;    // excluded bound. Redundant.
public:
  Discrete_interval *next;    // used when linked into Discrete_intervals_list
  void replace(ulonglong start, ulonglong val, ulonglong incr)
  {
    interval_min=    start;
    interval_values= val;
    interval_max=    (val == ULONGLONG_MAX) ? val : start + val * incr;
  }
  Discrete_interval(ulonglong start, ulonglong val, ulonglong incr) :
    next(NULL) { replace(start, val, incr); };
  Discrete_interval() : next(NULL) { replace(0, 0, 0); };
  ulonglong minimum() const { return interval_min;    };
  ulonglong values()  const { return interval_values; };
  ulonglong maximum() const { return interval_max;    };
  /*
    If appending [3,5] to [1,2], we merge both in [1,5] (they should have the
    same increment for that, user of the class has to ensure that). That is
    just a space optimization. Returns 0 if merge succeeded.
  */
  bool merge_if_contiguous(ulonglong start, ulonglong val, ulonglong incr)
  {
    if (interval_max == start)
    {
      if (val == ULONGLONG_MAX)
      {
        interval_values=   interval_max= val;
      }
      else
      {
        interval_values+=  val;
        interval_max=      start + val * incr;
      }
      return 0;
    }
    return 1;
  };
};

/* List of Discrete_interval objects */
class Discrete_intervals_list {
private:
  Discrete_interval        *head;
  Discrete_interval        *tail;
  /*
    When many intervals are provided at the beginning of the execution of a
    statement (in a replication slave or SET INSERT_ID), "current" points to
    the interval being consumed by the thread now (so "current" goes from
    "head" to "tail" then to NULL).
  */
  Discrete_interval        *current;
  uint                  elements; // number of elements
298 299 300 301 302 303 304
  void set_members(Discrete_interval *h, Discrete_interval *t,
                   Discrete_interval *c, uint el)
  {  
    head= h;
    tail= t;
    current= c;
    elements= el;
305
  }
306 307 308
  void operator=(Discrete_intervals_list &);  /* prevent use of these */
  Discrete_intervals_list(const Discrete_intervals_list &);

309 310 311 312
public:
  Discrete_intervals_list() : head(NULL), current(NULL), elements(0) {};
  void empty_no_free()
  {
313
    set_members(NULL, NULL, NULL, 0);
314 315 316 317 318 319 320 321 322 323 324
  }
  void empty()
  {
    for (Discrete_interval *i= head; i;)
    {
      Discrete_interval *next= i->next;
      delete i;
      i= next;
    }
    empty_no_free();
  }
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
  void copy_shallow(const Discrete_intervals_list * dli)
  {
    head= dli->get_head();
    tail= dli->get_tail();
    current= dli->get_current();
    elements= dli->nb_elements();
  }
  void swap (Discrete_intervals_list * dli)
  {
    Discrete_interval *h, *t, *c;
    uint el;
    h= dli->get_head();
    t= dli->get_tail();
    c= dli->get_current();
    el= dli->nb_elements();
    dli->copy_shallow(this);
    set_members(h, t, c, el);
  }
343 344 345 346 347 348 349 350 351
  const Discrete_interval* get_next()
  {
    Discrete_interval *tmp= current;
    if (current != NULL)
      current= current->next;
    return tmp;
  }
  ~Discrete_intervals_list() { empty(); };
  bool append(ulonglong start, ulonglong val, ulonglong incr);
352
  bool append(Discrete_interval *interval);
353 354 355
  ulonglong minimum()     const { return (head ? head->minimum() : 0); };
  ulonglong maximum()     const { return (head ? tail->maximum() : 0); };
  uint      nb_elements() const { return elements; }
356 357 358
  Discrete_interval* get_head() const { return head; };
  Discrete_interval* get_tail() const { return tail; };
  Discrete_interval* get_current() const { return current; };
359
};