stm.h

Go to the documentation of this file.

/******************************************************************************
 * stm.h
 * 
 * Interface definitions for software transactional memory (STM).
 * 
 * Copyright (c) 2002-2003, K A Fraser
 */

#include "ptst.h"
#include <setjmp.h>

typedef struct stm_st stm;
typedef struct stm_blk_st stm_blk;
typedef struct stm_tx_st stm_tx;

stm *new_stm(ptst_t *ptst, int blk_size);
void free_stm(ptst_t *ptst, stm *mem);

stm_blk *new_stm_blk(ptst_t *ptst, stm *mem);
void free_stm_blk(ptst_t *ptst, stm *mem, stm_blk *b);
void *init_stm_blk(ptst_t *ptst, stm *mem, stm_blk *b);
int sizeof_stm_blk(ptst_t *ptst, stm *mem, stm_blk *b);

stm_tx *new_stm_tx(ptst_t *ptst, stm *mem, sigjmp_buf *penv);
bool_t commit_stm_tx(ptst_t *ptst, stm_tx *t);
bool_t validate_stm_tx(ptst_t *ptst, stm_tx *t);
/* NB. Must still call commit after abort, but it's guaranteed to fail. */
void abort_stm_tx(ptst_t *ptst, stm_tx *t);

void *read_stm_blk(ptst_t *ptst, stm_tx *t, stm_blk *b);
void *write_stm_blk(ptst_t *ptst, stm_tx *t, stm_blk *b);

void remove_from_tx(ptst_t *ptst, stm_tx *t, stm_blk *b);

void _init_stm_subsystem(int pad_data);

#define new_stm_tx(_tx, _ptst, _mem)                \
    do {                                            \
        sigjmp_buf env;                             \
        sigsetjmp(env, 1);                          \
        (_tx) = new_stm_tx((_ptst), (_mem), &env);  \
    } while ( 0 )