sm_base.h

Go to the documentation of this file.

/*
 * (c) Copyright 2011-2014, Hewlett-Packard Development Company, LP
 */

/* -*- mode:C++; c-basic-offset:4 -*-
     Shore-MT -- Multi-threaded port of the SHORE storage manager

                       Copyright (c) 2007-2009
      Data Intensive Applications and Systems Labaratory (DIAS)
               Ecole Polytechnique Federale de Lausanne

                         All Rights Reserved.

   Permission to use, copy, modify and distribute this software and
   its documentation is hereby granted, provided that both the
   copyright notice and this permission notice appear in all copies of
   the software, derivative works or modified versions, and any
   portions thereof, and that both notices appear in supporting
   documentation.

   This code 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. THE AUTHORS
   DISCLAIM ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER
   RESULTING FROM THE USE OF THIS SOFTWARE.
*/

/*<std-header orig-src='shore' incl-file-exclusion='SM_BASE_H'>

 $Id: sm_base.h,v 1.158 2010/12/08 17:37:43 nhall Exp $

SHORE -- Scalable Heterogeneous Object REpository

Copyright (c) 1994-99 Computer Sciences Department, University of
                      Wisconsin -- Madison
All Rights Reserved.

Permission to use, copy, modify and distribute this software and its
documentation is hereby granted, provided that both the copyright
notice and this permission notice appear in all copies of the
software, derivative works or modified versions, and any portions
thereof, and that both notices appear in supporting documentation.

THE AUTHORS AND THE COMPUTER SCIENCES DEPARTMENT OF THE UNIVERSITY
OF WISCONSIN - MADISON ALLOW FREE USE OF THIS SOFTWARE IN ITS
"AS IS" CONDITION, AND THEY DISCLAIM ANY LIABILITY OF ANY KIND
FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.

This software was developed with support by the Advanced Research
Project Agency, ARPA order number 018 (formerly 8230), monitored by
the U.S. Army Research Laboratory under contract DAAB07-91-C-Q518.
Further funding for this work was provided by DARPA through
Rome Research Laboratory Contract No. F30602-97-2-0247.

*/

#ifndef __SM_BASE_H
#define __SM_BASE_H

#include "w_defines.h"

/*  -- do not edit anything above this line --   </std-header>*/

#include <vector>
#include "basics.h"
#include "w_debug.h"
#include <cstddef>
#include <cstdlib>
#include <cstring>
#include <climits>
#include "w.h"
#include "vec_t.h"
#include "latch.h"
#include "smthread.h"
#include "tid_t.h"
#include "smstats.h"


#include <climits>

class ErrLog;
class xct_t;
class xct_i;
class vol_t;
class BackupManager;
namespace zero::buffer_pool {
    class BufferPool;
} // zero::buffer_pool
class comm_m;
class log_core;
class lock_m;
class LogArchiver;
class option_t;
class rid_t;
class lsn_t;
class sm_naive_allocator;
class sm_tls_allocator;
template<typename T, size_t A> class memalign_allocator;
class chkpt_m;
class restart_thread_t;
namespace zero::buffer_pool {
    class BufferPool;
}
class btree_m;
class ss_m;

#ifndef        SM_EXTENTSIZE
#define        SM_EXTENTSIZE        8
#endif
#ifndef        SM_LOG_PARTITIONS
#define        SM_LOG_PARTITIONS        8
#endif

class w_rc_t;

typedef w_rc_t rc_t;


#if W_DEBUG_LEVEL > 2
#define CHECK_NESTING_VARIABLES 1
#else
#define CHECK_NESTING_VARIABLES 0
#endif

struct check_compensated_op_nesting {
#if CHECK_NESTING_VARIABLES
    xct_t* _xd;
    int _depth;
    int _line;
    const char *const _file;
    // static methods are so we can avoid having to
    // include xct.h here.
    static int compensated_op_depth(xct_t* xd, int dflt);

    check_compensated_op_nesting(xct_t* xd, int line, const char *const file)
    : _xd(xd),
    _depth(_xd? compensated_op_depth(_xd, 0) : 0),
    _line(line),
    _file(file)
    {}

    ~check_compensated_op_nesting() {
        if(_xd) {
            if( _depth != compensated_op_depth(_xd, _depth) ) {
                fprintf(stderr,
                    "th.XXX check_compensated_op_nesting(%d,%s) depth was %d is %d\n",
                    _line, _file, _depth, compensated_op_depth(_xd, _depth));
            }


            w_assert0(_depth == compensated_op_depth(_xd, _depth));
        }
    }
#else

    check_compensated_op_nesting(xct_t*, int, const char* const) {}

#endif
};

class smlevel_0 : public w_base_t {
public:
    // Give these enums names for doxygen purposes:
    enum error_constant_t {
        eNOERROR = 0,
        eFAILURE = -1
    };
    enum sm_constant_t {
        page_sz = SM_PAGESIZE,        // page size (SM_PAGESIZE is set by makemake)
        ext_sz = SM_EXTENTSIZE,        // extent size
#if defined(_POSIX_PATH_MAX)
        max_devname = _POSIX_PATH_MAX,        // max length of unix path name
        // BEWARE: this might be larger than you want.  Array sizes depend on it.
        // The default might be small enough, e.g., 256; getconf() yields the upper
        // bound on this value.
#elif defined(MAXPATHLEN)
        max_devname = MAXPATHLEN,
#else
        max_devname = 1024,
#endif
        max_xct_thread = 20,        // max threads in a xct
        max_servers = 15,       // max servers to be connected with
        max_keycomp = 20,        // max key component (for btree)
        max_openlog = SM_LOG_PARTITIONS,        // max # log partitions

