rpl_record.cc 10.9 KB
Newer Older
unknown's avatar
unknown committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/* Copyright 2007 MySQL AB. 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */

#include "mysql_priv.h"
17
#include "rpl_rli.h"
unknown's avatar
unknown committed
18 19
#include "rpl_record.h"
#include "slave.h"                  // Need to pull in slave_print_msg
20 21
#include "rpl_utility.h"
#include "rpl_rli.h"
unknown's avatar
unknown committed
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

/**
   Pack a record of data for a table into a format suitable for
   transfer via the binary log.

   The format for a row in transfer with N fields is the following:

   ceil(N/8) null bytes:
       One null bit for every column *regardless of whether it can be
       null or not*. This simplifies the decoding. Observe that the
       number of null bits is equal to the number of set bits in the
       @c cols bitmap. The number of null bytes is the smallest number
       of bytes necessary to store the null bits.

       Padding bits are 1.

   N packets:
       Each field is stored in packed format.


   @param table    Table describing the format of the record

   @param cols     Bitmap with a set bit for each column that should
                   be stored in the row

   @param row_data Pointer to memory where row will be written

   @param record   Pointer to record that should be packed. It is
                   assumed that the pointer refers to either @c
                   record[0] or @c record[1], but no such check is
                   made since the code does not rely on that.

   @return The number of bytes written at @c row_data.
 */
56
#if !defined(MYSQL_CLIENT)
57
size_t
unknown's avatar
unknown committed
58
pack_row(TABLE *table, MY_BITMAP const* cols,
59
         uchar *row_data, const uchar *record)
unknown's avatar
unknown committed
60 61 62
{
  Field **p_field= table->field, *field;
  int const null_byte_count= (bitmap_bits_set(cols) + 7) / 8;
63 64
  uchar *pack_ptr = row_data + null_byte_count;
  uchar *null_ptr = row_data;
unknown's avatar
unknown committed
65 66 67
  my_ptrdiff_t const rec_offset= record - table->record[0];
  my_ptrdiff_t const def_offset= table->s->default_values - table->record[0];

68 69
  DBUG_ENTER("pack_row");

unknown's avatar
unknown committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
  /*
    We write the null bits and the packed records using one pass
    through all the fields. The null bytes are written little-endian,
    i.e., the first fields are in the first byte.
   */
  unsigned int null_bits= (1U << 8) - 1;
  // Mask to mask out the correct but among the null bits
  unsigned int null_mask= 1U;
  for ( ; (field= *p_field) ; p_field++)
  {
    DBUG_PRINT("debug", ("null_mask=%d; null_ptr=%p; row_data=%p; null_byte_count=%d",
                         null_mask, null_ptr, row_data, null_byte_count));
    if (bitmap_is_set(cols, p_field - table->field))
    {
      my_ptrdiff_t offset;
      if (field->is_null(rec_offset))
      {
        offset= def_offset;
        null_bits |= null_mask;
      }
      else
      {
        offset= rec_offset;
        null_bits &= ~null_mask;

        /*
          We only store the data of the field if it is non-null
97 98 99 100 101

          For big-endian machines, we have to make sure that the
          length is stored in little-endian format, since this is the
          format used for the binlog.
        */
102
#ifndef DBUG_OFF
103
        const uchar *old_pack_ptr= pack_ptr;
104
#endif
105 106 107 108 109
        pack_ptr= field->pack(pack_ptr, field->ptr + offset,
                              field->max_data_length(), TRUE);
        DBUG_PRINT("debug", ("field: %s; pack_ptr: 0x%lx;"
                             " pack_ptr':0x%lx; bytes: %d",
                             field->field_name, (ulong) old_pack_ptr,
110 111
                             (ulong) pack_ptr,
                             (int) (pack_ptr - old_pack_ptr)));
unknown's avatar
unknown committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
      }

      null_mask <<= 1;
      if ((null_mask & 0xFF) == 0)
      {
        DBUG_ASSERT(null_ptr < row_data + null_byte_count);
        null_mask = 1U;
        *null_ptr++ = null_bits;
        null_bits= (1U << 8) - 1;
      }
    }
  }

  /*
    Write the last (partial) byte, if there is one
  */
  if ((null_mask & 0xFF) > 1)
  {
    DBUG_ASSERT(null_ptr < row_data + null_byte_count);
    *null_ptr++ = null_bits;
  }

  /*
    The null pointer should now point to the first byte of the
    packed data. If it doesn't, something is very wrong.
  */
  DBUG_ASSERT(null_ptr == row_data + null_byte_count);
139 140
  DBUG_DUMP("row_data", row_data, pack_ptr - row_data);
  DBUG_RETURN(static_cast<size_t>(pack_ptr - row_data));
unknown's avatar
unknown committed
141
}
142
#endif
unknown's avatar
unknown committed
143 144 145 146 147 148 149 150 151 152


