| /* |
| * err.h : interface to routines for returning Berkeley DB errors |
| * |
| * ==================================================================== |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * ==================================================================== |
| */ |
| |
| |
| |
| #ifndef SVN_LIBSVN_FS_BDB_ERR_H |
| #define SVN_LIBSVN_FS_BDB_ERR_H |
| |
| #include <apr_pools.h> |
| |
| #include "svn_error.h" |
| #include "svn_fs.h" |
| |
| #include "env.h" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif /* __cplusplus */ |
| |
| |
| /* Return an svn_error_t object that reports a Berkeley DB error. |
| DB_ERR is the error value returned by the Berkeley DB routine. |
| Wrap and consume pending errors in BDB. */ |
| svn_error_t *svn_fs_bdb__dberr(bdb_env_baton_t *bdb_baton, int db_err); |
| |
| |
| /* Allocate an error object for a Berkeley DB error, with a formatted message. |
| Wrap and consume pending errors in BDB. |
| |
| DB_ERR is the Berkeley DB error code. |
| FMT is a printf-style format string, describing how to format any |
| subsequent arguments. |
| |
| The svn_error_t object returned has a message consisting of: |
| - the text specified by FMT and the subsequent arguments, and |
| - the Berkeley DB error message for the error code DB_ERR. |
| |
| There is no separator between the two messages; if you want one, |
| you should include it in FMT. */ |
| svn_error_t *svn_fs_bdb__dberrf(bdb_env_baton_t *bdb_baton, int db_err, |
| const char *fmt, ...) |
| __attribute__((format(printf, 3, 4))); |
| |
| |
| /* Clear errors associated with BDB. */ |
| void svn_fs_bdb__clear_err(bdb_env_t *bdb); |
| |
| |
| /* Check the return status from the Berkeley DB operation. If the |
| operation succeeded, return zero. Otherwise, construct an |
| appropriate Subversion error object describing what went wrong. |
| - FS is the Subversion filesystem we're operating on. |
| - OPERATION is a gerund clause describing what we were trying to do. |
| - BDB_ERR is the return status from the Berkeley DB function. */ |
| svn_error_t *svn_fs_bdb__wrap_db(svn_fs_t *fs, |
| const char *operation, |
| int db_err); |
| |
| |
| /* A terse wrapper for svn_fs_bdb__wrap_db. */ |
| #define BDB_WRAP(fs, op, err) (svn_fs_bdb__wrap_db((fs), (op), (err))) |
| |
| /* If EXPR returns a non-zero value, pass that value to |
| svn_fs_bdb__dberr and return that function's value. This is like |
| SVN_ERR, but is used by functions that return a Subversion error |
| and call other functions that return a Berkeley DB error code. */ |
| #define SVN_BDB_ERR(bdb, expr) \ |
| do { \ |
| int db_err__temp = (expr); \ |
| if (db_err__temp) \ |
| return svn_fs_bdb__dberr((bdb), db_err__temp); \ |
| svn_error_clear((bdb)->error_info->pending_errors); \ |
| (bdb)->error_info->pending_errors = NULL; \ |
| } while (0) |
| |
| |
| /* If EXPR returns a non-zero value, return it. This is like SVN_ERR, |
| but for functions that return a Berkeley DB error code. */ |
| #define BDB_ERR(expr) \ |
| do { \ |
| int db_err__temp = (expr); \ |
| if (db_err__temp) \ |
| return db_err__temp; \ |
| } while (0) |
| |
| |
| /* Verify that FS refers to an open database; return an appropriate |
| error if this is not the case. */ |
| svn_error_t *svn_fs_bdb__check_fs(svn_fs_t *fs); |
| |
| #ifdef __cplusplus |
| } |
| #endif /* __cplusplus */ |
| |
| #endif /* SVN_LIBSVN_FS_BDB_ERR_H */ |