← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/rpl_utility.h

  • Committer: Andy Lester
  • Date: 2008-08-09 05:23:39 UTC
  • mto: (266.1.29 use-replace-funcs)
  • mto: This revision was merged to the branch mainline in revision 287.
  • Revision ID: andy@petdance.com-20080809052339-iafoesszmesweq6b
use NULL, not 0

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/rpl_utility.h
 
1
/* Copyright (C) 2006 MySQL AB
 
2
 
 
3
   This program is free software; you can redistribute it and/or modify
 
4
   it under the terms of the GNU General Public License as published by
 
5
   the Free Software Foundation; version 2 of the License.
 
6
 
 
7
   This program is distributed in the hope that it will be useful,
 
8
   but WITHOUT ANY WARRANTY; without even the implied warranty of
 
9
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
10
   GNU General Public License for more details.
 
11
 
 
12
   You should have received a copy of the GNU General Public License
 
13
   along with this program; if not, write to the Free Software
 
14
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA */
 
15
 
 
16
#ifndef RPL_UTILITY_H
 
17
#define RPL_UTILITY_H
 
18
 
 
19
#ifndef __cplusplus
 
20
#error "Don't include this C++ header file from a non-C++ file!"
 
21
#endif
 
22
 
 
23
#include <drizzled/server_includes.h>
 
24
 
 
25
class Relay_log_info;
 
26
 
 
27
 
 
28
/**
 
29
  A table definition from the master.
 
30
 
 
31
  The responsibilities of this class is:
 
32
  - Extract and decode table definition data from the table map event
 
33
  - Check if table definition in table map is compatible with table
 
34
    definition on slave
 
35
 
 
36
  Currently, the only field type data available is an array of the
 
37
  type operators that are present in the table map event.
 
38
 
 
39
  @todo Add type operands to this structure to allow detection of
 
40
     difference between, e.g., BIT(5) and BIT(10).
 
41
 */
 
42
 
 
43
class table_def
 
