ha_archive.cpp
上传用户:romrleung
上传日期:2022-05-23
资源大小:18897k
文件大小:29k
源码类别:

MySQL数据库

开发平台:

Visual C++

  1. /* Copyright (C) 2003 MySQL AB
  2.   This program is free software; you can redistribute it and/or modify
  3.   it under the terms of the GNU General Public License as published by
  4.   the Free Software Foundation; either version 2 of the License, or
  5.   (at your option) any later version.
  6.   This program is distributed in the hope that it will be useful,
  7.   but WITHOUT ANY WARRANTY; without even the implied warranty of
  8.   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  9.   GNU General Public License for more details.
  10.   You should have received a copy of the GNU General Public License
  11.   along with this program; if not, write to the Free Software
  12.   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
  13. #ifdef USE_PRAGMA_IMPLEMENTATION
  14. #pragma implementation        // gcc: Class implementation
  15. #endif
  16. #include "../mysql_priv.h"
  17. #ifdef HAVE_ARCHIVE_DB
  18. #include "ha_archive.h"
  19. /*
  20.   First, if you want to understand storage engines you should look at 
  21.   ha_example.cc and ha_example.h. 
  22.   This example was written as a test case for a customer who needed
  23.   a storage engine without indexes that could compress data very well.
  24.   So, welcome to a completely compressed storage engine. This storage
  25.   engine only does inserts. No replace, deletes, or updates. All reads are 
  26.   complete table scans. Compression is done through gzip (bzip compresses
  27.   better, but only marginally, if someone asks I could add support for
  28.   it too, but beaware that it costs a lot more in CPU time then gzip).
  29.   
  30.   We keep a file pointer open for each instance of ha_archive for each read
  31.   but for writes we keep one open file handle just for that. We flush it
  32.   only if we have a read occur. gzip handles compressing lots of records
  33.   at once much better then doing lots of little records between writes.
  34.   It is possible to not lock on writes but this would then mean we couldn't
  35.   handle bulk inserts as well (that is if someone was trying to read at
  36.   the same time since we would want to flush).
  37.   A "meta" file is kept alongside the data file. This file serves two purpose.
  38.   The first purpose is to track the number of rows in the table. The second 
  39.   purpose is to determine if the table was closed properly or not. When the 
  40.   meta file is first opened it is marked as dirty. It is opened when the table 
  41.   itself is opened for writing. When the table is closed the new count for rows 
  42.   is written to the meta file and the file is marked as clean. If the meta file 
  43.   is opened and it is marked as dirty, it is assumed that a crash occured. At 
  44.   this point an error occurs and the user is told to rebuild the file.
  45.   A rebuild scans the rows and rewrites the meta file. If corruption is found
  46.   in the data file then the meta file is not repaired.
  47.   At some point a recovery method for such a drastic case needs to be divised.
  48.   Locks are row level, and you will get a consistant read. 
  49.   For performance as far as table scans go it is quite fast. I don't have
  50.   good numbers but locally it has out performed both Innodb and MyISAM. For
  51.   Innodb the question will be if the table can be fit into the buffer
  52.   pool. For MyISAM its a question of how much the file system caches the
  53.   MyISAM file. With enough free memory MyISAM is faster. Its only when the OS
  54.   doesn't have enough memory to cache entire table that archive turns out 
  55.   to be any faster. For writes it is always a bit slower then MyISAM. It has no
  56.   internal limits though for row length.
  57.   Examples between MyISAM (packed) and Archive.
  58.   Table with 76695844 identical rows:
  59.   29680807 a_archive.ARZ
  60.   920350317 a.MYD
  61.   Table with 8991478 rows (all of Slashdot's comments):
  62.   1922964506 comment_archive.ARZ
  63.   2944970297 comment_text.MYD
  64.   TODO:
  65.    Add bzip optional support.
  66.    Allow users to set compression level.
  67.    Add truncate table command.
  68.    Implement versioning, should be easy.
  69.    Allow for errors, find a way to mark bad rows.
  70.    Talk to the gzip guys, come up with a writable format so that updates are doable
  71.      without switching to a block method.
  72.    Add optional feature so that rows can be flushed at interval (which will cause less
  73.      compression but may speed up ordered searches).
  74.    Checkpoint the meta file to allow for faster rebuilds.
  75.    Dirty open (right now the meta file is repaired if a crash occured).
  76.    Option to allow for dirty reads, this would lower the sync calls, which would make
  77.      inserts a lot faster, but would mean highly arbitrary reads.
  78.     -Brian
  79. */
  80. /*
  81.   Notes on file formats.
  82.   The Meta file is layed out as:
  83.   check - Just an int of 254 to make sure that the the file we are opening was
  84.           never corrupted.
  85.   version - The current version of the file format.
  86.   rows - This is an unsigned long long which is the number of rows in the data
  87.          file.
  88.   check point - Reserved for future use
  89.   dirty - Status of the file, whether or not its values are the latest. This
  90.           flag is what causes a repair to occur
  91.   The data file:
  92.   check - Just an int of 254 to make sure that the the file we are opening was
  93.           never corrupted.
  94.   version - The current version of the file format.
  95.   data - The data is stored in a "row +blobs" format.
  96. */
  97. /* If the archive storage engine has been inited */
  98. static bool archive_inited= 0;
  99. /* Variables for archive share methods */
  100. pthread_mutex_t archive_mutex;
  101. static HASH archive_open_tables;
  102. /* The file extension */
  103. #define ARZ ".ARZ"               // The data file
  104. #define ARN ".ARN"               // Files used during an optimize call
  105. #define ARM ".ARM"               // Meta file
  106. /*
  107.   uchar + uchar + ulonglong + ulonglong + uchar
  108. */
  109. #define META_BUFFER_SIZE 19      // Size of the data used in the meta file
  110. /*
  111.   uchar + uchar
  112. */
  113. #define DATA_BUFFER_SIZE 2       // Size of the data used in the data file
  114. #define ARCHIVE_CHECK_HEADER 254 // The number we use to determine corruption
  115. /*
  116.   Used for hash table that tracks open tables.
  117. */
  118. static byte* archive_get_key(ARCHIVE_SHARE *share,uint *length,
  119.                              my_bool not_used __attribute__((unused)))
  120. {
  121.   *length=share->table_name_length;
  122.   return (byte*) share->table_name;
  123. }
  124. /*
  125.   Initialize the archive handler.
  126.   SYNOPSIS
  127.     archive_db_init()
  128.     void
  129.   RETURN
  130.     FALSE       OK
  131.     TRUE        Error
  132. */
  133. bool archive_db_init()
  134. {
  135.   archive_inited= 1;
  136.   VOID(pthread_mutex_init(&archive_mutex, MY_MUTEX_INIT_FAST));
  137.   return (hash_init(&archive_open_tables, system_charset_info, 32, 0, 0,
  138.                     (hash_get_key) archive_get_key, 0, 0));
  139. }
  140. /*
  141.   Release the archive handler.
  142.   SYNOPSIS
  143.     archive_db_end()
  144.     void
  145.   RETURN
  146.     FALSE       OK
  147. */
  148. bool archive_db_end()
  149. {
  150.   if (archive_inited)
  151.   {
  152.     hash_free(&archive_open_tables);
  153.     VOID(pthread_mutex_destroy(&archive_mutex));
  154.   }
  155.   archive_inited= 0;
  156.   return FALSE;
  157. }
  158. /*
  159.   This method reads the header of a datafile and returns whether or not it was successful.
  160. */
  161. int ha_archive::read_data_header(gzFile file_to_read)
  162. {
  163.   uchar data_buffer[DATA_BUFFER_SIZE];
  164.   DBUG_ENTER("ha_archive::read_data_header");
  165.   if (gzrewind(file_to_read) == -1)
  166.     DBUG_RETURN(HA_ERR_CRASHED_ON_USAGE);
  167.   if (gzread(file_to_read, data_buffer, DATA_BUFFER_SIZE) != DATA_BUFFER_SIZE)
  168.     DBUG_RETURN(errno ? errno : -1);
  169.   
  170.   DBUG_PRINT("ha_archive::read_data_header", ("Check %u", data_buffer[0]));
  171.   DBUG_PRINT("ha_archive::read_data_header", ("Version %u", data_buffer[1]));
  172.   
  173.   if ((data_buffer[0] != (uchar)ARCHIVE_CHECK_HEADER) &&  
  174.       (data_buffer[1] != (uchar)ARCHIVE_VERSION))
  175.     DBUG_RETURN(HA_ERR_CRASHED_ON_USAGE);
  176.   DBUG_RETURN(0);
  177. }
  178. /*
  179.   This method writes out the header of a datafile and returns whether or not it was successful.
  180. */
  181. int ha_archive::write_data_header(gzFile file_to_write)
  182. {
  183.   uchar data_buffer[DATA_BUFFER_SIZE];
  184.   DBUG_ENTER("ha_archive::write_data_header");
  185.   data_buffer[0]= (uchar)ARCHIVE_CHECK_HEADER;
  186.   data_buffer[1]= (uchar)ARCHIVE_VERSION;
  187.   if (gzwrite(file_to_write, &data_buffer, DATA_BUFFER_SIZE) != 
  188.       DATA_BUFFER_SIZE)
  189.     goto error;
  190.   DBUG_PRINT("ha_archive::write_data_header", ("Check %u", (uint)data_buffer[0]));
  191.   DBUG_PRINT("ha_archive::write_data_header", ("Version %u", (uint)data_buffer[1]));
  192.   DBUG_RETURN(0);
  193. error:
  194.   DBUG_RETURN(errno);
  195. }
  196. /*
  197.   This method reads the header of a meta file and returns whether or not it was successful.
  198.   *rows will contain the current number of rows in the data file upon success.
  199. */
  200. int ha_archive::read_meta_file(File meta_file, ulonglong *rows)
  201. {
  202.   uchar meta_buffer[META_BUFFER_SIZE];
  203.   ulonglong check_point;
  204.   DBUG_ENTER("ha_archive::read_meta_file");
  205.   VOID(my_seek(meta_file, 0, MY_SEEK_SET, MYF(0)));
  206.   if (my_read(meta_file, (byte*)meta_buffer, META_BUFFER_SIZE, 0) != META_BUFFER_SIZE)
  207.     DBUG_RETURN(-1);
  208.   
  209.   /*
  210.     Parse out the meta data, we ignore version at the moment
  211.   */
  212.   *rows= uint8korr(meta_buffer + 2);
  213.   check_point= uint8korr(meta_buffer + 10);
  214.   DBUG_PRINT("ha_archive::read_meta_file", ("Check %d", (uint)meta_buffer[0]));
  215.   DBUG_PRINT("ha_archive::read_meta_file", ("Version %d", (uint)meta_buffer[1]));
  216.   DBUG_PRINT("ha_archive::read_meta_file", ("Rows %lld", *rows));
  217.   DBUG_PRINT("ha_archive::read_meta_file", ("Checkpoint %lld", check_point));
  218.   DBUG_PRINT("ha_archive::read_meta_file", ("Dirty %d", (int)meta_buffer[18]));
  219.   if ((meta_buffer[0] != (uchar)ARCHIVE_CHECK_HEADER) || 
  220.       ((bool)meta_buffer[18] == TRUE))
  221.     DBUG_RETURN(HA_ERR_CRASHED_ON_USAGE);
  222.   my_sync(meta_file, MYF(MY_WME));
  223.   DBUG_RETURN(0);
  224. }
  225. /*
  226.   This method writes out the header of a meta file and returns whether or not it was successful.
  227.   By setting dirty you say whether or not the file represents the actual state of the data file.
  228.   Upon ::open() we set to dirty, and upon ::close() we set to clean. If we determine during
  229.   a read that the file was dirty we will force a rebuild of this file.
  230. */
  231. int ha_archive::write_meta_file(File meta_file, ulonglong rows, bool dirty)
  232. {
  233.   uchar meta_buffer[META_BUFFER_SIZE];
  234.   ulonglong check_point= 0; //Reserved for the future
  235.   DBUG_ENTER("ha_archive::write_meta_file");
  236.   meta_buffer[0]= (uchar)ARCHIVE_CHECK_HEADER;
  237.   meta_buffer[1]= (uchar)ARCHIVE_VERSION;
  238.   int8store(meta_buffer + 2, rows); 
  239.   int8store(meta_buffer + 10, check_point); 
  240.   *(meta_buffer + 18)= (uchar)dirty;
  241.   DBUG_PRINT("ha_archive::write_meta_file", ("Check %d", (uint)ARCHIVE_CHECK_HEADER));
  242.   DBUG_PRINT("ha_archive::write_meta_file", ("Version %d", (uint)ARCHIVE_VERSION));
  243.   DBUG_PRINT("ha_archive::write_meta_file", ("Rows %llu", rows));
  244.   DBUG_PRINT("ha_archive::write_meta_file", ("Checkpoint %llu", check_point));
  245.   DBUG_PRINT("ha_archive::write_meta_file", ("Dirty %d", (uint)dirty));
  246.   VOID(my_seek(meta_file, 0, MY_SEEK_SET, MYF(0)));
  247.   if (my_write(meta_file, (byte *)meta_buffer, META_BUFFER_SIZE, 0) != META_BUFFER_SIZE)
  248.     DBUG_RETURN(-1);
  249.   
  250.   my_sync(meta_file, MYF(MY_WME));
  251.   DBUG_RETURN(0);
  252. }
  253. /*
  254.   We create the shared memory space that we will use for the open table. 
  255.   See ha_example.cc for a longer description.
  256. */
  257. ARCHIVE_SHARE *ha_archive::get_share(const char *table_name, TABLE *table)
  258. {
  259.   ARCHIVE_SHARE *share;
  260.   char meta_file_name[FN_REFLEN];
  261.   uint length;
  262.   char *tmp_name;
  263.   pthread_mutex_lock(&archive_mutex);
  264.   length=(uint) strlen(table_name);
  265.   if (!(share=(ARCHIVE_SHARE*) hash_search(&archive_open_tables,
  266.                                            (byte*) table_name,
  267.                                            length)))
  268.   {
  269.     if (!my_multi_malloc(MYF(MY_WME | MY_ZEROFILL),
  270.                           &share, sizeof(*share),
  271.                           &tmp_name, length+1,
  272.                           NullS)) 
  273.     {
  274.       pthread_mutex_unlock(&archive_mutex);
  275.       return NULL;
  276.     }
  277.     share->use_count= 0;
  278.     share->table_name_length= length;
  279.     share->table_name= tmp_name;
  280.     fn_format(share->data_file_name,table_name,"",ARZ,MY_REPLACE_EXT|MY_UNPACK_FILENAME);
  281.     fn_format(meta_file_name,table_name,"",ARM,MY_REPLACE_EXT|MY_UNPACK_FILENAME);
  282.     strmov(share->table_name,table_name);
  283.     /*
  284.       We will use this lock for rows.
  285.     */
  286.     VOID(pthread_mutex_init(&share->mutex,MY_MUTEX_INIT_FAST));
  287.     if ((share->meta_file= my_open(meta_file_name, O_RDWR, MYF(0))) == -1)
  288.       goto error;
  289.     
  290.     if (read_meta_file(share->meta_file, &share->rows_recorded))
  291.     {
  292.       /*
  293.         The problem here is that for some reason, probably a crash, the meta
  294.         file has been corrupted. So what do we do? Well we try to rebuild it
  295.         ourself. Once that happens, we reread it, but if that fails we just
  296.         call it quits and return an error.
  297.       */
  298.       if (rebuild_meta_file(share->table_name, share->meta_file))
  299.         goto error;
  300.       if (read_meta_file(share->meta_file, &share->rows_recorded))
  301.         goto error;
  302.     }
  303.     /*
  304.       After we read, we set the file to dirty. When we close, we will do the 
  305.       opposite.
  306.     */
  307.     (void)write_meta_file(share->meta_file, share->rows_recorded, TRUE);
  308.     /* 
  309.       It is expensive to open and close the data files and since you can't have
  310.       a gzip file that can be both read and written we keep a writer open
  311.       that is shared amoung all open tables.
  312.     */
  313.     if ((share->archive_write= gzopen(share->data_file_name, "ab")) == NULL)
  314.       goto error2;
  315.     if (my_hash_insert(&archive_open_tables, (byte*) share))
  316.       goto error3;
  317.     thr_lock_init(&share->lock);
  318.   }
  319.   share->use_count++;
  320.   pthread_mutex_unlock(&archive_mutex);
  321.   return share;
  322. error3:
  323.   /* We close, but ignore errors since we already have errors */
  324.   (void)gzclose(share->archive_write);
  325. error2:
  326.   my_close(share->meta_file,MYF(0));
  327. error:
  328.   pthread_mutex_unlock(&archive_mutex);
  329.   VOID(pthread_mutex_destroy(&share->mutex));
  330.   my_free((gptr) share, MYF(0));
  331.   return NULL;
  332. }
  333. /* 
  334.   Free the share.
  335.   See ha_example.cc for a description.
  336. */
  337. int ha_archive::free_share(ARCHIVE_SHARE *share)
  338. {
  339.   int rc= 0;
  340.   pthread_mutex_lock(&archive_mutex);
  341.   if (!--share->use_count)
  342.   {
  343.     hash_delete(&archive_open_tables, (byte*) share);
  344.     thr_lock_delete(&share->lock);
  345.     VOID(pthread_mutex_destroy(&share->mutex));
  346.     (void)write_meta_file(share->meta_file, share->rows_recorded, FALSE);
  347.     if (gzclose(share->archive_write) == Z_ERRNO)
  348.       rc= 1;
  349.     if (my_close(share->meta_file, MYF(0)))
  350.       rc= 1;
  351.     my_free((gptr) share, MYF(0));
  352.   }
  353.   pthread_mutex_unlock(&archive_mutex);
  354.   return rc;
  355. }
  356. /* 
  357.   We just implement one additional file extension.
  358. */
  359. const char **ha_archive::bas_ext() const
  360. { static const char *ext[]= { ARZ, ARN, ARM, NullS }; return ext; }
  361. /* 
  362.   When opening a file we:
  363.   Create/get our shared structure.
  364.   Init out lock.
  365.   We open the file we will read from.
  366. */
  367. int ha_archive::open(const char *name, int mode, uint test_if_locked)
  368. {
  369.   DBUG_ENTER("ha_archive::open");
  370.   if (!(share= get_share(name, table)))
  371.     DBUG_RETURN(1);
  372.   thr_lock_data_init(&share->lock,&lock,NULL);
  373.   if ((archive= gzopen(share->data_file_name, "rb")) == NULL)
  374.   {
  375.     (void)free_share(share); //We void since we already have an error
  376.     DBUG_RETURN(errno ? errno : -1);
  377.   }
  378.   DBUG_RETURN(0);
  379. }
  380. /*
  381.   Closes the file.
  382.   SYNOPSIS
  383.     close();
  384.   
  385.   IMPLEMENTATION:
  386.   We first close this storage engines file handle to the archive and
  387.   then remove our reference count to the table (and possibly free it
  388.   as well).
  389.   RETURN
  390.     0  ok
  391.     1  Error
  392. */
  393. int ha_archive::close(void)
  394. {
  395.   int rc= 0;
  396.   DBUG_ENTER("ha_archive::close");
  397.   /* First close stream */
  398.   if (gzclose(archive) == Z_ERRNO)
  399.     rc= 1;
  400.   /* then also close share */
  401.   rc|= free_share(share);
  402.   DBUG_RETURN(rc);
  403. }
  404. /*
  405.   We create our data file here. The format is pretty simple. 
  406.   You can read about the format of the data file above.
  407.   Unlike other storage engines we do not "pack" our data. Since we 
  408.   are about to do a general compression, packing would just be a waste of 
  409.   CPU time. If the table has blobs they are written after the row in the order 
  410.   of creation.
  411. */
  412. int ha_archive::create(const char *name, TABLE *table_arg,
  413.                        HA_CREATE_INFO *create_info)
  414. {
  415.   File create_file;  // We use to create the datafile and the metafile
  416.   char name_buff[FN_REFLEN];
  417.   int error;
  418.   DBUG_ENTER("ha_archive::create");
  419.   if ((create_file= my_create(fn_format(name_buff,name,"",ARM,
  420.                                         MY_REPLACE_EXT|MY_UNPACK_FILENAME),0,
  421.                               O_RDWR | O_TRUNC,MYF(MY_WME))) < 0)
  422.   {
  423.     error= my_errno;
  424.     goto error;
  425.   }
  426.   write_meta_file(create_file, 0, FALSE);
  427.   my_close(create_file,MYF(0));
  428.   /* 
  429.     We reuse name_buff since it is available.
  430.   */
  431.   if ((create_file= my_create(fn_format(name_buff,name,"",ARZ,
  432.                                         MY_REPLACE_EXT|MY_UNPACK_FILENAME),0,
  433.                               O_RDWR | O_TRUNC,MYF(MY_WME))) < 0)
  434.   {
  435.     error= my_errno;
  436.     goto error;
  437.   }
  438.   if ((archive= gzdopen(create_file, "wb")) == NULL)
  439.   {
  440.     error= errno;
  441.     goto error2;
  442.   }
  443.   if (write_data_header(archive))
  444.   {
  445.     error= errno;
  446.     goto error3;
  447.   }
  448.   if (gzclose(archive))
  449.   {
  450.     error= errno;
  451.     goto error2;
  452.   }
  453.   my_close(create_file, MYF(0));
  454.   DBUG_RETURN(0);
  455. error3:
  456.   /* We already have an error, so ignore results of gzclose. */
  457.   (void)gzclose(archive);
  458. error2:
  459.   my_close(create_file, MYF(0));
  460.   delete_table(name);
  461. error:
  462.   /* Return error number, if we got one */
  463.   DBUG_RETURN(error ? error : -1);
  464. }
  465. /* 
  466.   Look at ha_archive::open() for an explanation of the row format.
  467.   Here we just write out the row.
  468.   Wondering about start_bulk_insert()? We don't implement it for
  469.   archive since it optimizes for lots of writes. The only save
  470.   for implementing start_bulk_insert() is that we could skip 
  471.   setting dirty to true each time.
  472. */
  473. int ha_archive::write_row(byte * buf)
  474. {
  475.   z_off_t written;
  476.   Field_blob **field;
  477.   DBUG_ENTER("ha_archive::write_row");
  478.   statistic_increment(ha_write_count,&LOCK_status);
  479.   if (table->timestamp_field_type & TIMESTAMP_AUTO_SET_ON_INSERT)
  480.     table->timestamp_field->set_time();
  481.   pthread_mutex_lock(&share->mutex);
  482.   written= gzwrite(share->archive_write, buf, table->reclength);
  483.   DBUG_PRINT("ha_archive::get_row", ("Wrote %d bytes expected %d", written, table->reclength));
  484.   share->dirty= TRUE;
  485.   if (written != (z_off_t)table->reclength)
  486.     goto error;
  487.   /*
  488.     We should probably mark the table as damagaged if the record is written
  489.     but the blob fails.
  490.   */
  491.   for (field= table->blob_field ; *field ; field++)
  492.   {
  493.     char *ptr;
  494.     uint32 size= (*field)->get_length();
  495.     if (size)
  496.     {
  497.       (*field)->get_ptr(&ptr);
  498.       written= gzwrite(share->archive_write, ptr, (unsigned)size);
  499.       if (written != (z_off_t)size)
  500.         goto error;
  501.     }
  502.   }
  503.   share->rows_recorded++;
  504.   pthread_mutex_unlock(&share->mutex);
  505.   DBUG_RETURN(0);
  506. error:
  507.   pthread_mutex_unlock(&share->mutex);
  508.   DBUG_RETURN(errno ? errno : -1);
  509. }
  510. /*
  511.   All calls that need to scan the table start with this method. If we are told
  512.   that it is a table scan we rewind the file to the beginning, otherwise
  513.   we assume the position will be set.
  514. */
  515. int ha_archive::rnd_init(bool scan)
  516. {
  517.   DBUG_ENTER("ha_archive::rnd_init");
  518.   /* We rewind the file so that we can read from the beginning if scan */
  519.   if (scan)
  520.   {
  521.     scan_rows= share->rows_recorded;
  522.     records= 0;
  523.     /* 
  524.       If dirty, we lock, and then reset/flush the data.
  525.       I found that just calling gzflush() doesn't always work.
  526.     */
  527.     if (share->dirty == TRUE)
  528.     {
  529.       pthread_mutex_lock(&share->mutex);
  530.       if (share->dirty == TRUE)
  531.       {
  532.         gzflush(share->archive_write, Z_SYNC_FLUSH);
  533.         share->dirty= FALSE;
  534.       }
  535.       pthread_mutex_unlock(&share->mutex);
  536.     }
  537.     if (read_data_header(archive))
  538.       DBUG_RETURN(HA_ERR_CRASHED_ON_USAGE);
  539.   }
  540.   DBUG_RETURN(0);
  541. }
  542. /*
  543.   This is the method that is used to read a row. It assumes that the row is 
  544.   positioned where you want it.
  545. */
  546. int ha_archive::get_row(gzFile file_to_read, byte *buf)
  547. {
  548.   int read; // Bytes read, gzread() returns int
  549.   char *last;
  550.   size_t total_blob_length= 0;
  551.   Field_blob **field;
  552.   DBUG_ENTER("ha_archive::get_row");
  553.   read= gzread(file_to_read, buf, table->reclength);
  554.   DBUG_PRINT("ha_archive::get_row", ("Read %d bytes expected %d", read, table->reclength));
  555.   if (read == Z_STREAM_ERROR)
  556.     DBUG_RETURN(HA_ERR_CRASHED_ON_USAGE);
  557.   /* If we read nothing we are at the end of the file */
  558.   if (read == 0)
  559.     DBUG_RETURN(HA_ERR_END_OF_FILE);
  560.   /* If the record is the wrong size, the file is probably damaged */
  561.   if ((ulong) read != table->reclength)
  562.     DBUG_RETURN(HA_ERR_CRASHED_ON_USAGE);
  563.   /* Calculate blob length, we use this for our buffer */
  564.   for (field=table->blob_field; *field ; field++)
  565.     total_blob_length += (*field)->get_length();
  566.   /* Adjust our row buffer if we need be */
  567.   buffer.alloc(total_blob_length);
  568.   last= (char *)buffer.ptr();
  569.   /* Loop through our blobs and read them */
  570.   for (field=table->blob_field; *field ; field++)
  571.   {
  572.     size_t size= (*field)->get_length();
  573.     if (size)
  574.     {
  575.       read= gzread(file_to_read, last, size);
  576.       if ((size_t) read != size)
  577.         DBUG_RETURN(HA_ERR_CRASHED_ON_USAGE);
  578.       (*field)->set_ptr(size, last);
  579.       last += size;
  580.     }
  581.   }
  582.   DBUG_RETURN(0);
  583. }
  584. /* 
  585.   Called during ORDER BY. Its position is either from being called sequentially
  586.   or by having had ha_archive::rnd_pos() called before it is called.
  587. */
  588. int ha_archive::rnd_next(byte *buf)
  589. {
  590.   int rc;
  591.   DBUG_ENTER("ha_archive::rnd_next");
  592.   if (!scan_rows)
  593.     DBUG_RETURN(HA_ERR_END_OF_FILE);
  594.   scan_rows--;
  595.   statistic_increment(ha_read_rnd_next_count,&LOCK_status);
  596.   current_position= gztell(archive);
  597.   rc= get_row(archive, buf);
  598.   if (rc != HA_ERR_END_OF_FILE)
  599.     records++;
  600.   DBUG_RETURN(rc);
  601. }
  602. /* 
  603.   Thanks to the table flag HA_REC_NOT_IN_SEQ this will be called after
  604.   each call to ha_archive::rnd_next() if an ordering of the rows is
  605.   needed.
  606. */
  607. void ha_archive::position(const byte *record)
  608. {
  609.   DBUG_ENTER("ha_archive::position");
  610.   ha_store_ptr(ref, ref_length, current_position);
  611.   DBUG_VOID_RETURN;
  612. }
  613. /*
  614.   This is called after a table scan for each row if the results of the
  615.   scan need to be ordered. It will take *pos and use it to move the
  616.   cursor in the file so that the next row that is called is the
  617.   correctly ordered row.
  618. */
  619. int ha_archive::rnd_pos(byte * buf, byte *pos)
  620. {
  621.   DBUG_ENTER("ha_archive::rnd_pos");
  622.   statistic_increment(ha_read_rnd_count,&LOCK_status);
  623.   current_position= ha_get_ptr(pos, ref_length);
  624.   (void)gzseek(archive, current_position, SEEK_SET);
  625.   DBUG_RETURN(get_row(archive, buf));
  626. }
  627. /*
  628.   This method rebuilds the meta file. It does this by walking the datafile and 
  629.   rewriting the meta file.
  630. */
  631. int ha_archive::rebuild_meta_file(char *table_name, File meta_file)
  632. {
  633.   int rc;
  634.   byte *buf; 
  635.   ulonglong rows_recorded= 0;
  636.   gzFile rebuild_file;            /* Archive file we are working with */
  637.   char data_file_name[FN_REFLEN];
  638.   DBUG_ENTER("ha_archive::rebuild_meta_file");
  639.   /*
  640.     Open up the meta file to recreate it.
  641.   */
  642.   fn_format(data_file_name, table_name, "", ARZ,
  643.             MY_REPLACE_EXT|MY_UNPACK_FILENAME);
  644.   if ((rebuild_file= gzopen(data_file_name, "rb")) == NULL)
  645.     DBUG_RETURN(errno ? errno : -1);
  646.   if ((rc= read_data_header(rebuild_file)))
  647.     goto error;
  648.   /*
  649.     We malloc up the buffer we will use for counting the rows. 
  650.     I know, this malloc'ing memory but this should be a very 
  651.     rare event.
  652.   */
  653.   if (!(buf= (byte*) my_malloc(table->rec_buff_length > sizeof(ulonglong) +1 ? 
  654.                                table->rec_buff_length : sizeof(ulonglong) +1 ,
  655.                                MYF(MY_WME))))
  656.   {
  657.     rc= HA_ERR_CRASHED_ON_USAGE;
  658.     goto error;
  659.   }
  660.   while (!(rc= get_row(rebuild_file, buf)))
  661.     rows_recorded++;
  662.   /* 
  663.     Only if we reach the end of the file do we assume we can rewrite.
  664.     At this point we reset rc to a non-message state.
  665.   */
  666.   if (rc == HA_ERR_END_OF_FILE)
  667.   {
  668.     (void)write_meta_file(meta_file, rows_recorded, FALSE);
  669.     rc= 0;
  670.   }
  671.   my_free((gptr) buf, MYF(0));
  672. error:
  673.   gzclose(rebuild_file);
  674.   DBUG_RETURN(rc);
  675. }
  676. /*
  677.   The table can become fragmented if data was inserted, read, and then
  678.   inserted again. What we do is open up the file and recompress it completely. 
  679. */
  680. int ha_archive::optimize(THD* thd, HA_CHECK_OPT* check_opt)
  681. {
  682.   DBUG_ENTER("ha_archive::optimize");
  683.   int read; // Bytes read, gzread() returns int
  684.   gzFile reader, writer;
  685.   char block[IO_SIZE];
  686.   char writer_filename[FN_REFLEN];
  687.   /* Lets create a file to contain the new data */
  688.   fn_format(writer_filename, share->table_name, "", ARN, 
  689.             MY_REPLACE_EXT|MY_UNPACK_FILENAME);
  690.   /* Closing will cause all data waiting to be flushed, to be flushed */
  691.   gzclose(share->archive_write);
  692.   if ((reader= gzopen(share->data_file_name, "rb")) == NULL)
  693.     DBUG_RETURN(-1); 
  694.   if ((writer= gzopen(writer_filename, "wb")) == NULL)
  695.   {
  696.     gzclose(reader);
  697.     DBUG_RETURN(-1); 
  698.   }
  699.   while ((read= gzread(reader, block, IO_SIZE)))
  700.     gzwrite(writer, block, read);
  701.   gzclose(reader);
  702.   gzclose(writer);
  703.   my_rename(writer_filename,share->data_file_name,MYF(0));
  704.   /* 
  705.     We reopen the file in case some IO is waiting to go through.
  706.     In theory the table is closed right after this operation,
  707.     but it is possible for IO to still happen.
  708.     I may be being a bit too paranoid right here.
  709.   */
  710.   if ((share->archive_write= gzopen(share->data_file_name, "ab")) == NULL)
  711.     DBUG_RETURN(errno ? errno : -1);
  712.   share->dirty= FALSE;
  713.   DBUG_RETURN(0); 
  714. }
  715. /*
  716.   No transactions yet, so this is pretty dull.
  717. */
  718. int ha_archive::external_lock(THD *thd, int lock_type)
  719. {
  720.   DBUG_ENTER("ha_archive::external_lock");
  721.   DBUG_RETURN(0);
  722. }
  723. /* 
  724.   Below is an example of how to setup row level locking.
  725. */
  726. THR_LOCK_DATA **ha_archive::store_lock(THD *thd,
  727.                                        THR_LOCK_DATA **to,
  728.                                        enum thr_lock_type lock_type)
  729. {
  730.   if (lock_type != TL_IGNORE && lock.type == TL_UNLOCK) 
  731.   {
  732.     /* 
  733.       Here is where we get into the guts of a row level lock.
  734.       If TL_UNLOCK is set 
  735.       If we are not doing a LOCK TABLE or DISCARD/IMPORT
  736.       TABLESPACE, then allow multiple writers 
  737.     */
  738.     if ((lock_type >= TL_WRITE_CONCURRENT_INSERT &&
  739.          lock_type <= TL_WRITE) && !thd->in_lock_tables
  740.         && !thd->tablespace_op)
  741.       lock_type = TL_WRITE_ALLOW_WRITE;
  742.     /* 
  743.       In queries of type INSERT INTO t1 SELECT ... FROM t2 ...
  744.       MySQL would use the lock TL_READ_NO_INSERT on t2, and that
  745.       would conflict with TL_WRITE_ALLOW_WRITE, blocking all inserts
  746.       to t2. Convert the lock to a normal read lock to allow
  747.       concurrent inserts to t2. 
  748.     */
  749.     if (lock_type == TL_READ_NO_INSERT && !thd->in_lock_tables) 
  750.       lock_type = TL_READ;
  751.     lock.type=lock_type;
  752.   }
  753.   *to++= &lock;
  754.   return to;
  755. }
  756. /******************************************************************************
  757.   Everything below here is default, please look at ha_example.cc for 
  758.   descriptions.
  759.  ******************************************************************************/
  760. int ha_archive::update_row(const byte * old_data, byte * new_data)
  761. {
  762.   DBUG_ENTER("ha_archive::update_row");
  763.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  764. }
  765. int ha_archive::delete_row(const byte * buf)
  766. {
  767.   DBUG_ENTER("ha_archive::delete_row");
  768.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  769. }
  770. int ha_archive::index_read(byte * buf, const byte * key,
  771.                            uint key_len __attribute__((unused)),
  772.                            enum ha_rkey_function find_flag
  773.                            __attribute__((unused)))
  774. {
  775.   DBUG_ENTER("ha_archive::index_read");
  776.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  777. }
  778. int ha_archive::index_read_idx(byte * buf, uint index, const byte * key,
  779.                                uint key_len __attribute__((unused)),
  780.                                enum ha_rkey_function find_flag
  781.                                __attribute__((unused)))
  782. {
  783.   DBUG_ENTER("ha_archive::index_read_idx");
  784.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  785. }
  786. int ha_archive::index_next(byte * buf)
  787. {
  788.   DBUG_ENTER("ha_archive::index_next");
  789.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  790. }
  791. int ha_archive::index_prev(byte * buf)
  792. {
  793.   DBUG_ENTER("ha_archive::index_prev");
  794.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  795. }
  796. int ha_archive::index_first(byte * buf)
  797. {
  798.   DBUG_ENTER("ha_archive::index_first");
  799.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  800. }
  801. int ha_archive::index_last(byte * buf)
  802. {
  803.   DBUG_ENTER("ha_archive::index_last");
  804.   DBUG_RETURN(HA_ERR_WRONG_COMMAND);
  805. }
  806. void ha_archive::info(uint flag)
  807. {
  808.   DBUG_ENTER("ha_archive::info");
  809.   /* This is a lie, but you don't want the optimizer to see zero or 1 */
  810.   records= share->rows_recorded;
  811.   deleted= 0;
  812.   DBUG_VOID_RETURN;
  813. }
  814. int ha_archive::extra(enum ha_extra_function operation)
  815. {
  816.   DBUG_ENTER("ha_archive::extra");
  817.   DBUG_RETURN(0);
  818. }
  819. int ha_archive::reset(void)
  820. {
  821.   DBUG_ENTER("ha_archive::reset");
  822.   DBUG_RETURN(0);
  823. }
  824. ha_rows ha_archive::records_in_range(uint inx, key_range *min_key,
  825.                                      key_range *max_key)
  826. {
  827.   DBUG_ENTER("ha_archive::records_in_range ");
  828.   DBUG_RETURN(records); // HA_ERR_WRONG_COMMAND 
  829. }
  830. /*
  831.   We cancel a truncate command. The only way to delete an archive table is to drop it.
  832.   This is done for security reasons. In a later version we will enable this by 
  833.   allowing the user to select a different row format.
  834. */
  835. int ha_archive::delete_all_rows()
  836. {
  837.   DBUG_ENTER("ha_archive::delete_all_rows");
  838.   DBUG_RETURN(0);
  839. }
  840. #endif /* HAVE_ARCHIVE_DB */