/*- * See the file LICENSE for redistribution information. * * Copyright (c) 1998-2003 * Sleepycat Software. All rights reserved. */ #include "db_config.h" #ifndef lint static const char revid[] = "$Id: xa.c,v 11.29 2003/04/24 16:55:09 bostic Exp $"; #endif /* not lint */ #ifndef NO_SYSTEM_INCLUDES #include #include #include #endif #include "db_int.h" #include "dbinc/txn.h" static int __db_xa_close __P((char *, int, long)); static int __db_xa_commit __P((XID *, int, long)); static int __db_xa_complete __P((int *, int *, int, long)); static int __db_xa_end __P((XID *, int, long)); static int __db_xa_forget __P((XID *, int, long)); static int __db_xa_open __P((char *, int, long)); static int __db_xa_prepare __P((XID *, int, long)); static int __db_xa_recover __P((XID *, long, int, long)); static int __db_xa_rollback __P((XID *, int, long)); static int __db_xa_start __P((XID *, int, long)); static void __xa_put_txn __P((DB_ENV *, DB_TXN *)); /* * Possible flag values: * Dynamic registration 0 => no dynamic registration * TMREGISTER => dynamic registration * Asynchronous operation 0 => no support for asynchrony * TMUSEASYNC => async support * Migration support 0 => migration of transactions across * threads is possible * TMNOMIGRATE => no migration across threads */ const struct xa_switch_t db_xa_switch = { "Berkeley DB", /* name[RMNAMESZ] */ TMNOMIGRATE, /* flags */ 0, /* version */ __db_xa_open, /* xa_open_entry */ __db_xa_close, /* xa_close_entry */ __db_xa_start, /* xa_start_entry */ __db_xa_end, /* xa_end_entry */ __db_xa_rollback, /* xa_rollback_entry */ __db_xa_prepare, /* xa_prepare_entry */ __db_xa_commit, /* xa_commit_entry */ __db_xa_recover, /* xa_recover_entry */ __db_xa_forget, /* xa_forget_entry */ __db_xa_complete /* xa_complete_entry */ }; /* * If you want your XA server to be multi-threaded, then you must * edit this file and change: * #undef XA_MULTI_THREAD * to: * #define XA_MULTI_THREAD 1 * * You must then modify the FILL ME IN; section below to assign a * 32-bit unsigned, unique thread ID to the variable tid. If no * such thread ID is available, e.g., you're using pthreads on a POSIX * 1003.1 system where a pthread_t is declared as a structure, you * will probably want to change the tid field of the DB_TXN structure * to be the correct type in which to define a thread ID on the system, * and then modify both the FILL ME IN section and then subsequent * comparison of the thread IDs in the XA transaction list, as the * current simple equality tests may not work. */ #undef XA_MULTI_THREAD /* * __xa_get_txn -- * Return a pointer to the current transaction structure for the * designated environment. If do_init is non-zero and we don't find a * structure for the current thread, then create a new structure for it. * * PUBLIC: int __xa_get_txn __P((DB_ENV *, DB_TXN **, int)); */ int __xa_get_txn(env, txnp, do_init) DB_ENV *env; DB_TXN **txnp; int do_init; { int ret; #ifdef XA_MULTI_THREAD DB_TXN *t; u_int32_t tid; DB_TXNMGR *mgr; #else COMPQUIET(do_init, 0); #endif ret = 0; #ifdef XA_MULTI_THREAD /* Specify Thread-ID retrieval here. */ tid = FILL ME IN *txnp = NULL; mgr = (DB_TXNMGR *)env->tx_handle; /* * We need to protect the xa_txn linked list, but the * environment does not have a mutex. Since we are in * an XA transaction environment, we know that there is * a transaction structure, so use its mutex. */ DB_ASSERT(env->tx_handle != NULL); MUTEX_THREAD_LOCK(mgr->mutexp); for (t = TAILQ_FIRST(&env->xa_txn); t != NULL; t = TAILQ_NEXT(t, xalinks)) /* * FILL ME IN; if tids are not a 32-bit integral type; * put a comparison here that will work. */ if (t->tid == tid) { *txnp = t; break; } MUTEX_THREAD_UNLOCK(mgr->mutexp); if (*txnp == NULL) { if (!do_init) ret = EINVAL; else if ((ret = __os_malloc(env, sizeof(DB_TXN), NULL, txnp)) == 0) { (*txnp)->tid = tid; MUTEX_THREAD_LOCK(mgr->mutexp); TAILQ_INSERT_HEAD(&env->xa_txn, *txnp, xalinks); MUTEX_THREAD_UNLOCK(mgr->mutexp); } } #else *txnp = TAILQ_FIRST(&env->xa_txn); if (*txnp == NULL && (ret = __os_calloc(env, 1, sizeof(DB_TXN), txnp)) == 0) { (*txnp)->txnid = TXN_INVALID; TAILQ_INSERT_HEAD(&env->xa_txn, *txnp, xalinks); } #endif return (ret); } static void __xa_put_txn(env, txnp) DB_ENV *env; DB_TXN *txnp; { #ifdef XA_MULTI_THREAD DB_TXNMGR *mgr; mgr = (DB_TXNMGR *)env->tx_handle; MUTEX_THREAD_LOCK(mgr->mutexp); TAILQ_REMOVE(&env->xa_txn, txnp, xalinks); MUTEX_THREAD_UNLOCK(mgr->mutexp); __os_free(env, txnp); #else COMPQUIET(env, NULL); txnp->txnid = TXN_INVALID; #endif } #ifdef XA_MULTI_THREAD #define XA_FLAGS \ DB_CREATE | DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_MPOOL | \ DB_INIT_TXN | DB_THREAD #else #define XA_FLAGS \ DB_CREATE | DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_MPOOL | \ DB_INIT_TXN #endif /* * __db_xa_open -- * The open call in the XA protocol. The rmid field is an id number * that the TM assigned us and will pass us on every xa call. We need to * map that rmid number into a dbenv structure that we create during * initialization. Since this id number is thread specific, we do not * need to store it in shared memory. The file xa_map.c implements all * such xa->db mappings. * The xa_info field is instance specific information. We require * that the value of DB_HOME be passed in xa_info. Since xa_info is the * only thing that we get to pass to db_env_create, any config information * will have to be done via a config file instead of via the db_env_create * call. */ static int __db_xa_open(xa_info, rmid, flags) char *xa_info; int rmid; long flags; { DB_ENV *env; if (LF_ISSET(TMASYNC)) return (XAER_ASYNC); if (flags != TMNOFLAGS) return (XAER_INVAL); /* Verify if we already have this environment open. */ if (__db_rmid_to_env(rmid, &env) == 0) return (XA_OK); if (__os_calloc(env, 1, sizeof(DB_ENV), &env) != 0) return (XAER_RMERR); /* Open a new environment. */ if (db_env_create(&env, 0) != 0) return (XAER_RMERR); if (env->open(env, xa_info, XA_FLAGS, 0) != 0) goto err; /* Create the mapping. */ if (__db_map_rmid(rmid, env) != 0) goto err; /* Allocate space for the current transaction. */ TAILQ_INIT(&env->xa_txn); return (XA_OK); err: (void)env->close(env, 0); return (XAER_RMERR); } /* * __db_xa_close -- * The close call of the XA protocol. The only trickiness here * is that if there are any active transactions, we must fail. It is * *not* an error to call close on an environment that has already been * closed (I am interpreting that to mean it's OK to call close on an * environment that has never been opened). */ static int __db_xa_close(xa_info, rmid, flags) char *xa_info; int rmid; long flags; { DB_ENV *env; DB_TXN *t; int ret, t_ret; COMPQUIET(xa_info, NULL); if (LF_ISSET(TMASYNC)) return (XAER_ASYNC); if (flags != TMNOFLAGS) return (XAER_INVAL); /* If the environment is closed, then we're done. */ if (__db_rmid_to_env(rmid, &env) != 0) return (XA_OK); /* Check if there are any pending transactions. */ if ((t = TAILQ_FIRST(&env->xa_txn)) != NULL && t->txnid != TXN_INVALID) return (XAER_PROTO); /* Destroy the mapping. */ ret = __db_unmap_rmid(rmid); /* Discard space held for the current transaction. */ while ((t = TAILQ_FIRST(&env->xa_txn)) != NULL) { TAILQ_REMOVE(&env->xa_txn, t, xalinks); __os_free(env, t); } /* Close the environment. */ if ((t_ret = env->close(env, 0)) != 0 && ret == 0) ret = t_ret; return (ret == 0 ? XA_OK : XAER_RMERR); } /* * __db_xa_start -- * Begin a transaction for the current resource manager. */ static int __db_xa_start(xid, rmid, flags) XID *xid; int rmid; long flags; { DB_ENV *env; DB_TXN *txnp; TXN_DETAIL *td; size_t off; int is_known; #define OK_FLAGS (TMJOIN | TMRESUME | TMNOWAIT | TMASYNC | TMNOFLAGS) if (LF_ISSET(~OK_FLAGS)) return (XAER_INVAL); if (LF_ISSET(TMJOIN) && LF_ISSET(TMRESUME)) return (XAER_INVAL); if (LF_ISSET(TMASYNC)) return (XAER_ASYNC); if (__db_rmid_to_env(rmid, &env) != 0) return (XAER_PROTO); is_known = __db_xid_to_txn(env, xid, &off) == 0; if (is_known && !LF_ISSET(TMRESUME) && !LF_ISSET(TMJOIN)) return (XAER_DUPID); if (!is_known && LF_ISSET(TMRESUME | TMJOIN)) return (XAER_NOTA); /* * This can't block, so we can ignore TMNOWAIT. * * Other error conditions: RMERR, RMFAIL, OUTSIDE, PROTO, RB* */ if (is_known) { td = (TXN_DETAIL *) R_ADDR(&((DB_TXNMGR *)env->tx_handle)->reginfo, off); if (td->xa_status == TXN_XA_SUSPENDED && !LF_ISSET(TMRESUME | TMJOIN)) return (XAER_PROTO); if (td->xa_status == TXN_XA_DEADLOCKED) return (XA_RBDEADLOCK); if (td->xa_status == TXN_XA_ABORTED) return (XA_RBOTHER); /* Now, fill in the global transaction structure. */ if (__xa_get_txn(env, &txnp, 1) != 0) return (XAER_RMERR); __txn_continue(env, txnp, td, off); td->xa_status = TXN_XA_STARTED; } else { if (__xa_get_txn(env, &txnp, 1) != 0) return (XAER_RMERR); if (__txn_xa_begin(env, txnp)) return (XAER_RMERR); (void)__db_map_xid(env, xid, txnp->off); td = (TXN_DETAIL *) R_ADDR(&((DB_TXNMGR *)env->tx_handle)->reginfo, txnp->off); td->xa_status = TXN_XA_STARTED; } return (XA_OK); } /* * __db_xa_end -- * Disassociate the current transaction from the current process. */ static int __db_xa_end(xid, rmid, flags) XID *xid; int rmid; long flags; { DB_ENV *env; DB_TXN *txn; TXN_DETAIL *td; size_t off; if (flags != TMNOFLAGS && !LF_ISSET(TMSUSPEND | TMSUCCESS | TMFAIL)) return (XAER_INVAL); if (__db_rmid_to_env(rmid, &env) != 0) return (XAER_PROTO); if (__db_xid_to_txn(env, xid, &off) != 0) return (XAER_NOTA); if (__xa_get_txn(env, &txn, 0) != 0) return (XAER_RMERR); if (off != txn->off) return (XAER_PROTO); td = (TXN_DETAIL *)R_ADDR(&((DB_TXNMGR *)env->tx_handle)->reginfo, off); if (td->xa_status == TXN_XA_DEADLOCKED) return (XA_RBDEADLOCK); if (td->status == TXN_ABORTED) return (XA_RBOTHER); if (td->xa_status != TXN_XA_STARTED) return (XAER_PROTO); /* Update the shared memory last_lsn field */ td->last_lsn = txn->last_lsn; /* * If we ever support XA migration, we cannot keep SUSPEND/END * status in the shared region; it would have to be process local. */ if (LF_ISSET(TMSUSPEND)) td->xa_status = TXN_XA_SUSPENDED; else td->xa_status = TXN_XA_ENDED; __xa_put_txn(env, txn); return (XA_OK); } /* * __db_xa_prepare -- * Sync the log to disk so we can guarantee recoverability. */ static int __db_xa_prepare(xid, rmid, flags) XID *xid; int rmid; long flags; { DB_ENV *env; DB_TXN *txnp; TXN_DETAIL *td; size_t off; if (LF_ISSET(TMASYNC)) return (XAER_ASYNC); if (flags != TMNOFLAGS) return (XAER_INVAL); /* * We need to know if we've ever called prepare on this. * As part of the prepare, we set the xa_status field to * reflect that fact that prepare has been called, and if * it's ever called again, it's an error. */ if (__db_rmid_to_env(rmid, &env) != 0) return (XAER_PROTO); if (__db_xid_to_txn(env, xid, &off) != 0) return (XAER_NOTA); td = (TXN_DETAIL *)R_ADDR(&((DB_TXNMGR *)env->tx_handle)->reginfo, off); if (td->xa_status == TXN_XA_DEADLOCKED) return (XA_RBDEADLOCK); if (td->xa_status != TXN_XA_ENDED && td->xa_status != TXN_XA_SUSPENDED) return (XAER_PROTO); /* Now, fill in the global transaction structure. */ if (__xa_get_txn(env, &txnp, 0) != 0) return (XAER_PROTO); __txn_continue(env, txnp, td, off); if (txnp->prepare(txnp, (u_int8_t *)xid->data) != 0) return (XAER_RMERR); td->xa_status = TXN_XA_PREPARED; /* No fatal value that would require an XAER_RMFAIL. */ __xa_put_txn(env, txnp); return (XA_OK); } /* * __db_xa_commit -- * Commit the transaction */ static int __db_xa_commit(xid, rmid, flags) XID *xid; int rmid; long flags; { DB_ENV *env; DB_TXN *txnp; TXN_DETAIL *td; size_t off; if (LF_ISSET(TMASYNC)) return (XAER_ASYNC); #undef OK_FLAGS #define OK_FLAGS (TMNOFLAGS | TMNOWAIT | TMONEPHASE) if (LF_ISSET(~OK_FLAGS)) return (XAER_INVAL); /* * We need to know if we've ever called prepare on this. * We can verify this by examining the xa_status field. */ if (__db_rmid_to_env(rmid, &env) != 0) return (XAER_PROTO); if (__db_xid_to_txn(env, xid, &off) != 0) return (XAER_NOTA); td = (TXN_DETAIL *)R_ADDR(&((DB_TXNMGR *)env->tx_handle)->reginfo, off); if (td->xa_status == TXN_XA_DEADLOCKED) return (XA_RBDEADLOCK); if (td->xa_status == TXN_XA_ABORTED) return (XA_RBOTHER); if (LF_ISSET(TMONEPHASE) && td->xa_status != TXN_XA_ENDED && td->xa_status != TXN_XA_SUSPENDED) return (XAER_PROTO); if (!LF_ISSET(TMONEPHASE) && td->xa_status != TXN_XA_PREPARED) return (XAER_PROTO); /* Now, fill in the global transaction structure. */ if (__xa_get_txn(env, &txnp, 0) != 0) return (XAER_RMERR); __txn_continue(env, txnp, td, off); if (txnp->commit(txnp, 0) != 0) return (XAER_RMERR); /* No fatal value that would require an XAER_RMFAIL. */ __xa_put_txn(env, txnp); return (XA_OK); } /* * __db_xa_recover -- * Returns a list of prepared and heuristically completed transactions. * * The return value is the number of xids placed into the xid array (less * than or equal to the count parameter). The flags are going to indicate * whether we are starting a scan or continuing one. */ static int __db_xa_recover(xids, count, rmid, flags) XID *xids; long count, flags; int rmid; { DB_ENV *env; u_int32_t newflags; long rval; /* If the environment is closed, then we're done. */ if (__db_rmid_to_env(rmid, &env) != 0) return (XAER_PROTO); if (LF_ISSET(TMSTARTRSCAN)) newflags = DB_FIRST; else if (LF_ISSET(TMENDRSCAN)) newflags = DB_LAST; else newflags = DB_NEXT; rval = 0; if (__txn_get_prepared(env, xids, NULL, count, &rval, newflags) != 0) return (XAER_RMERR); else return (rval); } /* * __db_xa_rollback * Abort an XA transaction. */ static int __db_xa_rollback(xid, rmid, flags) XID *xid; int rmid; long flags; { DB_ENV *env; DB_TXN *txnp; TXN_DETAIL *td; size_t off; if (LF_ISSET(TMASYNC)) return (XAER_ASYNC); if (flags != TMNOFLAGS) return (XAER_INVAL); if (__db_rmid_to_env(rmid, &env) != 0) return (XAER_PROTO); if (__db_xid_to_txn(env, xid, &off) != 0) return (XAER_NOTA); td = (TXN_DETAIL *)R_ADDR(&((DB_TXNMGR *)env->tx_handle)->reginfo, off); if (td->xa_status == TXN_XA_DEADLOCKED) return (XA_RBDEADLOCK); if (td->xa_status == TXN_XA_ABORTED) return (XA_RBOTHER); if (td->xa_status != TXN_XA_ENDED && td->xa_status != TXN_XA_SUSPENDED && td->xa_status != TXN_XA_PREPARED) return (XAER_PROTO); /* Now, fill in the global transaction structure. */ if (__xa_get_txn(env, &txnp, 0) != 0) return (XAER_RMERR); __txn_continue(env, txnp, td, off); if (txnp->abort(txnp) != 0) return (XAER_RMERR); /* No fatal value that would require an XAER_RMFAIL. */ __xa_put_txn(env, txnp); return (XA_OK); } /* * __db_xa_forget -- * Forget about an XID for a transaction that was heuristically * completed. Since we do not heuristically complete anything, I * don't think we have to do anything here, but we should make sure * that we reclaim the slots in the txnid table. */ static int __db_xa_forget(xid, rmid, flags) XID *xid; int rmid; long flags; { DB_ENV *env; size_t off; if (LF_ISSET(TMASYNC)) return (XAER_ASYNC); if (flags != TMNOFLAGS) return (XAER_INVAL); if (__db_rmid_to_env(rmid, &env) != 0) return (XAER_PROTO); /* * If mapping is gone, then we're done. */ if (__db_xid_to_txn(env, xid, &off) != 0) return (XA_OK); __db_unmap_xid(env, xid, off); /* No fatal value that would require an XAER_RMFAIL. */ return (XA_OK); } /* * __db_xa_complete -- * Used to wait for asynchronous operations to complete. Since we're * not doing asynch, this is an invalid operation. */ static int __db_xa_complete(handle, retval, rmid, flags) int *handle, *retval, rmid; long flags; { COMPQUIET(handle, NULL); COMPQUIET(retval, NULL); COMPQUIET(rmid, 0); COMPQUIET(flags, 0); return (XAER_INVAL); }