/**
   Unpack a row into @c table->record[0].

   The function will always unpack into the @c table->record[0]
   record.  This is because there are too many dependencies on where
   the various member functions of Field and subclasses expect to
   write.

153 154
   The row is assumed to only consist of the fields for which the corresponding
   bit in bitset @c cols is set; the other parts of the record are left alone.
unknown's avatar
unknown committed
155 156 157 158 159 160 161

   At most @c colcnt columns are read: if the table is larger than
   that, the remaining fields are not filled in.

   @param rli     Relay log info
   @param table   Table to unpack into
   @param colcnt  Number of columns to read from record
162 163
   @param row_data
                  Packed row data
164
   @param cols    Pointer to bitset describing columns to fill in
unknown's avatar
unknown committed
165 166 167 168 169 170 171 172 173 174 175 176 177
   @param row_end Pointer to variable that will hold the value of the
                  one-after-end position for the row
   @param master_reclength
                  Pointer to variable that will be set to the length of the
                  record on the master side

   @retval 0 No error

   @retval ER_NO_DEFAULT_FOR_FIELD
   Returned if one of the fields existing on the slave but not on the
   master does not have a default value (and isn't nullable)

 */
178
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
unknown's avatar
unknown committed
179
int
180
unpack_row(Relay_log_info const *rli,
unknown's avatar
unknown committed
181
           TABLE *table, uint const colcnt,
182
           uchar const *const row_data, MY_BITMAP const *cols,
183
           uchar const **const row_end, ulong *const master_reclength)
