54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * IPRT - Internal RTFileAio header.
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync * Copyright (C) 2009-2010 Oracle Corporation
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * available from http://www.virtualbox.org. This file is free software;
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * you can redistribute it and/or modify it under the terms of the GNU
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * General Public License (GPL) as published by the Free Software
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * The contents of this file may alternatively be used under the terms
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * of the Common Development and Distribution License Version 1.0
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * VirtualBox OSE distribution, in which case the provisions of the
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * CDDL are applicable instead of those of the GPL.
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * You may elect to license modified versions of this file under the
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync * terms and conditions of either the GPL or the CDDL or both.
be196d173cf52fa33016912e4745dbe1170ac53avboxsync/*******************************************************************************
be196d173cf52fa33016912e4745dbe1170ac53avboxsync* Structures and Typedefs *
be196d173cf52fa33016912e4745dbe1170ac53avboxsync*******************************************************************************/
be196d173cf52fa33016912e4745dbe1170ac53avboxsync * Defined request states.
be196d173cf52fa33016912e4745dbe1170ac53avboxsync /** Prepared. */
be196d173cf52fa33016912e4745dbe1170ac53avboxsync /** Submitted. */
be196d173cf52fa33016912e4745dbe1170ac53avboxsync /** Completed. */
be196d173cf52fa33016912e4745dbe1170ac53avboxsync /** Omni present 32bit hack. */
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync/*******************************************************************************
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync* Defined Constants And Macros *
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync*******************************************************************************/
be196d173cf52fa33016912e4745dbe1170ac53avboxsync/** Return true if the specified request is not valid, false otherwise. */
be196d173cf52fa33016912e4745dbe1170ac53avboxsync (RT_UNLIKELY(!VALID_PTR(pReq) || (pReq->u32Magic != RTFILEAIOREQ_MAGIC)))
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync/** Validates a context handle and returns VERR_INVALID_HANDLE if not valid. */
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync AssertReturn((pReq)->u32Magic == RTFILEAIOREQ_MAGIC, (rc)); \
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync } while (0)
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync/** Validates a context handle and returns VERR_INVALID_HANDLE if not valid. */
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync#define RTFILEAIOREQ_VALID_RETURN(pReq) RTFILEAIOREQ_VALID_RETURN_RC((pReq), VERR_INVALID_HANDLE)
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync/** Validates a context handle and returns (void) if not valid. */
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync AssertReturnVoid((pReq)->u32Magic == RTFILEAIOREQ_MAGIC); \
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync } while (0)
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync/** Validates a context handle and returns the specified rc if not valid. */
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync AssertReturn((pCtx)->u32Magic == RTFILEAIOCTX_MAGIC, (rc)); \
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync } while (0)
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync/** Validates a context handle and returns VERR_INVALID_HANDLE if not valid. */
54ef23bbaabcca4d29153c08c477acc6bc78f713vboxsync#define RTFILEAIOCTX_VALID_RETURN(pCtx) RTFILEAIOCTX_VALID_RETURN_RC((pCtx), VERR_INVALID_HANDLE)
be196d173cf52fa33016912e4745dbe1170ac53avboxsync/** Checks if a request is in the specified state and returns the specified rc if not. */
be196d173cf52fa33016912e4745dbe1170ac53avboxsync#define RTFILEAIOREQ_STATE_RETURN_RC(pReq, State, rc) \
be196d173cf52fa33016912e4745dbe1170ac53avboxsync if (RT_UNLIKELY(pReq->enmState != RTFILEAIOREQSTATE_##State)) \
be196d173cf52fa33016912e4745dbe1170ac53avboxsync } while (0)
be196d173cf52fa33016912e4745dbe1170ac53avboxsync/** Checks if a request is not in the specified state and returns the specified rc if it is. */
be196d173cf52fa33016912e4745dbe1170ac53avboxsync#define RTFILEAIOREQ_NOT_STATE_RETURN_RC(pReq, State, rc) \
be196d173cf52fa33016912e4745dbe1170ac53avboxsync if (RT_UNLIKELY(pReq->enmState == RTFILEAIOREQSTATE_##State)) \
be196d173cf52fa33016912e4745dbe1170ac53avboxsync } while (0)
643b32fda84b53ffdc94e190ff8c5bce34d022b0vboxsync/** Checks if a request in the given states and sserts if not. */
643b32fda84b53ffdc94e190ff8c5bce34d022b0vboxsync Assert((pReq)->enmState == RTFILEAIOREQSTATE_##State); \
643b32fda84b53ffdc94e190ff8c5bce34d022b0vboxsync } while (0)
be196d173cf52fa33016912e4745dbe1170ac53avboxsync/** Sets the request into a specific state. */
be196d173cf52fa33016912e4745dbe1170ac53avboxsync } while (0)