        /* XXX I want to propogate sthread_t::iovec_max here, but
           it doesn't work because of sm_app.h not including
           the thread package. */
        max_many_pages = 64,

        srvid_map_sz = (max_servers - 1) / 8 + 1,
        ext_map_sz_in_bytes = ((ext_sz + 7) / 8),

        dummy = 0
    };

    enum {
        max_rec_len = max_uint4
    };

    typedef w_base_t::base_stat_t base_stat_t;

    typedef uint32_t partition_number_t;

    enum cmp_t {
        bad_cmp_t = badOp,
        eq = eqOp,
        gt = gtOp,
        ge = geOp,
        lt = ltOp,
        le = leOp
    };

    enum concurrency_t {
        t_cc_bad,                // this is an illegal value
        t_cc_none,                // no locking
        t_cc_vol,
        t_cc_store,
        t_cc_keyrange,
        t_cc_append
    };

    enum pg_policy_t {
        t_append = 0x01, // retain sort order (cache 0 pages)
        t_cache = 0x02, // look in n cached pgs
        t_compact = 0x04 // scan file for space in pages

    };

    static void add_to_global_stats(const sm_stats_t& from);

    static void add_from_global_stats(sm_stats_t& to);

    static BackupManager* bk;

    static vol_t* vol;

    static zero::buffer_pool::BufferPool* bf;

    static lock_m* lm;

    static log_core* log;

    static LogArchiver* logArchiver;

    static int dcommit_timeout; // to convey option to coordinator,
    // if it is created by VAS

    static ErrLog* errlog;

    static sm_tls_allocator allocator;

    static constexpr size_t IO_ALIGN = 512;

    static memalign_allocator<char, IO_ALIGN> aligned_allocator;

    static bool shutdown_clean;

    static bool shutdown_filthy;

    static bool shutting_down;

    static bool logging_enabled;

    static bool lock_caching_default;

    static bool statistics_enabled;

    // This is a zeroed page for use wherever initialized memory
    // is needed.
    static char zero_page[page_sz];

    // or at least be converted properly every time we come through the API
    enum store_flag_t {
        st_unallocated = 0,

        st_regular = 0x01, // fully logged
        st_tmp = 0x02, // space logging only,
        // file destroy on dismount/restart
        st_load_file = 0x04, // not stored in the stnode_t,
        // only passed down to io_m and then
        // converted to tmp and added to the
        // list of load files for the xct.  no
        // longer needed
        st_insert_file = 0x08, // stored in stnode, but not on page.
        // new pages are saved as tmp, old pages as regular.
        st_empty = 0x100 // store might be empty - used ONLY
        // as a function argument, NOT stored
        // persistently.  Nevertheless, it's
        // defined here to be sure that if
        // other store flags are added, this
        // doesn't conflict with them.
    };

    /*
     * for use by set_store_deleting_log;
     * type of operation to perform on the stnode
     */
    enum store_operation_t {
        t_delete_store,
        t_create_store,
        t_set_deleting,
        t_set_store_flags,
        t_set_root
    };

    enum store_deleting_t {
        t_not_deleting_store = 0,  // must be 0: code assumes it
        t_deleting_store,
        t_unknown_deleting
    };

    // CS: stuff below was from smlevels 1-4

    // The numeric equivalents of state are not significant; they are
    // given here only for convenience in debugging/grepping
    // Well, their ORDER is significant, so that you can only
    // change state to a larger state with change_state().
    enum xct_state_t {
        xct_stale = 0x0,
        xct_active = 0x1,  // active or rolling back in
        // doing rollback_work
        // It is also used in Recovery for loser transaction
        // because it is using the standard rollback logic
        // for loser txn, check the _loser_xct flag
        // in xct_t
        xct_chaining = 0x3,
        xct_committing = 0x4,
        xct_aborting = 0x5,  // normal transaction abort
        xct_freeing_space = 0x6,
        xct_ended = 0x7
    };

    // Checkpoint manager
    static chkpt_m* chkpt;

    // Recovery manager
    static restart_thread_t* recovery;

    static btree_m* bt;

    static ss_m* SSM;    // we will change to lower case later

    enum sm_store_property_t {
        // NB: this had better match store_flag_t!!! (sm_base.h)
        t_regular = 0x1,

        t_temporary = 0x2,

        t_load_file = 0x4,

        t_insert_file = 0x08,

        t_bad_storeproperty = 0x80// no bits in common with good properties
    };
};

typedef smlevel_0 smlevel_top;

ostream&
operator<<(ostream& o, smlevel_0::sm_store_property_t p);

class xct_log_warn_check_t : public smlevel_0 {
public:
    static w_rc_t check(xct_t*&);
};

ostream&
operator<<(ostream& o, smlevel_0::store_flag_t flag);

ostream&
operator<<(ostream& o, const smlevel_0::store_operation_t op);

ostream&
operator<<(ostream& o, const smlevel_0::store_deleting_t value);

#if defined(__GNUC__) && __GNUC_MINOR__ > 6
ostream& operator<<(ostream& o, const smlevel_0::xct_state_t& xct_state);
#endif

/*<std-footer incl-file-exclusion='SM_BASE_H'>  -- do not edit anything below this line -- */

#endif // __SM_BASE_H /*</std-footer>*/