/*
 * Copyright (C) 2008 Search Solution Corporation. All rights reserved by Search Solution.
 *
 *   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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 */

#ifndef _LOG_COMM_H_
#define _LOG_COMM_H_

#ident "$Id$"

#include <stdio.h>
#include "storage_common.h"
#include "dbdef.h"
#include "object_representation.h"


#if defined(L_cuserid)
#define LOG_USERNAME_MAX L_cuserid
#else /* L_cuserid */
#define LOG_USERNAME_MAX 9
#endif /* L_cuserid */

#define TRAN_LOCK_INFINITE_WAIT (-1)

#define LOG_ONELOG_PACKED_SIZE (OR_INT_SIZE * 3)

#define LOG_MANYLOGS_PTR_IN_LOGAREA(log_areaptr)                         \
  ((struct manylogs *) ((char *)log_areaptr->mem + log_areaptr->length - \
                                  DB_SIZEOF(struct manylogs)))

/*
 * STATES OF TRANSACTIONS
 */
typedef enum
{
  TRAN_RECOVERY,		/* State of a system
				 *  transaction which is
				 *  used for recovery
				 *  purposes. For example
				 *  , set lock for
				 *  damaged pages.
				 */
  TRAN_ACTIVE,			/* Active transaction */
  TRAN_UNACTIVE_COMMITTED,	/* Transaction is in
				   the commit process
				   or has been comitted
				 */
  TRAN_UNACTIVE_WILL_COMMIT,	/* Transaction will be
				   committed
				 */
  TRAN_UNACTIVE_COMMITTED_WITH_POSTPONE,	/* Transaction has been
						   committed, but it is
						   still executing
						   postpone operations
						 */
  TRAN_UNACTIVE_COMMITTED_WITH_CLIENT_USER_LOOSE_ENDS,	/* Transaction has being
							   committed, but it is
							   still executing
							   postpone operations
							   on the client machine
							   (e.g., mutimedia
							   external files)
							 */
  TRAN_UNACTIVE_TOPOPE_COMMITTED_WITH_POSTPONE,	/* In the process of
						   executing postpone
						   top system operations
						 */
  TRAN_UNACTIVE_XTOPOPE_COMMITTED_WITH_CLIENT_USER_LOOSE_ENDS,
  /* In the process of
     executing postpone
     client top system
     operations
   */
  TRAN_UNACTIVE_ABORTED,	/* Transaction is in the
				   abort process or has
				   been aborted
				 */
  TRAN_UNACTIVE_UNILATERALLY_ABORTED,	/* Transaction was
					   active a the time of
					   a system crash. The
					   transaction is
					   unilaterally aborted
					   by the system
					 */
  TRAN_UNACTIVE_ABORTED_WITH_CLIENT_USER_LOOSE_ENDS,	/* Transaction has being
							   aborted, but it is
							   still executing undo
							   operations on the
							   client machine (e.g.,
							   mutimedia external
							   files)
							 */
  TRAN_UNACTIVE_TOPOPE_ABORTED_WITH_CLIENT_USER_LOOSE_ENDS,
  /* In the process of
     executing undo
     client top system
     operations
   */
  TRAN_UNACTIVE_2PC_PREPARE,	/* Local part of the
				   distributed
				   transaction is ready
				   to commit. (It will
				   not be unilaterally
				   aborted by the
				   system)
				 */

  TRAN_UNACTIVE_2PC_COLLECTING_PARTICIPANT_VOTES,	/* First phase of 2PC
							   protocol. Transaction
							   is collecting votes
							   from participants
							 */

  TRAN_UNACTIVE_2PC_ABORT_DECISION,	/* Second phase of 2PC
					   protocol. Transaction
					   needs to be aborted
					   both locally and
					   globally.
					 */

  TRAN_UNACTIVE_2PC_COMMIT_DECISION,	/* Second phase of 2PC
					   protocol. Transaction
					   needs to be committed
					   both locally and
					   globally.
					 */

  TRAN_UNACTIVE_COMMITTED_INFORMING_PARTICIPANTS,	/* Transaction has been
							   committed, and it is
							   informing
							   participants about
							   the decision.
							 */
  TRAN_UNACTIVE_ABORTED_INFORMING_PARTICIPANTS,	/* Transaction has been
						   aborted, and it is
						   informing
						   participants about
						   the decision.
						 */

  TRAN_UNACTIVE_UNKNOWN		/* Unknown state. */
} TRAN_STATE;

/*
 * RESULT OF NESTED TOP OPERATION
 */

typedef enum
{
  LOG_RESULT_TOPOP_COMMIT,
  LOG_RESULT_TOPOP_ABORT,
  LOG_RESULT_TOPOP_ATTACH_TO_OUTER
} LOG_RESULT_TOPOP;

/* name used by the internal modules */
typedef DB_TRAN_ISOLATION TRAN_ISOLATION;
typedef int LOG_RCVCLIENT_INDEX;	/* Index to recovery functions */

typedef struct log_copy LOG_COPY;
struct log_copy
{				/* Copy area for flushing and fetching */
  char *mem;			/* Pointer to location of chunk of area */
  int length;			/* The size of the area                 */
};

struct onelog
{				/* One data record to recovery */
  LOG_RCVCLIENT_INDEX rcvindex;	/* Recovery function to apply */
  int length;			/* Length of the data         */
  int offset;			/* Offset to data             */
};

struct manylogs
{
  struct onelog onelog;
  int num_logs;			/* How many log recovery records are described */
};


extern const char *log_state_string (TRAN_STATE state);
extern const char *log_isolation_string (TRAN_ISOLATION isolation);
extern LOG_COPY *log_alloc_client_copy_area (int length);
extern void log_free_client_copy_area (LOG_COPY * copy_area);
extern char *log_pack_descriptors (int num_records, LOG_COPY * log_area,
				   char *descriptors);
extern char *log_unpack_descriptors (int num_records, LOG_COPY * log_area,
				     char *descriptors);
extern int
log_copy_area_send (LOG_COPY * log_area, char **contents_ptr,
		    int *contents_length, char **descriptors_ptr,
		    int *descriptors_length);
extern LOG_COPY *log_copy_area_malloc_recv (int num_records,
					    char **packed_descriptors,
					    int packed_descriptors_length,
					    char **contents_ptr,
					    int contents_length);
#endif /* _LOG_COMM_H_ */