44
{
 
45
public:
 
46
  /**
 
47
    Convenience declaration of the type of the field type data in a
 
48
    table map event.
 
49
  */
 
50
  typedef unsigned char field_type;
 
51
 
 
52
  /**
 
53
    Constructor.
 
54
 
 
55
    @param types Array of types
 
56
    @param size  Number of elements in array 'types'
 
57
    @param field_metadata Array of extra information about fields
 
58
    @param metadata_size Size of the field_metadata array
 
59
    @param null_bitmap The bitmap of fields that can be null
 
60
   */
 
61
  table_def(field_type *types, uint32_t size, unsigned char *field_metadata, 
 
62
      int metadata_size, unsigned char *null_bitmap)
 
63
    : m_size(size), m_type(0), m_field_metadata_size(metadata_size),
 
64
      m_field_metadata(0), m_null_bits(0), m_memory(NULL)
 
65
  {
 
66
    m_memory= (unsigned char *)my_multi_malloc(MYF(MY_WME),
 
67
                                       &m_type, size,
 
68
                                       &m_field_metadata,
 
69
                                       size * sizeof(uint16_t),
 
70
                                       &m_null_bits, (size + 7) / 8,
 
71
                                       NULL);
 
72
 
 
73
    memset(m_field_metadata, 0, size * sizeof(uint16_t));
 
74
 
 
75
    if (m_type)
 
76
      memcpy(m_type, types, size);
 
77
    else
 
78
      m_size= 0;
 
79
    /*
 
80
      Extract the data from the table map into the field metadata array
 
81
      iff there is field metadata. The variable metadata_size will be
 
82
      0 if we are replicating from an older version server since no field
 
83
      metadata was written to the table map. This can also happen if 
 
84
      there were no fields in the master that needed extra metadata.
 
85
    */
 
86
    if (m_size && metadata_size)
 
87
    { 
 
88
      int index= 0;
 
89
      for (unsigned int i= 0; i < m_size; i++)
 
90
      {
 
91
        switch (m_type[i]) {
 
92
        case DRIZZLE_TYPE_BLOB:
 
93
        case DRIZZLE_TYPE_DOUBLE:
 
94
        {
 
95
          /*
 
96
            These types store a single byte.
 
97
          */
 
98
          m_field_metadata[i]= field_metadata[index];
 
99
          index++;
 
100
          break;
 
101
        }
 
102
        case DRIZZLE_TYPE_SET:
 
103
        case DRIZZLE_TYPE_ENUM:
 
104
        {
 
105
          uint16_t x= field_metadata[index++] << 8U; // real_type
 
106
          x+= field_metadata[index++];            // pack or field length
 
107
          m_field_metadata[i]= x;
 
108
          break;
 
109
        }
 
110
        case DRIZZLE_TYPE_VARCHAR:
 
111
        {
 
112
          /*
 
113
            These types store two bytes.
 
114
          */
 
115
          char *ptr= (char *)&field_metadata[index];
 
116
          m_field_metadata[i]= uint2korr(ptr);
 
117
          index= index + 2;
 
118
          break;
 
119
        }
 
120
        case DRIZZLE_TYPE_NEWDECIMAL:
 
121
        {
 
122
          uint16_t x= field_metadata[index++] << 8U; // precision
 
123
          x+= field_metadata[index++];            // decimals
 
124
          m_field_metadata[i]= x;
 
125
          break;
 
126
        }
 
127
        default:
 
128
          m_field_metadata[i]= 0;
 
129
          break;
 
130
        }
 
131
      }
 
132
    }
 
133
    if (m_size && null_bitmap)
 
134
       memcpy(m_null_bits, null_bitmap, (m_size + 7) / 8);
 
135
  }
 
136
 
 
137
  ~table_def() {
 
138
    my_free(m_memory, MYF(0));
 
139
    m_type= 0;
 
140
    m_size= 0;
 
141
  }
 
142
 
 
143
  /**
 
144
    Return the number of fields there is type data for.
 
145
 
 
146
    @return The number of fields that there is type data for.
 
147
   */
 
148
  uint32_t size() const { return m_size; }
 
149
 
 
150
 
 
151
  /*
 
152
    Return a representation of the type data for one field.
 
153
 
 
154
    @param index Field index to return data for
 
155
 
 
156
    @return Will return a representation of the type data for field
 
157
    <code>index</code>. Currently, only the type identifier is
 
158
    returned.
 
159
   */
 
160
  field_type type(uint32_t index) const
 
161
  {
 
162
    assert(index < m_size);
 
163
    return m_type[index];
 
164
  }
 
165
 
 
166
 
 
167
  /*
 
168
    This function allows callers to get the extra field data from the
 
169
    table map for a given field. If there is no metadata for that field
 
170
    or there is no extra metadata at all, the function returns 0.
 
171
 
 
172
    The function returns the value for the field metadata for column at 
 
173
    position indicated by index. As mentioned, if the field was a type 
 
174
    that stores field metadata, that value is returned else zero (0) is 
 
175
    returned. This method is used in the unpack() methods of the 
 
176
    corresponding fields to properly extract the data from the binary log 
 
177
    in the event that the master's field is smaller than the slave.
 
178
  */
 
179
  uint16_t field_metadata(uint32_t index) const
 
180
  {
 
181
    assert(index < m_size);
 
182
    if (m_field_metadata_size)
 
183
      return m_field_metadata[index];
 
184
    else
 
185
      return 0;
 
186
  }
 
187
 
 
188
  /*
 
189
    This function returns whether the field on the master can be null.
 
190
    This value is derived from field->maybe_null().
 
191
  */
 
192
  my_bool maybe_null(uint32_t index) const
 
193
  {
 
194
    assert(index < m_size);
 
195
    return ((m_null_bits[(index / 8)] & 
 
196
            (1 << (index % 8))) == (1 << (index %8)));
 
197
  }
 
198
 
 
199
  /*
 
200
    This function returns the field size in raw bytes based on the type
 
201
    and the encoded field data from the master's raw data. This method can 
 
202
    be used for situations where the slave needs to skip a column (e.g., 
 
203
    WL#3915) or needs to advance the pointer for the fields in the raw 
 
204
    data from the master to a specific column.
 
205
  */
 
206
  uint32_t calc_field_size(uint32_t col, unsigned char *master_data) const;
 
207
 
 
208
  /**
 
209
    Decide if the table definition is compatible with a table.
 
210
 
 
211
    Compare the definition with a table to see if it is compatible
 
212
    with it.
 
213
 
 
214
    A table definition is compatible with a table if:
 
215
      - the columns types of the table definition is a (not
 
216
        necessarily proper) prefix of the column type of the table, or
 
217
      - the other way around
 
218
 
 
219
    @param rli   Pointer to relay log info
 
220
    @param table Pointer to table to compare with.
 
221
 
 
222
    @retval 1  if the table definition is not compatible with @c table
 
223
    @retval 0  if the table definition is compatible with @c table
 
224
  */
 
225
  int compatible_with(Relay_log_info const *rli, TABLE *table) const;
 
226
 
 
227
private:
 
228
  uint32_t m_size;           // Number of elements in the types array
 
229
  field_type *m_type;                     // Array of type descriptors
 
230
  uint32_t m_field_metadata_size;
 
231
  uint16_t *m_field_metadata;
 
232
  unsigned char *m_null_bits;
 
233
  unsigned char *m_memory;
 
234
};
 
235
 
 
236
/**
 
237
   Extend the normal table list with a few new fields needed by the
 
238
   slave thread, but nowhere else.
 
239
 */
 
240
struct RPL_TABLE_LIST
 
241
  : public TABLE_LIST
 
242
{
 
243
  bool m_tabledef_valid;
 
244
  table_def m_tabledef;
 
245
};
 
246
 
 
247
 
 
248
/* Anonymous namespace for template functions/classes */
 
249
namespace {
 
250
 
 
251
  /*
 
252
    Smart pointer that will automatically call my_afree (a macro) when
 
253
    the pointer goes out of scope.  This is used so that I do not have
 
254
    to remember to call my_afree() before each return.  There is no
 
255
    overhead associated with this, since all functions are inline.
 
256
 
 
257
    I (Matz) would prefer to use the free function as a template
 
258
    parameter, but that is not possible when the "function" is a
 
259
    macro.
 
260
  */
 
261
  template <class Obj>
 
262
  class auto_afree_ptr
 
263
  {
 
264
    Obj* m_ptr;
 
265
  public:
 
266
    auto_afree_ptr(Obj* ptr) : m_ptr(ptr) { }
 
267
    ~auto_afree_ptr() { if (m_ptr) my_afree(m_ptr); }
 
268
    void assign(Obj* ptr) {
 
269
      /* Only to be called if it hasn't been given a value before. */
 
270
      assert(m_ptr == NULL);
 
271
      m_ptr= ptr;
 
272
    }
 
273
    Obj* get() { return m_ptr; }
 
274
  };
 
275
 
 
276
}
 
277
 
 
278
#endif /* RPL_UTILITY_H */