/* BLURB gpl

                           Coda File System
                              Release 8

          Copyright (c) 1987-2021 Carnegie Mellon University
                  Additional copyrights listed below

This  code  is  distributed "AS IS" without warranty of any kind under
the terms of the GNU General Public Licence Version 2, as shown in the
file  LICENSE.  The  technical and financial  contributors to Coda are
listed in the file CREDITS.

                        Additional copyrights

#*/

/*
                         IBM COPYRIGHT NOTICE

                          Copyright (C) 1986
             International Business Machines Corporation
                         All Rights Reserved

This  file  contains  some  code identical to or derived from the 1986
version of the Andrew File System ("AFS"), which is owned by  the  IBM
Corporation.   This  code is provided "AS IS" and IBM does not warrant
that it is free of infringement of  any  intellectual  rights  of  any
third  party.    IBM  disclaims  liability of any kind for any damages
whatsoever resulting directly or indirectly from use of this  software
or  of  any  derivative work.  Carnegie Mellon University has obtained
permission to  modify,  distribute and sublicense this code,  which is
based on Version 2  of  AFS  and  does  not  contain  the features and
enhancements that are part of  Version 3 of  AFS.  Version 3 of AFS is
commercially   available   and  supported  by   Transarc  Corporation,
Pittsburgh, PA.

*/

#ifdef __cplusplus
extern "C" {
#endif

#include <sys/types.h>
#include <sys/time.h>
#include <sys/param.h>
#include <stdio.h>
#include <sys/file.h>
#include <sys/stat.h>

#include <unistd.h>
#include <stdlib.h>
#include <lwp/lwp.h>
#include <lwp/lock.h>
#include <util.h>
#include <rvmlib.h>
#include <volutil.h>
#include <vice.h>

#ifdef __cplusplus
}
#endif

#include <cvnode.h>
#include <volume.h>
#include <viceinode.h>
#include <partition.h>
#include <vutil.h>
#include <recov.h>

/*
  S_VolPurge: Purge the requested volume
*/
long int S_VolPurge(RPC2_Handle rpcid, RPC2_Unsigned formal_purgeId,
                    RPC2_String formal_purgeName) EXCLUDES_TRANSACTION
{
    Error error  = 0;
    Error error2 = 0;
    Volume *vp   = NULL;
    int status   = 0;
    int rc       = 0;
    ProgramType *pt;
    int AlreadyOffline = 0;

    /* To keep C++ 2.0 happy */
    char *purgeName  = (char *)formal_purgeName;
    VolumeId purgeId = (VolumeId)formal_purgeId;
    char *rock;

    VLog(69, "Checking lwp rock in S_VolPurge");
    CODA_ASSERT(LWP_GetRock(FSTAG, &rock) == LWP_SUCCESS);
    pt = (ProgramType *)rock;

    VLog(9, "Entering S_VolPurge: purgeId = %x, purgeName = %s", purgeId,
         purgeName);
    rc = VInitVolUtil(volumeUtility);
    if (rc != 0) {
        VLog(0, "S_VolPurge: returned %ld from VInitVolUtil; aborting", rc);
        return rc;
    }

    vp = VGetVolume(&error, purgeId); /* Does this need a transaction? */
    if (!vp) {
        rc = VNOVOL;
        VLog(0, "No such volume: 0x%x\n", purgeId);
        goto exit;
    }
    if (error) {
        if (error == VOFFLINE) {
            VLog(9, "VolPurge: Volume %x was already offline", V_id(vp));
            AlreadyOffline = 1;
        } else if (error == VNOVOL) {
            /* volume is not attached or is shutting down */

            vp = VAttachVolume(&error2, purgeId, V_UPDATE);
            if (error2) {
                VLog(0, "Unable to attach volume %x; not purged", purgeId);
                rc = VNOVOL;
                goto exit;
            }
            AlreadyOffline = 1;
        } else {
            if (vp)
                VPutVolume(vp);
            VLog(0, "VolPurge: GetVolume %x  returns error %d", purgeId, error);
            rc = error;
            goto exit;
        }
    }

    CODA_ASSERT(vp != NULL);
    if (strcmp(V_name(vp), purgeName) != 0) {
        VLog(0,
             "The name you specified (%s) does not match the internal name "
             "(%s) for volume %x; not purged",
             purgeName, V_name(vp), purgeId);
        VPutVolume(vp);
        rc = VNOVOL;
        goto exit;
    }

    if (!AlreadyOffline) {
        /* force the volume offline */
        VLog(9, "VolPurge: Forcing Volume %x offline", V_id(vp));
        *pt = fileServer;
        VOffline(vp, "Volume being Purged");
        *pt = volumeUtility;
        vp  = VGetVolume(&error, purgeId);
        CODA_ASSERT(error == VOFFLINE);
    }

    if (status != 0) {
        VLog(0, "S_VolPurge: Transaction aborted!");
        VDisconnectFS();
        return status;
    }

    /* By this time the volume is attached and is offline */
    CODA_ASSERT(V_inUse(vp) == 0);
    CODA_ASSERT(DeleteVolume(vp) == 0); /* Remove volume from rvm and vm */
    vp->shuttingDown = 1;

    /* Don't need to call VPutVolume since all vm traces have been removed. */

    PrintVolumesInHashTable();
exit:
    VDisconnectFS();
    if (!rc)
        VLog(0, "purge: volume %x (%s) purged", purgeId, purgeName);
    return (status ? status : rc);
}
