Grid Application Toolkit A simple API for Grid Applications

Menu Home API-Specification API-Overview Status C Reference Manual Download Java Java-Reference General GridLab - WP-1 Links

GATErrors.h Go to the documentation of this file. /** @file GATErrors.h * Header file defining various GAT error codes. * * We need a consistent naming of errors. This file defines constants * for possible error codes. * * @date Tue Sep 23 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATErrors.h,v 1.37 2004/04/28 10:50:10 hartmutkaiser Exp $ * * Copyright (C) Tom Goodale * This file is part of the GAT Engine. * Contributed by Tom Goodale <goodale@aei.mpg.de>. * * Use, modification and distribution is subject to the Gridlab Software * License. (See accompanying file GLlicense.txt or copy at * http://www.gridlab.org/GLlicense.txt) */ #ifndef _GATERRORS_H_ #define _GATERRORS_H_ 1 #include "xds.h" #include "GATType.h" #include "GATStatus.h" /* * GATResult values are 32 bit values layed out as follows: * * 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 * +---+-+-+-----------------------+-------------------------------+ * |Sev|C|R| Facility | Code | * +---+-+-+-----------------------+-------------------------------+ * * where * * Sev - is the severity code * * 00 - Success * 01 - Informational * 10 - Warning * 11 - Error * * C - is the Customer code flag (may be used by client code) * * R - is a reserved bit * * Facility - is the facility code * * Code - is the facility's status code */ /* Severity values */ #define GAT_SEVERITY_SUCCESS 0x0 #define GAT_SEVERITY_INFORMATIONAL 0x1 #define GAT_SEVERITY_WARNING 0x2 #define GAT_SEVERITY_ERROR 0x3 /* Facility codes */ #define GAT_FACILITY_ENGINE 0 #define GAT_FACILITY_ENGINE_XDS 1 /* xds error codes */ #define GAT_FACILITY_ENGINE_UUID 2 /* uuid error codes */ #define GAT_FACILITY_ENGINE_REGEX 3 /* regex error codes */ #define GAT_FACILITY_POSIX 4 /* errno based error codes */ #define GAT_FACILITY_SQLITE 5 /* sqlite error codes */ #define GAT_FACILITY_FILE_CPI 10 #define GAT_FACILITY_LOGICALFILE_CPI 11 /* Helper macros for the handling of error values */ #define GAT_SUCCEEDED(Status) ((GATResult)(Status) >= 0) /* success */ #define GAT_FAILED(Status) ((GATResult)(Status) < 0) /* inverse */ /* access parts of the result code */ #define GAT_RESULT_CODE(rc) ((rc) & 0xFFFF) #define GAT_RESULT_FACILITY(rc) (((rc) >> 16) & 0x0FFF) #define GAT_RESULT_SEVERITY(rc) (((rc) >> 30) & 0x0003) /* construct a result code */ #define MAKE_GAT_RESULT(sev,fac,code) \ ((GATResult) ( \ ((unsigned long)(sev & 0x0003) << 30) | \ ((unsigned long)(fac & 0x0FFF) << 16) | \ ((unsigned long)(code & 0xFFFF)) ) ) \ /**/ /* Helper macros for constructing result values for the engine */ #define GAT_ENGINE_ERROR(rc) \ MAKE_GAT_RESULT(GAT_SEVERITY_ERROR, GAT_FACILITY_ENGINE, (rc)) \ /**/ /* map a XDS error code to the corresponding GAT error code */ #define XDS_TO_GAT(rc) \ ((XDS_OK == (rc)) ? GAT_SUCCESS : \ MAKE_GAT_RESULT(GAT_SEVERITY_ERROR, GAT_FACILITY_ENGINE_XDS, -(rc))) \ /**/ /* map uuid error code to the corresponding GAT error code */ #define UUID_TO_GAT(rc) \ ((UUID_RC_OK == (rc)) ? GAT_SUCCESS : \ MAKE_GAT_RESULT(GAT_SEVERITY_ERROR, GAT_FACILITY_ENGINE_UUID, (rc))) \ /**/ /* map regex error code to the corresponding GAT error code */ #define REGEX_TO_GAT(rc) \ ((REG_NOERROR == (rc)) ? GAT_SUCCESS : \ MAKE_GAT_RESULT(GAT_SEVERITY_ERROR, GAT_FACILITY_ENGINE_REGEX, (rc))) \ /**/ /* map sqlite error code to the corresponding GAT error code */ #define SQLITE_TO_GAT(rc) \ ((SQLITE_OK == (rc)) ? GAT_SUCCESS : \ MAKE_GAT_RESULT(GAT_SEVERITY_ERROR, GAT_FACILITY_SQLITE, (rc))) \ /**/ /* map POSIX error code to the corresponding GAT error code */ #define POSIX_TO_GAT(rc) \ ((0 == (rc)) ? GAT_SUCCESS : \ MAKE_GAT_RESULT(GAT_SEVERITY_ERROR, GAT_FACILITY_POSIX, (rc))) \ /**/ /* Error codes used in the GAT engine (FACILITY_ENGINE) */ #define GAT_FALSE /* not GAT_SUCCESS, but no error */ \ MAKE_GAT_RESULT(GAT_SEVERITY_SUCCESS, GAT_FACILITY_ENGINE, 1) \ /**/ #define GAT_SUCCESS \ MAKE_GAT_RESULT(GAT_SEVERITY_SUCCESS, GAT_FACILITY_ENGINE, 0) \ /**/ /* Error codes used by the GAT engine */ #define GAT_FAIL GAT_ENGINE_ERROR(1) #define GAT_NOTIMPL GAT_ENGINE_ERROR(2) #define GAT_MEMORYFAILURE GAT_ENGINE_ERROR(3) #define GAT_DUPLICATE_ADAPTOR GAT_ENGINE_ERROR(4) #define GAT_FAILED_TO_LOAD_ADAPTOR GAT_ENGINE_ERROR(5) #define GAT_NO_ADAPTOR_REGISTRATION_FUNC GAT_ENGINE_ERROR(6) #define GAT_DUPLICATE_CONFIG GAT_ENGINE_ERROR(7) #define GAT_FILEOPEN_ERROR GAT_ENGINE_ERROR(8) #define GAT_KEY_NOT_FOUND GAT_ENGINE_ERROR(9) #define GAT_KEY_TYPE_ERROR GAT_ENGINE_ERROR(10) #define GAT_INVALID_HANDLE GAT_ENGINE_ERROR(11) #define GAT_INVALID_PARAMETER GAT_ENGINE_ERROR(12) #define GAT_UNKNOWN_VERSION GAT_ENGINE_ERROR(13) #define GAT_NO_REGISTERED_CPI GAT_ENGINE_ERROR(14) #define GAT_INVALID_ENCODING GAT_ENGINE_ERROR(15) #define GAT_INCOMPLETE_ENCODING GAT_ENGINE_ERROR(16) #define GAT_NO_MATCHING_CPI GAT_ENGINE_ERROR(17) #define GAT_NO_MATCHING_RESOURCE GAT_ENGINE_ERROR(18) #define GAT_NO_INTERFACE GAT_ENGINE_ERROR(19) #define GAT_UNKNOWN_FORMAT GAT_ENGINE_ERROR(20) #define GAT_KEY_ALREADY_EXISTS GAT_ENGINE_ERROR(21) #define GAT_REMOTE_CALL_FAILED GAT_ENGINE_ERROR(22) #define GAT_IO_ERROR GAT_ENGINE_ERROR(23) #define GAT_INVALID_STATE GAT_ENGINE_ERROR(24) #define GAT_TYPE_MISMATCH GAT_ENGINE_ERROR(25) #define GAT_BUFFER_TOO_SMALL GAT_ENGINE_ERROR(26) #define GAT_BAD_OBJECT_CONVERSION GAT_ENGINE_ERROR(27) #define GAT_INVALID_CONFIG_FORMAT GAT_ENGINE_ERROR(28) #define GAT_ERROR_CONTEXT_ONLY GAT_ENGINE_ERROR(29) /* Helper macros to simplify error diagnostics and error propagation */ /* * GAT_USES_STATUS is to be used as the first statement inside of every * function, which has to handle GATStatus based errors/diagnostics. */ #define GAT_USES_STATUS(ctx, name) \ GATStatus __status = NULL; \ GATContext __ctx = (ctx); \ char const *__name = (name); \ GATResult __retval = GAT_SUCCESS \ /**/ /* * GAT_STATUS_APIENTRY is essentially equivalent to GAT_USES_STATUS, except * that it will initialise the current status to zero, thus this macro should * be used on any high level API entry point only. */ #define GAT_STATUS_APIENTRY(ctx, name) \ GATStatus __status = NULL; \ GATContext __ctx = (ctx); \ char const *__name = (name); \ GATResult __retval = GATContext_SetCurrentStatus((ctx), 0) \ /**/ #define GAT_CREATE_STATUS(f) \ { \ if (GAT_SUCCEEDED(__retval)) \ { \ if (GAT_FAILED(__retval = (f))) \ { __retval = GATCreateStatus(__name, &__status, __retval, __ctx, \ __FILE__, __LINE__); } \ } \ } \ /**/ #define GAT_CREATE_STATUS_UNCOND(f) \ { \ if (GAT_FAILED(__retval = (f))) \ { __retval = GATCreateStatus(__name, &__status, __retval, __ctx, \ __FILE__, __LINE__); } \ } \ /**/ #define GAT_CREATE_STATUS_MSG(rc, msg) \ { \ if (GAT_SUCCEEDED(__retval)) \ { \ __retval = GATCreateStatus(__name, &__status, (rc), __ctx, \ __FILE__, __LINE__); \ GATStatus_AddMessage(__status, msg); \ } \ } \ /**/ #define GAT_CREATE_STATUS_IF(cond, rc) \ { \ if (GAT_SUCCEEDED(__retval)) \ { \ if (cond) { __retval = GATCreateStatus(__name, &__status, (rc), __ctx, \ __FILE__, __LINE__); } \ else { __retval = GAT_SUCCESS; } \ } \ } \ /**/ #define GAT_CREATE_STATUS_IF_MSG(cond, rc, msg) \ { \ if (GAT_SUCCEEDED(__retval)) \ { \ if (cond) { \ __retval = GATCreateStatus(__name, &__status, (rc), __ctx, \ __FILE__, __LINE__); \ GATStatus_AddMessage(__status, msg); \ } \ else { __retval = GAT_SUCCESS; } \ } \ } \ /**/ #define GAT_STATUS_ADD_MESSAGE(msg) \ GATStatus_AddMessage(__status, msg) \ /**/ #ifdef GAT_ENABLE_PROPAGATE_STATUS_MACROS #define GAT_PROPAGATE_STATUS(f) \ { \ if (GAT_SUCCEEDED(__retval)) \ { \ if (GAT_FAILED(__retval = (f))) \ { __retval = GATPropagateStatus(__name, &__status, __retval, __ctx); } \ } \ } \ /**/ #define GAT_PROPAGATE_STATUS_UNCOND(f) \ { \ if (GAT_FAILED(__retval = (f))) \ { __retval = GATPropagateStatus(__name, &__status, __retval, __ctx); } \ } \ /**/ #define GAT_PROPAGATE_STATUS_IF(cond, rc) \ { \ if (GAT_SUCCEEDED(__retval)) \ { \ if (cond) \ { __retval = GATPropagateStatus(__name, &__status, rc, __ctx); } \ } \ } \ /**/ #endif /* GAT_ENABLE_PROPAGATE_STATUS_MACROS */ #define GAT_RETURN_STATUS() \ (NULL != __status) ? \ GATContext_SetCurrentStatus(__ctx, &__status), __retval : __retval; \ /**/ #define GAT_STORE_STATUS() \ { \ if (NULL != __status) \ { \ GATContext_SetCurrentStatus(__ctx, &__status); \ } \ } \ /**/ #define GAT_CURRENT_STATUS() __retval #endif /* _GATERRORS_H_ */