Storage/VSCSI/VSCSILun.cpp

	VSCSILun.cpp revision 65697a26b524640b83828b715160c798c43a0424
a78048ccbdb6256da15e6b0e7e95355e480c2301nd/* $Id$ */
a78048ccbdb6256da15e6b0e7e95355e480c2301nd/** @file
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd * Virtual SCSI driver: LUN handling
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd */
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd/*
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * Copyright (C) 2006-2010 Oracle Corporation
a78048ccbdb6256da15e6b0e7e95355e480c2301nd *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * This file is part of VirtualBox Open Source Edition (OSE), as
96ad5d81ee4a2cc66a4ae19893efc8aa6d06fae7jailletc * available from http://www.virtualbox.org. This file is free software;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * you can redistribute it and/or modify it under the terms of the GNU
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * General Public License (GPL) as published by the Free Software
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen * Foundation, in version 2 as it comes in the "COPYING" file of the
2e545ce2450a9953665f701bb05350f0d3f26275nd * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen */
a78048ccbdb6256da15e6b0e7e95355e480c2301nd#define LOG_GROUP LOG_GROUP_VSCSI
a78048ccbdb6256da15e6b0e7e95355e480c2301nd#include <VBox/log.h>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd#include <VBox/err.h>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen#include <VBox/types.h>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd#include <VBox/vscsi.h>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd#include <iprt/assert.h>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd#include <iprt/mem.h>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
3f08db06526d6901aa08c110b5bc7dde6bc39905nd#include "VSCSIInternal.h"
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd/** SBC descriptor */
a78048ccbdb6256da15e6b0e7e95355e480c2301ndextern VSCSILUNDESC g_VScsiLunTypeSbc;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd/** MMC descriptor */
81785f72c9d133aef57ad6b02f248345d90239aapoirier//extern PVSCSILUNDESC g_pVScsiLunTypeMmc;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung/**
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * Array of supported SCSI LUN types.
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem */
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluemstatic PVSCSILUNDESC g_aVScsiLunTypesSupported[] =
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak{
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak    &g_VScsiLunTypeSbc
a78048ccbdb6256da15e6b0e7e95355e480c2301nd};
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301ndVBOXDDU_DECL(int) VSCSILunCreate(PVSCSILUN phVScsiLun, VSCSILUNTYPE enmLunType,
a78048ccbdb6256da15e6b0e7e95355e480c2301nd                                 PVSCSILUNIOCALLBACKS pVScsiLunIoCallbacks,
a78048ccbdb6256da15e6b0e7e95355e480c2301nd                                 void *pvVScsiLunUser)
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak{
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak    PVSCSILUNINT  pVScsiLun     = NULL;
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak    PVSCSILUNDESC pVScsiLunDesc = NULL;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    AssertPtrReturn(phVScsiLun, VERR_INVALID_POINTER);
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak    AssertReturn(   enmLunType > VSCSILUNTYPE_INVALID
a78048ccbdb6256da15e6b0e7e95355e480c2301nd                 && enmLunType < VSCSILUNTYPE_LAST, VERR_INVALID_PARAMETER);
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    AssertPtrReturn(pVScsiLunIoCallbacks, VERR_INVALID_PARAMETER);
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    for (unsigned idxLunType = 0; idxLunType < RT_ELEMENTS(g_aVScsiLunTypesSupported); idxLunType++)
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak    {
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak        if (g_aVScsiLunTypesSupported[idxLunType]->enmLunType == enmLunType)
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak        {
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak            pVScsiLunDesc = g_aVScsiLunTypesSupported[idxLunType];
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak            break;
6aadbc6fd703e73d1d419e9f06b84a4338c898f1maczniak        }
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    }
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    if (!pVScsiLunDesc)
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar        return VERR_VSCSI_LUN_TYPE_NOT_SUPPORTED;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    pVScsiLun = (PVSCSILUNINT)RTMemAllocZ(pVScsiLunDesc->cbLun);
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    if (!pVScsiLun)
a78048ccbdb6256da15e6b0e7e95355e480c2301nd        return VERR_NO_MEMORY;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    pVScsiLun->pVScsiDevice         = NULL;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    pVScsiLun->pvVScsiLunUser       = pvVScsiLunUser;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    pVScsiLun->pVScsiLunIoCallbacks = pVScsiLunIoCallbacks;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    pVScsiLun->pVScsiLunDesc        = pVScsiLunDesc;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    int rc = vscsiLunGetFeatureFlags(pVScsiLun, &pVScsiLun->fFeatures);
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    if (RT_SUCCESS(rc))
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    {
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar        rc = pVScsiLunDesc->pfnVScsiLunInit(pVScsiLun);
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar        if (RT_SUCCESS(rc))
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar        {
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar            *phVScsiLun = pVScsiLun;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar            return VINF_SUCCESS;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar        }
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    }
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    RTMemFree(pVScsiLun);
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    return rc;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar}
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar/**
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar * Destroy virtual SCSI LUN.
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar *
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar * @returns VBox status code.
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar * @param   hVScsiLun               The virtual SCSI LUN handle to destroy.
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar */
1f1b6bf13313fdd14a45e52e553d3ff28689b717coarVBOXDDU_DECL(int) VSCSILunDestroy(VSCSILUN hVScsiLun)
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar{
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    PVSCSILUNINT pVScsiLun = (PVSCSILUNINT)hVScsiLun;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    AssertPtrReturn(pVScsiLun, VERR_INVALID_HANDLE);
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    AssertReturn(!pVScsiLun->pVScsiDevice, VERR_VSCSI_LUN_ATTACHED_TO_DEVICE);
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    AssertReturn(vscsiIoReqOutstandingCountGet(pVScsiLun) == 0, VERR_VSCSI_LUN_BUSY);
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    int rc = pVScsiLun->pVScsiLunDesc->pfnVScsiLunDestroy(pVScsiLun);
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    if (RT_FAILURE(rc))
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar        return rc;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    /* Make LUN invalid */
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    pVScsiLun->pvVScsiLunUser       = NULL;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    pVScsiLun->pVScsiLunIoCallbacks = NULL;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    pVScsiLun->pVScsiLunDesc        = NULL;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    RTMemFree(pVScsiLun);
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    return VINF_SUCCESS;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar}
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar