1N/A/*-
1N/A * See the file LICENSE for redistribution information.
1N/A *
1N/A * Copyright (c) 1996, 1997, 1998
1N/A * Sleepycat Software. All rights reserved.
1N/A */
1N/A
1N/A#pragma ident "%Z%%M% %I% %E% SMI"
1N/A
1N/A#include "config.h"
1N/A
1N/A#ifndef lint
1N/Astatic const char sccsid[] = "@(#)db_iface.c 10.40 (Sleepycat) 12/19/98";
1N/A#endif /* not lint */
1N/A
1N/A#ifndef NO_SYSTEM_INCLUDES
1N/A#include <sys/types.h>
1N/A
1N/A#include <errno.h>
1N/A#endif
1N/A
1N/A#include "db_int.h"
1N/A#include "db_page.h"
1N/A#include "db_auto.h"
1N/A#include "db_ext.h"
1N/A#include "common_ext.h"
1N/A
1N/Astatic int __db_keyempty __P((const DB_ENV *));
1N/Astatic int __db_rdonly __P((const DB_ENV *, const char *));
1N/Astatic int __dbt_ferr __P((const DB *, const char *, const DBT *, int));
1N/A
1N/A/*
1N/A * __db_cdelchk --
1N/A * Common cursor delete argument checking routine.
1N/A *
1N/A * PUBLIC: int __db_cdelchk __P((const DB *, u_int32_t, int, int));
1N/A */
1N/Aint
1N/A__db_cdelchk(dbp, flags, isrdonly, isvalid)
1N/A const DB *dbp;
1N/A u_int32_t flags;
1N/A int isrdonly, isvalid;
1N/A{
1N/A /* Check for changes to a read-only tree. */
1N/A if (isrdonly)
1N/A return (__db_rdonly(dbp->dbenv, "c_del"));
1N/A
1N/A /* Check for invalid function flags. */
1N/A switch (flags) {
1N/A case 0:
1N/A break;
1N/A default:
1N/A return (__db_ferr(dbp->dbenv, "DBcursor->c_del", 0));
1N/A }
1N/A
1N/A /*
1N/A * The cursor must be initialized, return -1 for an invalid cursor,
1N/A * otherwise 0.
1N/A */
1N/A return (isvalid ? 0 : EINVAL);
1N/A}
1N/A
1N/A/*
1N/A * __db_cgetchk --
1N/A * Common cursor get argument checking routine.
1N/A *
1N/A * PUBLIC: int __db_cgetchk __P((const DB *, DBT *, DBT *, u_int32_t, int));
1N/A */
1N/Aint
1N/A__db_cgetchk(dbp, key, data, flags, isvalid)
1N/A const DB *dbp;
1N/A DBT *key, *data;
1N/A u_int32_t flags;
1N/A int isvalid;
1N/A{
1N/A int key_einval, key_flags, ret;
1N/A
1N/A key_einval = key_flags = 0;
1N/A
1N/A /* Check for invalid function flags. */
1N/A LF_CLR(DB_RMW);
1N/A switch (flags) {
1N/A case DB_NEXT_DUP:
1N/A if (dbp->type == DB_RECNO)
1N/A goto err;
1N/A /* FALLTHROUGH */
1N/A case DB_CURRENT:
1N/A case DB_FIRST:
1N/A case DB_LAST:
1N/A case DB_NEXT:
1N/A case DB_PREV:
1N/A key_flags = 1;
1N/A break;
1N/A case DB_GET_BOTH:
1N/A case DB_SET_RANGE:
1N/A key_einval = key_flags = 1;
1N/A break;
1N/A case DB_SET:
1N/A key_einval = 1;
1N/A break;
1N/A case DB_GET_RECNO:
1N/A if (!F_ISSET(dbp, DB_BT_RECNUM))
1N/A goto err;
1N/A break;
1N/A case DB_SET_RECNO:
1N/A if (!F_ISSET(dbp, DB_BT_RECNUM))
1N/A goto err;
1N/A key_einval = key_flags = 1;
1N/A break;
1N/A default:
1N/Aerr: return (__db_ferr(dbp->dbenv, "DBcursor->c_get", 0));
1N/A }
1N/A
1N/A /* Check for invalid key/data flags. */
1N/A if ((ret = __dbt_ferr(dbp, "key", key, 0)) != 0)
1N/A return (ret);
1N/A if ((ret = __dbt_ferr(dbp, "data", data, 0)) != 0)
1N/A return (ret);
1N/A
1N/A /* Check for missing keys. */
1N/A if (key_einval && (key->data == NULL || key->size == 0))
1N/A return (__db_keyempty(dbp->dbenv));
1N/A
1N/A /*
1N/A * The cursor must be initialized for DB_CURRENT, return -1 for an
1N/A * invalid cursor, otherwise 0.
1N/A */
1N/A return (isvalid || flags != DB_CURRENT ? 0 : EINVAL);
1N/A}
1N/A
1N/A/*
1N/A * __db_cputchk --
1N/A * Common cursor put argument checking routine.
1N/A *
1N/A * PUBLIC: int __db_cputchk __P((const DB *,
1N/A * PUBLIC: const DBT *, DBT *, u_int32_t, int, int));
1N/A */
1N/Aint
1N/A__db_cputchk(dbp, key, data, flags, isrdonly, isvalid)
1N/A const DB *dbp;
1N/A const DBT *key;
1N/A DBT *data;
1N/A u_int32_t flags;
1N/A int isrdonly, isvalid;
1N/A{
1N/A int key_einval, key_flags, ret;
1N/A
1N/A key_einval = key_flags = 0;
1N/A
1N/A /* Check for changes to a read-only tree. */
1N/A if (isrdonly)
1N/A return (__db_rdonly(dbp->dbenv, "c_put"));
1N/A
1N/A /* Check for invalid function flags. */
1N/A switch (flags) {
1N/A case DB_AFTER:
1N/A case DB_BEFORE:
1N/A if (dbp->dup_compare != NULL)
1N/A goto err;
1N/A if (dbp->type == DB_RECNO && !F_ISSET(dbp, DB_RE_RENUMBER))
1N/A goto err;
1N/A if (dbp->type != DB_RECNO && !F_ISSET(dbp, DB_AM_DUP))
1N/A goto err;
1N/A break;
1N/A case DB_CURRENT:
1N/A /*
1N/A * If there is a comparison function, doing a DB_CURRENT
1N/A * must not change the part of the data item that is used
1N/A * for the comparison.
1N/A */
1N/A break;
1N/A case DB_KEYFIRST:
1N/A case DB_KEYLAST:
1N/A if (dbp->type == DB_RECNO)
1N/A goto err;
1N/A key_einval = key_flags = 1;
1N/A break;
1N/A default:
1N/Aerr: return (__db_ferr(dbp->dbenv, "DBcursor->c_put", 0));
1N/A }
1N/A
1N/A /* Check for invalid key/data flags. */
1N/A if (key_flags && (ret = __dbt_ferr(dbp, "key", key, 0)) != 0)
1N/A return (ret);
1N/A if ((ret = __dbt_ferr(dbp, "data", data, 0)) != 0)
1N/A return (ret);
1N/A
1N/A /* Check for missing keys. */
1N/A if (key_einval && (key->data == NULL || key->size == 0))
1N/A return (__db_keyempty(dbp->dbenv));
1N/A
1N/A /*
1N/A * The cursor must be initialized for anything other than DB_KEYFIRST
1N/A * and DB_KEYLAST, return -1 for an invalid cursor, otherwise 0.
1N/A */
1N/A return (isvalid ||
1N/A flags == DB_KEYFIRST || flags == DB_KEYLAST ? 0 : EINVAL);
1N/A}
1N/A
1N/A/*
1N/A * __db_closechk --
1N/A * DB->close flag check.
1N/A *
1N/A * PUBLIC: int __db_closechk __P((const DB *, u_int32_t));
1N/A */
1N/Aint
1N/A__db_closechk(dbp, flags)
1N/A const DB *dbp;
1N/A u_int32_t flags;
1N/A{
1N/A /* Check for invalid function flags. */
1N/A if (flags != 0 && flags != DB_NOSYNC)
1N/A return (__db_ferr(dbp->dbenv, "DB->close", 0));
1N/A
1N/A return (0);
1N/A}
1N/A
1N/A/*
1N/A * __db_delchk --
1N/A * Common delete argument checking routine.
1N/A *
1N/A * PUBLIC: int __db_delchk __P((const DB *, DBT *, u_int32_t, int));
1N/A */
1N/Aint
1N/A__db_delchk(dbp, key, flags, isrdonly)
1N/A const DB *dbp;
1N/A DBT *key;
1N/A u_int32_t flags;
1N/A int isrdonly;
1N/A{
1N/A /* Check for changes to a read-only tree. */
1N/A if (isrdonly)
1N/A return (__db_rdonly(dbp->dbenv, "delete"));
1N/A
1N/A /* Check for invalid function flags. */
1N/A switch (flags) {
1N/A case 0:
1N/A break;
1N/A default:
1N/A return (__db_ferr(dbp->dbenv, "DB->del", 0));
1N/A }
1N/A
1N/A /* Check for missing keys. */
1N/A if (key->data == NULL || key->size == 0)
1N/A return (__db_keyempty(dbp->dbenv));
1N/A
1N/A return (0);
1N/A}
1N/A
1N/A/*
1N/A * __db_getchk --
1N/A * Common get argument checking routine.
1N/A *
1N/A * PUBLIC: int __db_getchk __P((const DB *, const DBT *, DBT *, u_int32_t));
1N/A */
1N/Aint
1N/A__db_getchk(dbp, key, data, flags)
1N/A const DB *dbp;
1N/A const DBT *key;
1N/A DBT *data;
1N/A u_int32_t flags;
1N/A{
1N/A int ret;
1N/A
1N/A /* Check for invalid function flags. */
1N/A LF_CLR(DB_RMW);
1N/A switch (flags) {
1N/A case 0:
1N/A case DB_GET_BOTH:
1N/A break;
1N/A case DB_SET_RECNO:
1N/A if (!F_ISSET(dbp, DB_BT_RECNUM))
1N/A goto err;
1N/A break;
1N/A default:
1N/Aerr: return (__db_ferr(dbp->dbenv, "DB->get", 0));
1N/A }
1N/A
1N/A /* Check for invalid key/data flags. */
1N/A if ((ret = __dbt_ferr(dbp, "key", key, flags == DB_SET_RECNO)) != 0)
1N/A return (ret);
1N/A if ((ret = __dbt_ferr(dbp, "data", data, 1)) != 0)
1N/A return (ret);
1N/A
1N/A /* Check for missing keys. */
1N/A if (key->data == NULL || key->size == 0)
1N/A return (__db_keyempty(dbp->dbenv));
1N/A
1N/A return (0);
1N/A}
1N/A
1N/A/*
1N/A * __db_joinchk --
1N/A * Common join argument checking routine.
1N/A *
1N/A * PUBLIC: int __db_joinchk __P((const DB *, u_int32_t));
1N/A */
1N/Aint
1N/A__db_joinchk(dbp, flags)
1N/A const DB *dbp;
1N/A u_int32_t flags;
1N/A{
1N/A if (flags != 0)
1N/A return (__db_ferr(dbp->dbenv, "DB->join", 0));
1N/A
1N/A return (0);
1N/A}
1N/A
1N/A/*
1N/A * __db_putchk --
1N/A * Common put argument checking routine.
1N/A *
1N/A * PUBLIC: int __db_putchk
1N/A * PUBLIC: __P((const DB *, DBT *, const DBT *, u_int32_t, int, int));
1N/A */
1N/Aint
1N/A__db_putchk(dbp, key, data, flags, isrdonly, isdup)
1N/A const DB *dbp;
1N/A DBT *key;
1N/A const DBT *data;
1N/A u_int32_t flags;
1N/A int isrdonly, isdup;
1N/A{
1N/A int ret;
1N/A
1N/A /* Check for changes to a read-only tree. */
1N/A if (isrdonly)
1N/A return (__db_rdonly(dbp->dbenv, "put"));
1N/A
1N/A /* Check for invalid function flags. */
1N/A switch (flags) {
1N/A case 0:
1N/A case DB_NOOVERWRITE:
1N/A break;
1N/A case DB_APPEND:
1N/A if (dbp->type != DB_RECNO)
1N/A goto err;
1N/A break;
1N/A default:
1N/Aerr: return (__db_ferr(dbp->dbenv, "DB->put", 0));
1N/A }
1N/A
1N/A /* Check for invalid key/data flags. */
1N/A if ((ret = __dbt_ferr(dbp, "key", key, 0)) != 0)
1N/A return (ret);
1N/A if ((ret = __dbt_ferr(dbp, "data", data, 0)) != 0)
1N/A return (ret);
1N/A
1N/A /* Check for missing keys. */
1N/A if (key->data == NULL || key->size == 0)
1N/A return (__db_keyempty(dbp->dbenv));
1N/A
1N/A /* Check for partial puts in the presence of duplicates. */
1N/A if (isdup && F_ISSET(data, DB_DBT_PARTIAL)) {
1N/A __db_err(dbp->dbenv,
1N/A"a partial put in the presence of duplicates requires a cursor operation");
1N/A return (EINVAL);
1N/A }
1N/A
1N/A return (0);
1N/A}
1N/A
1N/A/*
1N/A * __db_statchk --
1N/A * Common stat argument checking routine.
1N/A *
1N/A * PUBLIC: int __db_statchk __P((const DB *, u_int32_t));
1N/A */
1N/Aint
1N/A__db_statchk(dbp, flags)
1N/A const DB *dbp;
1N/A u_int32_t flags;
1N/A{
1N/A /* Check for invalid function flags. */
1N/A switch (flags) {
1N/A case 0:
1N/A break;
1N/A case DB_RECORDCOUNT:
1N/A if (dbp->type == DB_RECNO)
1N/A break;
1N/A if (dbp->type == DB_BTREE && F_ISSET(dbp, DB_BT_RECNUM))
1N/A break;
1N/A goto err;
1N/A default:
1N/Aerr: return (__db_ferr(dbp->dbenv, "DB->stat", 0));
1N/A }
1N/A
1N/A return (0);
1N/A}
1N/A
1N/A/*
1N/A * __db_syncchk --
1N/A * Common sync argument checking routine.
1N/A *
1N/A * PUBLIC: int __db_syncchk __P((const DB *, u_int32_t));
1N/A */
1N/Aint
1N/A__db_syncchk(dbp, flags)
1N/A const DB *dbp;
1N/A u_int32_t flags;
1N/A{
1N/A /* Check for invalid function flags. */
1N/A switch (flags) {
1N/A case 0:
1N/A break;
1N/A default:
1N/A return (__db_ferr(dbp->dbenv, "DB->sync", 0));
1N/A }
1N/A
1N/A return (0);
1N/A}
1N/A
1N/A/*
1N/A * __dbt_ferr --
1N/A * Check a DBT for flag errors.
1N/A */
1N/Astatic int
1N/A__dbt_ferr(dbp, name, dbt, check_thread)
1N/A const DB *dbp;
1N/A const char *name;
1N/A const DBT *dbt;
1N/A int check_thread;
1N/A{
1N/A int ret;
1N/A
1N/A /*
1N/A * Check for invalid DBT flags. We allow any of the flags to be
1N/A * specified to any DB or DBcursor call so that applications can
1N/A * set DB_DBT_MALLOC when retrieving a data item from a secondary
1N/A * database and then specify that same DBT as a key to a primary
1N/A * database, without having to clear flags.
1N/A */
1N/A if ((ret = __db_fchk(dbp->dbenv, name, dbt->flags,
1N/A DB_DBT_MALLOC | DB_DBT_USERMEM | DB_DBT_PARTIAL)) != 0)
1N/A return (ret);
1N/A if ((ret = __db_fcchk(dbp->dbenv, name,
1N/A dbt->flags, DB_DBT_MALLOC, DB_DBT_USERMEM)) != 0)
1N/A return (ret);
1N/A
1N/A if (check_thread && F_ISSET(dbp, DB_AM_THREAD) &&
1N/A !F_ISSET(dbt, DB_DBT_MALLOC | DB_DBT_USERMEM)) {
1N/A __db_err(dbp->dbenv,
1N/A "missing flag thread flag for %s DBT", name);
1N/A return (EINVAL);
1N/A }
1N/A return (0);
1N/A}
1N/A
1N/A/*
1N/A * __db_eopnotsup --
1N/A * Common operation not supported message.
1N/A *
1N/A * PUBLIC: int __db_eopnotsup __P((const DB_ENV *));
1N/A */
1N/Aint
1N/A__db_eopnotsup(dbenv)
1N/A const DB_ENV *dbenv;
1N/A{
1N/A __db_err(dbenv, "operation not supported");
1N/A#ifdef EOPNOTSUPP
1N/A return (EOPNOTSUPP);
1N/A#else
1N/A return (EINVAL);
1N/A#endif
1N/A}
1N/A
1N/A/*
1N/A * __db_keyempty --
1N/A * Common missing or empty key value message.
1N/A */
1N/Astatic int
1N/A__db_keyempty(dbenv)
1N/A const DB_ENV *dbenv;
1N/A{
1N/A __db_err(dbenv, "missing or empty key value specified");
1N/A return (EINVAL);
1N/A}
1N/A
1N/A/*
1N/A * __db_rdonly --
1N/A * Common readonly message.
1N/A */
1N/Astatic int
1N/A__db_rdonly(dbenv, name)
1N/A const DB_ENV *dbenv;
1N/A const char *name;
1N/A{
1N/A __db_err(dbenv, "%s: attempt to modify a read-only tree", name);
1N/A return (EACCES);
1N/A}