innodb_config.h

Go to the documentation of this file.

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

Copyright (c) 2013, 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 innodb_config_h
#define innodb_config_h

#include "api0api.h"
#include "innodb_utility.h"

typedef void*   hash_node_t;

/* Database name and table name for our metadata "system" tables for
InnoDB memcache. The table names are the same as those for the
NDB memcache, to make the memcache setup compatible between the two.
There are 3 "system tables":
1) containers - main configure table contains row describing which InnoDB
                table is used to store/retrieve Memcached key/value if InnoDB
                Memcached engine is used
2) cache_policies - decide whether to use "Memcached Default Engine" or "InnoDB
                    Memcached Engine" to handler the requests
3) config_options - for miscellaneous configuration options */
#define MCI_CFG_DB_NAME                 "innodb_memcache"
#define MCI_CFG_CONTAINER_TABLE         "containers"
#define MCI_CFG_CACHE_POLICIES          "cache_policies"
#define MCI_CFG_CONFIG_OPTIONS          "config_options"

#define MAX_TABLE_NAME_LEN      192
#define MAX_DATABASE_NAME_LEN   MAX_TABLE_NAME_LEN
#define MAX_FULL_NAME_LEN                               \
        (MAX_TABLE_NAME_LEN + MAX_DATABASE_NAME_LEN + 14)

typedef struct meta_column {
        char*           col_name;               
        size_t          col_name_len;           
        int             field_id;               
        ib_col_meta_t   col_meta;               
} meta_column_t;

typedef enum container {
        CONTAINER_NAME,         
        CONTAINER_DB,           
        CONTAINER_TABLE,        
        CONTAINER_KEY,          
        CONTAINER_VALUE,        
        CONTAINER_FLAG,         
        CONTAINER_CAS,          
        CONTAINER_EXP,          
        CONTAINER_NUM_COLS      
} container_t;

typedef enum cache_policy {
        CACHE_POLICY_NAME,      
        CACHE_POLICY_GET,       
        CACHE_POLICY_SET,       
        CACHE_POLICY_DEL,       
        CACHE_POLICY_FLUSH,     
        CACHE_POLICY_NUM_COLS   
} cache_policy_t;

typedef enum config_opt {
        CONFIG_OPT_KEY,         
        CONFIG_OPT_VALUE,       
        CONFIG_OPT_NUM_COLS     
} config_opt_t;

typedef enum meta_use_idx {
        META_USE_NO_INDEX = 1,  
        META_USE_CLUSTER,       
        META_USE_SECONDARY      
} meta_use_idx_t;

typedef struct meta_index {
        char*           idx_name;       
        int             idx_id;         
        meta_use_idx_t  srch_use_idx;   
} meta_index_t;

typedef enum meta_cache_opt {
        META_CACHE_OPT_INNODB = 1,      
        META_CACHE_OPT_DEFAULT,         
        META_CACHE_OPT_MIX,             
        META_CACHE_OPT_DISABLE,         
        META_CACHE_NUM_OPT              
} meta_cache_opt_t;

#define COLUMN_SEPARATOR        "separator"
#define TABLE_MAP_SEPARATOR     "table_map_delimiter"

/* list of configure options we support */
typedef enum option_id {
        OPTION_ID_COL_SEP,              
        OPTION_ID_TBL_MAP_SEP,          
        OPTION_ID_NUM_OPTIONS           
} option_id_t;

#define MAX_DELIMITER_LEN       32

typedef struct option_value {
        char            value[MAX_DELIMITER_LEN + 1];
                                        /* option value */
        int             value_len;      /* value length */
} option_value_t;

typedef struct option {
        option_id_t     id;             
        const char*     name;           
        option_value_t  default_value;  
} option_t;

#define GET_OPTION(meta_info, option, val, val_len)                     \
do {                                                                    \
        val_len = meta_info->options[option].value_len;                 \
                                                                        \
        if (val_len == 0) {                                             \
                val = config_option_names[option].default_value.value;  \
                val_len = config_option_names[option].default_value.value_len;\
        } else {                                                        \
                val = meta_info->options[option].value;                 \
        }                                                               \
} while (0)

typedef struct meta_cfg_info {
        meta_column_t   col_info[CONTAINER_NUM_COLS]; 
        meta_column_t*  extra_col_info;         
        int             n_extra_col;            
        meta_index_t    index_info;             
        bool            flag_enabled;           
        bool            cas_enabled;            
        bool            exp_enabled;            
        option_value_t  options[OPTION_ID_NUM_OPTIONS];
        meta_cache_opt_t set_option;            
        meta_cache_opt_t get_option;            
        meta_cache_opt_t del_option;            
        meta_cache_opt_t flush_option;          
        hash_node_t     name_hash;              
} meta_cfg_info_t;


/**********************************************************************/
meta_cfg_info_t*
innodb_config(
/*==========*/
        const char*             name,           
        size_t                  name_len,       
        hash_table_t**          meta_hash);     
/**********************************************************************/
bool
innodb_verify(
/*==========*/
        meta_cfg_info_t*        info);          
/**********************************************************************/
void
innodb_config_free(
/*===============*/
        meta_cfg_info_t*        item);          
/**********************************************************************/
meta_cfg_info_t*
innodb_config_meta_hash_init(
/*=========================*/
        hash_table_t*           meta_hash);     
#endif