sl@0: /*
sl@0: ** 2004 May 22
sl@0: **
sl@0: ** The author disclaims copyright to this source code.  In place of
sl@0: ** a legal notice, here is a blessing:
sl@0: **
sl@0: **    May you do good and not evil.
sl@0: **    May you find forgiveness for yourself and forgive others.
sl@0: **    May you share freely, never taking more than you give.
sl@0: **
sl@0: ******************************************************************************
sl@0: **
sl@0: ** This file contains macros and a little bit of code that is common to
sl@0: ** all of the platform-specific files (os_*.c) and is #included into those
sl@0: ** files.
sl@0: **
sl@0: ** This file should be #included by the os_*.c files only.  It is not a
sl@0: ** general purpose header file.
sl@0: **
sl@0: ** $Id: os_common.h,v 1.37 2008/05/29 20:22:37 shane Exp $
sl@0: */
sl@0: #ifndef _OS_COMMON_H_
sl@0: #define _OS_COMMON_H_
sl@0: 
sl@0: /*
sl@0: ** At least two bugs have slipped in because we changed the MEMORY_DEBUG
sl@0: ** macro to SQLITE_DEBUG and some older makefiles have not yet made the
sl@0: ** switch.  The following code should catch this problem at compile-time.
sl@0: */
sl@0: #ifdef MEMORY_DEBUG
sl@0: # error "The MEMORY_DEBUG macro is obsolete.  Use SQLITE_DEBUG instead."
sl@0: #endif
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * When testing, this global variable stores the location of the
sl@0:  * pending-byte in the database file.
sl@0:  */
sl@0: #ifdef SQLITE_TEST
sl@0: unsigned int sqlite3_pending_byte = 0x40000000;
sl@0: #endif
sl@0: 
sl@0: #ifdef SQLITE_DEBUG
sl@0: int sqlite3OSTrace = 0;
sl@0: #define OSTRACE1(X)         if( sqlite3OSTrace ) sqlite3DebugPrintf(X)
sl@0: #define OSTRACE2(X,Y)       if( sqlite3OSTrace ) sqlite3DebugPrintf(X,Y)
sl@0: #define OSTRACE3(X,Y,Z)     if( sqlite3OSTrace ) sqlite3DebugPrintf(X,Y,Z)
sl@0: #define OSTRACE4(X,Y,Z,A)   if( sqlite3OSTrace ) sqlite3DebugPrintf(X,Y,Z,A)
sl@0: #define OSTRACE5(X,Y,Z,A,B) if( sqlite3OSTrace ) sqlite3DebugPrintf(X,Y,Z,A,B)
sl@0: #define OSTRACE6(X,Y,Z,A,B,C) \
sl@0:     if(sqlite3OSTrace) sqlite3DebugPrintf(X,Y,Z,A,B,C)
sl@0: #define OSTRACE7(X,Y,Z,A,B,C,D) \
sl@0:     if(sqlite3OSTrace) sqlite3DebugPrintf(X,Y,Z,A,B,C,D)
sl@0: #else
sl@0: #define OSTRACE1(X)
sl@0: #define OSTRACE2(X,Y)
sl@0: #define OSTRACE3(X,Y,Z)
sl@0: #define OSTRACE4(X,Y,Z,A)
sl@0: #define OSTRACE5(X,Y,Z,A,B)
sl@0: #define OSTRACE6(X,Y,Z,A,B,C)
sl@0: #define OSTRACE7(X,Y,Z,A,B,C,D)
sl@0: #endif
sl@0: 
sl@0: /*
sl@0: ** Macros for performance tracing.  Normally turned off.  Only works
sl@0: ** on i486 hardware.
sl@0: */
sl@0: #ifdef SQLITE_PERFORMANCE_TRACE
sl@0: 
sl@0: /* 
sl@0: ** hwtime.h contains inline assembler code for implementing 
sl@0: ** high-performance timing routines.
sl@0: */
sl@0: #include "hwtime.h"
sl@0: 
sl@0: static sqlite_uint64 g_start;
sl@0: static sqlite_uint64 g_elapsed;
sl@0: #define TIMER_START       g_start=sqlite3Hwtime()
sl@0: #define TIMER_END         g_elapsed=sqlite3Hwtime()-g_start
sl@0: #define TIMER_ELAPSED     g_elapsed
sl@0: #else
sl@0: #define TIMER_START
sl@0: #define TIMER_END
sl@0: #define TIMER_ELAPSED     ((sqlite_uint64)0)
sl@0: #endif
sl@0: 
sl@0: /*
sl@0: ** If we compile with the SQLITE_TEST macro set, then the following block
sl@0: ** of code will give us the ability to simulate a disk I/O error.  This
sl@0: ** is used for testing the I/O recovery logic.
sl@0: */
sl@0: #ifdef SQLITE_TEST
sl@0: int sqlite3_io_error_hit = 0;            /* Total number of I/O Errors */
sl@0: int sqlite3_io_error_hardhit = 0;        /* Number of non-benign errors */
sl@0: int sqlite3_io_error_pending = 0;        /* Count down to first I/O error */
sl@0: int sqlite3_io_error_persist = 0;        /* True if I/O errors persist */
sl@0: int sqlite3_io_error_benign = 0;         /* True if errors are benign */
sl@0: int sqlite3_diskfull_pending = 0;
sl@0: int sqlite3_diskfull = 0;
sl@0: #define SimulateIOErrorBenign(X) sqlite3_io_error_benign=(X)
sl@0: #define SimulateIOError(CODE)  \
sl@0:   if( (sqlite3_io_error_persist && sqlite3_io_error_hit) \
sl@0:        || sqlite3_io_error_pending-- == 1 )  \
sl@0:               { local_ioerr(); CODE; }
sl@0: static void local_ioerr(){
sl@0:   IOTRACE(("IOERR\n"));
sl@0:   sqlite3_io_error_hit++;
sl@0:   if( !sqlite3_io_error_benign ) sqlite3_io_error_hardhit++;
sl@0: }
sl@0: #define SimulateDiskfullError(CODE) \
sl@0:    if( sqlite3_diskfull_pending ){ \
sl@0:      if( sqlite3_diskfull_pending == 1 ){ \
sl@0:        local_ioerr(); \
sl@0:        sqlite3_diskfull = 1; \
sl@0:        sqlite3_io_error_hit = 1; \
sl@0:        CODE; \
sl@0:      }else{ \
sl@0:        sqlite3_diskfull_pending--; \
sl@0:      } \
sl@0:    }
sl@0: #else
sl@0: #define SimulateIOErrorBenign(X)
sl@0: #define SimulateIOError(A)
sl@0: #define SimulateDiskfullError(A)
sl@0: #endif
sl@0: 
sl@0: /*
sl@0: ** When testing, keep a count of the number of open files.
sl@0: */
sl@0: #ifdef SQLITE_TEST
sl@0: int sqlite3_open_file_count = 0;
sl@0: #define OpenCounter(X)  sqlite3_open_file_count+=(X)
sl@0: #else
sl@0: #define OpenCounter(X)
sl@0: #endif
sl@0: 
sl@0: #endif /* !defined(_OS_COMMON_H_) */