row0ftsort.h

Go to the documentation of this file.

/*****************************************************************************

Copyright (c) 2010, 2012, Oracle and/or its affiliates. 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.,
51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA

*****************************************************************************/

/**************************************************/
#ifndef row0ftsort_h
#define row0ftsort_h

#include "univ.i"
#include "data0data.h"
#include "dict0types.h"
#include "row0mysql.h"
#include "fts0fts.h"
#include "fts0types.h"
#include "fts0priv.h"
#include "row0merge.h"

typedef struct fts_doc_item     fts_doc_item_t;

struct fts_doc_item {
        dfield_t*       field;          
        doc_id_t        doc_id;         
        UT_LIST_NODE_T(fts_doc_item_t)  doc_list;
};

typedef UT_LIST_BASE_NODE_T(fts_doc_item_t)     fts_doc_list_t;

#define FTS_NUM_AUX_INDEX       6
#define FTS_PLL_MERGE           1

struct fts_psort_t;

struct fts_psort_common_t {
        row_merge_dup_t*        dup;            
        dict_table_t*           new_table;      
        trx_t*                  trx;            
        fts_psort_t*            all_info;       
        os_event_t              sort_event;     
        os_event_t              merge_event;    
        ibool                   opt_doc_id_size;
};

struct fts_psort_t {
        ulint                   psort_id;       
        row_merge_buf_t*        merge_buf[FTS_NUM_AUX_INDEX];
        merge_file_t*           merge_file[FTS_NUM_AUX_INDEX];
        row_merge_block_t*      merge_block[FTS_NUM_AUX_INDEX];
        row_merge_block_t*      block_alloc[FTS_NUM_AUX_INDEX];
        ulint                   child_status;   
        ulint                   state;          
        fts_doc_list_t          fts_doc_list;   
        fts_psort_common_t*     psort_common;   
        os_thread_t             thread_hdl;     
        dberr_t                 error;          
        ulint                   memory_used;    
        ib_mutex_t              mutex;          
};

struct fts_tokenize_ctx {
        ulint                   processed_len;  
        ulint                   init_pos;       
        ulint                   buf_used;       
        ulint                   rows_added[FTS_NUM_AUX_INDEX];
        ib_rbt_t*               cached_stopword;
        dfield_t                sort_field[FTS_NUM_FIELDS_SORT];
};

typedef struct fts_tokenize_ctx fts_tokenize_ctx_t;

struct fts_psort_insert {
        trx_t*          trx;            
        que_t**         ins_graph;      
        fts_table_t     fts_table;      
        CHARSET_INFO*   charset;        
        mem_heap_t*     heap;           
        ibool           opt_doc_id_size;
};

typedef struct fts_psort_insert fts_psort_insert_t;


#define FTS_PARENT_COMPLETE     1
#define FTS_PARENT_EXITING      2
#define FTS_CHILD_COMPLETE      1
#define FTS_CHILD_EXITING       2

#define FTSORT_PRINT

#ifdef  FTSORT_PRINT
#define DEBUG_FTS_SORT_PRINT(str)               \
        do {                                    \
                ut_print_timestamp(stderr);     \
                fprintf(stderr, str);           \
        } while (0)
#else
#define DEBUG_FTS_SORT_PRINT(str)
#endif  /* FTSORT_PRINT */

/*************************************************************/
UNIV_INTERN
dict_index_t*
row_merge_create_fts_sort_index(
/*============================*/
        dict_index_t*           index,  
        const dict_table_t*     table,  
        ibool*                  opt_doc_id_size);
/********************************************************************/
UNIV_INTERN
ibool
row_fts_psort_info_init(
/*====================*/
        trx_t*                  trx,    
        row_merge_dup_t*        dup,    
        const dict_table_t*     new_table,
        ibool                   opt_doc_id_size,
        fts_psort_t**           psort,  
        fts_psort_t**           merge)  
        __attribute__((nonnull));
/********************************************************************/
UNIV_INTERN
void
row_fts_psort_info_destroy(
/*=======================*/
        fts_psort_t*    psort_info,     
        fts_psort_t*    merge_info);    
/********************************************************************/
UNIV_INTERN
void
row_fts_free_pll_merge_buf(
/*=======================*/
        fts_psort_t*    psort_info);    
/*********************************************************************/
UNIV_INTERN
os_thread_ret_t
fts_parallel_tokenization(
/*======================*/
        void*           arg);           
/*********************************************************************/
UNIV_INTERN
void
row_fts_start_psort(
/*================*/
        fts_psort_t*    psort_info);    
/*********************************************************************/
UNIV_INTERN
os_thread_ret_t
fts_parallel_merge(
/*===============*/
        void*           arg);           
/*********************************************************************/
UNIV_INTERN
void
row_fts_start_parallel_merge(
/*=========================*/
        fts_psort_t*    merge_info);    
/********************************************************************/
UNIV_INTERN
void
row_fts_insert_tuple(
/*=================*/
        fts_psort_insert_t*
                        ins_ctx,        
        fts_tokenizer_word_t* word,     
        ib_vector_t*    positions,      
        doc_id_t*       in_doc_id,      
        dtuple_t*       dtuple);        
/********************************************************************/
UNIV_INTERN
int
row_merge_fts_sel_propagate(
/*========================*/
        int             propogated,     /*<! in: tree node propagated */
        int*            sel_tree,       /*<! in: selection tree */
        ulint           level,          /*<! in: selection tree level */
        const mrec_t**   mrec,          /*<! in: sort record */
        ulint**         offsets,        /*<! in: record offsets */
        dict_index_t*   index);         /*<! in: FTS index */
/********************************************************************/
UNIV_INTERN
dberr_t
row_fts_merge_insert(
/*=================*/
        dict_index_t*   index,          
        dict_table_t*   table,          
        fts_psort_t*    psort_info,     
        ulint           id)             /* !< in: which auxiliary table's data
                                        to insert to */
        __attribute__((nonnull));
#endif /* row0ftsort_h */