unknown's avatar
unknown committed
184 185 186
{
  DBUG_ENTER("unpack_row");
  DBUG_ASSERT(row_data);
187
  size_t const master_null_byte_count= (bitmap_bits_set(cols) + 7) / 8;
unknown's avatar
unknown committed
188 189
  int error= 0;

190 191
  uchar const *null_ptr= row_data;
  uchar const *pack_ptr= row_data + master_null_byte_count;
unknown's avatar
unknown committed
192 193 194 195 196 197 198 199 200 201 202

  Field **const begin_ptr = table->field;
  Field **field_ptr;
  Field **const end_ptr= begin_ptr + colcnt;

  DBUG_ASSERT(null_ptr < row_data + master_null_byte_count);

  // Mask to mask out the correct bit among the null bits
  unsigned int null_mask= 1U;
  // The "current" null bits
  unsigned int null_bits= *null_ptr++;
203
  uint i= 0;
204
  table_def *tabledef= ((Relay_log_info*)rli)->get_tabledef(table);
205
  for (field_ptr= begin_ptr ; field_ptr < end_ptr && *field_ptr ; ++field_ptr)
unknown's avatar
unknown committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
  {
    Field *const f= *field_ptr;

    /*
      No need to bother about columns that does not exist: they have
      gotten default values when being emptied above.
     */
    if (bitmap_is_set(cols, field_ptr -  begin_ptr))
    {
      if ((null_mask & 0xFF) == 0)
      {
        DBUG_ASSERT(null_ptr < row_data + master_null_byte_count);
        null_mask= 1U;
        null_bits= *null_ptr++;
      }

      DBUG_ASSERT(null_mask & 0xFF); // One of the 8 LSB should be set

      /* Field...::unpack() cannot return 0 */
      DBUG_ASSERT(pack_ptr != NULL);

      if ((null_bits & null_mask) && f->maybe_null())
        f->set_null();
      else
      {
        f->set_notnull();

        /*
234 235 236
          We only unpack the field if it was non-null.
          Use the master's size information if available else call
          normal unpack operation.
237 238
        */
        uint16 const metadata= tabledef->field_metadata(i);
239
#ifndef DBUG_OFF
240
        uchar const *const old_pack_ptr= pack_ptr;
241
#endif
242 243 244 245 246
        pack_ptr= f->unpack(f->ptr, pack_ptr, metadata, TRUE);
	DBUG_PRINT("debug", ("field: %s; metadata: 0x%x;"
                             " pack_ptr: 0x%lx; pack_ptr': 0x%lx; bytes: %d",
                             f->field_name, metadata,
                             (ulong) old_pack_ptr, (ulong) pack_ptr,
247
                             (int) (pack_ptr - old_pack_ptr)));
unknown's avatar
unknown committed
248 249 250 251
      }

      null_mask <<= 1;
    }
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    i++;
  }

  /*
    throw away master's extra fields
  */
  uint max_cols= min(tabledef->size(), cols->n_bits);
  for (; i < max_cols; i++)
  {
    if (bitmap_is_set(cols, i))
    {
      if ((null_mask & 0xFF) == 0)
      {
        DBUG_ASSERT(null_ptr < row_data + master_null_byte_count);
        null_mask= 1U;
        null_bits= *null_ptr++;
      }
      DBUG_ASSERT(null_mask & 0xFF); // One of the 8 LSB should be set

      if (!((null_bits & null_mask) && tabledef->maybe_null(i)))
        pack_ptr+= tabledef->calc_field_size(i, (uchar *) pack_ptr);
      null_mask <<= 1;
    }
unknown's avatar
unknown committed
275 276 277 278 279 280 281 282
  }

  /*
    We should now have read all the null bytes, otherwise something is
    really wrong.
   */
  DBUG_ASSERT(null_ptr == row_data + master_null_byte_count);

283 284
  DBUG_DUMP("row_data", row_data, pack_ptr - row_data);

unknown's avatar
unknown committed
285 286 287 288
  *row_end = pack_ptr;
  if (master_reclength)
  {
    if (*field_ptr)
289
      *master_reclength = (*field_ptr)->ptr - table->record[0];
unknown's avatar
unknown committed
290 291 292
    else
      *master_reclength = table->s->reclength;
  }
293 294 295
  
  DBUG_RETURN(error);
}
unknown's avatar
unknown committed
296

297 298 299
/**
  Fills @c table->record[0] with default values.

300 301 302 303
  First @c restore_record() is called to restore the default values for
  record concerning the given table. Then, if @c check is true, 
  a check is performed to see if fields are have default value or can 
  be NULL. Otherwise error is reported.
304 305
 
  @param table  Table whose record[0] buffer is prepared. 
306
  @param skip   Number of columns for which default/nullable check 
307
                should be skipped.
308 309
  @param check  Indicates if errors should be raised when checking 
                default/nullable field properties.
310
                
311
  @returns 0 on success or a handler level error code
312
 */ 
313
int prepare_record(TABLE *const table, 
314 315 316 317 318
                   const uint skip, const bool check)
{
  DBUG_ENTER("prepare_record");

  int error= 0;
319
  restore_record(table, s->default_values);
320

321 322 323 324 325 326
  /*
     This skip should be revisited in 6.0, because in 6.0 RBR one 
     can have holes in the row (as the grain of the writeset is 
     the column and not the entire row).
   */
  if (skip >= table->s->fields || !check)
327 328
    DBUG_RETURN(0);

329
  /* Checking if exists default/nullable fields in the default values. */
330 331

  for (Field **field_ptr= table->field+skip ; *field_ptr ; ++field_ptr)
unknown's avatar
unknown committed
332 333 334 335
  {
    uint32 const mask= NOT_NULL_FLAG | NO_DEFAULT_VALUE_FLAG;
    Field *const f= *field_ptr;

336
    if (((f->flags & mask) == mask))
unknown's avatar
unknown committed
337
    {
338 339
      my_error(ER_NO_DEFAULT_FOR_FIELD, MYF(0), f->field_name);
      error = HA_ERR_ROWS_EVENT_APPLY;
unknown's avatar
unknown committed
340 341 342 343 344 345 346
    }
  }

  DBUG_RETURN(error);
}

#endif // HAVE_REPLICATION