lmdb.c File Reference

Lightning Memory-Mapped Database (LMDB) backend for the key/value Store. More...

#include "config.h"
#include <lmdb.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <unistd.h>
#include "mutt/lib.h"
#include "lib.h"

Include dependency graph for lmdb.c:

Go to the source code of this file.

Data Structures
struct	LmdbStoreData
	LMDB store. More...

Enumerations
enum	LmdbTxnMode { TXN_UNINITIALIZED , TXN_READ , TXN_WRITE }
	The maximum size of the database file (2GiB). More...

Functions
static void	lmdb_sdata_free (struct LmdbStoreData **ptr)
	Free Lmdb Store Data.
static struct LmdbStoreData *	lmdb_sdata_new (void)
	Create new Lmdb Store Data.
static int	lmdb_get_read_txn (struct LmdbStoreData *sdata)
	Get an LMDB read transaction.
static int	lmdb_get_write_txn (struct LmdbStoreData *sdata)
	Get an LMDB write transaction.
static StoreHandle *	store_lmdb_open (const char *path, bool create)
	Open a connection to a Store - Implements StoreOps::open() -.
static void *	store_lmdb_fetch (StoreHandle *store, const char *key, size_t klen, size_t *vlen)
	Fetch a Value from the Store - Implements StoreOps::fetch() -.
static void	store_lmdb_free (StoreHandle *store, void **ptr)
	Free a Value returned by fetch() - Implements StoreOps::free() -.
static int	store_lmdb_store (StoreHandle *store, const char *key, size_t klen, void *value, size_t vlen)
	Write a Value to the Store - Implements StoreOps::store() -.
static int	store_lmdb_delete_record (StoreHandle *store, const char *key, size_t klen)
	Delete a record from the Store - Implements StoreOps::delete_record() -.
static void	store_lmdb_close (StoreHandle **ptr)
	Close a Store connection - Implements StoreOps::close() -.
static const char *	store_lmdb_version (void)
	Get a Store version string - Implements StoreOps::version() -.

Detailed Description

Lightning Memory-Mapped Database (LMDB) backend for the key/value Store.

Authors

• Pietro Cerutti
• Richard Russon
• Ian Zimmerman

Copyright

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, either version 2 of the License, or (at your option) any later version.

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, see http://www.gnu.org/licenses/.

Definition in file lmdb.c.

Enumeration Type Documentation

LmdbTxnMode

enum LmdbTxnMode

The maximum size of the database file (2GiB).

The file is mmap(2)'d into memory. LMDB transaction state

Enumerator
TXN_UNINITIALIZED	Transaction is uninitialised.
TXN_READ	Read transaction in progress.
TXN_WRITE	Write transaction in progress.

Definition at line 56 of file lmdb.c.

{
  TXN_UNINITIALIZED, 
  TXN_READ,          
  TXN_WRITE,         
};

Function Documentation

lmdb_sdata_free()

static void lmdb_sdata_free ( struct LmdbStoreData **  ptr )

static

Free Lmdb Store Data.

Parameters

ptr	Lmdb Store Data to free

Definition at line 78 of file lmdb.c.

{
  FREE(ptr);
}

Here is the caller graph for this function:

lmdb_sdata_new()

static struct LmdbStoreData * lmdb_sdata_new ( void  )

static

Create new Lmdb Store Data.

Return values

ptr	New Lmdb Store Data

Definition at line 87 of file lmdb.c.

{
  return MUTT_MEM_CALLOC(1, struct LmdbStoreData);
}

Here is the caller graph for this function:

lmdb_get_read_txn()

static int lmdb_get_read_txn ( struct LmdbStoreData *  sdata )

static

Get an LMDB read transaction.

Parameters

sdata

LMDB store

Return values

num	LMDB return code, e.g. MDB_SUCCESS

Definition at line 97 of file lmdb.c.

{
  int rc;
 
  if (sdata->txn && ((sdata->txn_mode == TXN_READ) || (sdata->txn_mode == TXN_WRITE)))
    return MDB_SUCCESS;
 
  if (sdata->txn)
    rc = mdb_txn_renew(sdata->txn);
  else
    rc = mdb_txn_begin(sdata->env, NULL, MDB_RDONLY, &sdata->txn);
 
  if (rc == MDB_SUCCESS)
  {
    sdata->txn_mode = TXN_READ;
  }
  else
  {
    mutt_debug(LL_DEBUG2, "%s: %s\n",
               sdata->txn ? "mdb_txn_renew" : "mdb_txn_begin", mdb_strerror(rc));
  }
 
  return rc;
}

Here is the caller graph for this function:

lmdb_get_write_txn()

static int lmdb_get_write_txn ( struct LmdbStoreData *  sdata )

static

Get an LMDB write transaction.

Parameters

sdata

LMDB store

Return values

num	LMDB return code, e.g. MDB_SUCCESS

Definition at line 127 of file lmdb.c.

{
  if (sdata->txn)
  {
    if (sdata->txn_mode == TXN_WRITE)
      return MDB_SUCCESS;
 
    /* Free up the memory for readonly or reset transactions */
    mdb_txn_abort(sdata->txn);
  }
 
  int rc = mdb_txn_begin(sdata->env, NULL, 0, &sdata->txn);
  if (rc == MDB_SUCCESS)
    sdata->txn_mode = TXN_WRITE;
  else
    mutt_debug(LL_DEBUG2, "mdb_txn_begin: %s\n", mdb_strerror(rc));
 
  return rc;
}

Here is the caller graph for this function: