/*
   BAREOS® - Backup Archiving REcovery Open Sourced

   Copyright (C) 2002-2012 Free Software Foundation Europe e.V.
   Copyright (C) 2011-2012 Planets Communications B.V.
   Copyright (C) 2013-2024 Bareos GmbH & Co. KG

   This program is Free Software; you can redistribute it and/or
   modify it under the terms of version three of the GNU Affero General Public
   License as published by the Free Software Foundation and included
   in the file LICENSE.

   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
   02110-1301, USA.
*/
// Kern Sibbald, August MMII
/**
 * @file
 * Routines for handling mounting tapes for reading and for writing.
 */

#include "include/bareos.h" /* pull in global headers */
#include "stored/stored.h"  /* pull in Storage Daemon headers */
#include "stored/acquire.h"
#include "stored/autochanger.h"
#include "stored/device_control_record.h"
#include "stored/stored_jcr_impl.h"
#include "stored/label.h"
#include "lib/edit.h"
#include "include/jcr.h"
#include "lib/bsock.h"

namespace storagedaemon {

static pthread_mutex_t mount_mutex = PTHREAD_MUTEX_INITIALIZER;

enum
{
  try_next_vol = 1,
  try_read_vol,
  try_error,
  try_default
};

enum
{
  check_next_vol = 1,
  check_ok,
  check_read_vol,
  check_error
};

/**
 * If release is set, we rewind the current volume,
 * which we no longer want, and ask the user (console)
 * to mount the next volume.
 *
 *  Continue trying until we get it, and then ensure
 *  that we can write on it.
 *
 * This routine returns a 0 only if it is REALLY
 *  impossible to get the requested Volume.
 *
 * This routine is entered with the device blocked, but not
 *   locked.
 *
 */
bool DeviceControlRecord::MountNextWriteVolume()
{
  int retry = 0;
  bool ask = false, recycle, autochanger;
  DeviceMode mode;
  DeviceControlRecord* dcr = this;

  Dmsg2(150, "Enter mount_next_volume(release=%d) dev=%s\n", dev->MustUnload(),
        dev->print_name());

  InitDeviceWaitTimers(dcr);

  lock_mutex(mount_mutex);

  /* Attempt to mount the next volume. If something non-fatal goes
   *  wrong, we come back here to re-try (new op messages, re-read
   *  Volume, ...) */

mount_next_vol:
  Dmsg1(150, "mount_next_vol retry=%d\n", retry);
  // Ignore retry if this is poll request
  if (retry++ > 4) {
    // Last ditch effort before giving up, force operator to respond
    VolCatInfo.Slot = 0;
    unlock_mutex(mount_mutex);
    if (!dcr->DirAskSysopToMountVolume(ST_APPENDREADY)) {
      Jmsg(jcr, M_FATAL, 0, T_("Too many errors trying to mount device %s.\n"),
           dev->print_name());
      goto no_lock_bail_out;
    }
    lock_mutex(mount_mutex);
    Dmsg1(150, "Continue after dir_ask_sysop_to_mount. must_load=%d\n",
          dev->must_load());
  }

  if (jcr->IsJobCanceled()) {
    Jmsg(jcr, M_FATAL, 0, T_("Job %d canceled.\n"), jcr->JobId);
    goto bail_out;
  }
  recycle = false;

  if (dev->MustUnload()) { ask = true; /* ask operator to mount tape */ }

  DoUnload();
  DoSwapping(true /*IsWriting*/);
  DoLoad(true /*IsWriting*/);

  if (!find_a_volume()) { goto bail_out; }

  if (jcr->IsJobCanceled()) { goto bail_out; }

  Dmsg2(150, "After find_next_append. Vol=%s Slot=%d\n", getVolCatName(),
        VolCatInfo.Slot);

  /* Get next volume and ready it for append
   * This code ensures that the device is ready for
   * writing. We start from the assumption that there
   * may not be a tape mounted.
   *
   * If the device is a file, we create the output
   * file. If it is a tape, we check the volume name
   * and move the tape to the end of data. */
  dcr->setVolCatInfo(false); /* out of date when Vols unlocked */

  /* See if this is a retry of the mounting of the next volume.
   * If the device is already open close it first as otherwise we could
   * potentially write to an already open device a new volume label.
   * This is only interesting for non tape devices. */
  if (!dev->IsTape()) {
    if (retry && dev->IsOpen()) { dev->close(dcr); }
  }

  switch (AutoloadDevice(dcr, true /* writing */, NULL)) {
    case -3:
      Dmsg0(100, "Wait after a unsuccessful tape load (empty slot).\n");
      Jmsg0(jcr, M_WARNING, 0,
            "Wait after a unsuccessful tape load (empty slot).\n");
      Bmicrosleep(1, 0);
      dev->VolHdr.VolumeName[0] = 0;
      dev->vol = 0; /* do not free volume here because in this case
                     * it is still on the vol_list chain for another job */
      goto mount_next_vol;
      break;
    case -2:
    case -1:
      // -1 => error on autochanger
      autochanger = false;
      VolCatInfo.Slot = 0;
      ask = retry >= 2;
      break;
    case 0:
      // 0 => failure (no changer available)
      autochanger = false;
      VolCatInfo.Slot = 0;

      /* If the VolCatInfo.InChanger flag is not set we are trying to use a
       * volume that is not in the autochanger so that means we need to ask the
       * operator to mount it. */
      if (dev->AttachedToAutochanger() && !VolCatInfo.InChanger) {
        ask = true;
      } else {
        ask = retry >= 2;
      }
      break;
    default:
      // Success
      autochanger = true;
      ask = false;
      break;
  }
  Dmsg1(150, "autoLoadDev returns %d\n", autochanger);

  /* If we autochanged to correct Volume or (we have not just
   * released the Volume AND we can automount) we go ahead
   * and read the label. If there is no tape in the drive,
   * we will fail, recurse and ask the operator the next time. */
  if (!dev->MustUnload() && dev->IsTape() && dev->HasCap(CAP_AUTOMOUNT)) {
    Dmsg0(250, "(1)Ask=0\n");
    ask = false; /* don't ask SYSOP this time */
  }

  // Don't ask if not removable
  if (!dev->IsRemovable()) {
    Dmsg0(250, "(2)Ask=0\n");
    ask = false;
  }
  Dmsg2(250, "Ask=%d autochanger=%d\n", ask, autochanger);

  if (ask) {
    unlock_mutex(mount_mutex);
    dcr->setVolCatInfo(false); /* out of date when Vols unlocked */
    if (!dcr->DirAskSysopToMountVolume(ST_APPENDREADY)) {
      Dmsg0(150, "Error return ask_sysop ...\n");
      goto no_lock_bail_out;
    }
    lock_mutex(mount_mutex);
  }

  if (jcr->IsJobCanceled()) { goto bail_out; }

  Dmsg3(150, "want vol=%s devvol=%s dev=%s\n", VolumeName,
        dev->VolHdr.VolumeName, dev->print_name());

  if (dev->poll && dev->HasCap(CAP_CLOSEONPOLL)) {
    dev->close(dcr);
    FreeVolume(dev);
  }

  // Ensure the device is open
  if (dev->HasCap(CAP_STREAM)) {
    mode = DeviceMode::OPEN_WRITE_ONLY;
  } else {
    mode = DeviceMode::OPEN_READ_WRITE;
  }

  // Try autolabel if enabled
  if (!dev->open(dcr, mode)) {
    TryAutolabel(false); /* try to create a new volume label */
  }

  while (!dev->open(dcr, mode)) {
    Dmsg1(150, "OpenDevice failed: ERR=%s\n", dev->bstrerror());
    if (dev->IsRemovable()) {
      Dmsg0(150, "call ScanForVolume\n");
      if (dev->ScanForVolume(dcr) && dev->open(dcr, mode)) {
        break; /* got a valid volume */
      }
    }
    if (TryAutolabel(false) == try_read_vol) {
      break; /* created a new volume label */
    }
    Jmsg3(jcr, M_WARNING, 0,
          T_("Open device %s Volume \"%s\" failed: ERR=%s\n"),
          dev->print_name(), dcr->VolumeName, dev->bstrerror());
    Dmsg0(50, "SetUnload\n");
    dev->SetUnload(); /* force ask sysop */
    ask = true;
    Dmsg0(150, "goto mount_next_vol\n");
    goto mount_next_vol;
  }

  // Now check the volume label to make sure we have the right tape mounted
read_volume:
  switch (CheckVolumeLabel(ask, autochanger)) {
    case check_next_vol:
      Dmsg0(50, "SetUnload\n");
      dev->SetUnload(); /* want a different Volume */
      Dmsg0(150, "goto mount_next_vol\n");
      goto mount_next_vol;
    case check_read_vol:
      goto read_volume;
    case check_error:
      goto bail_out;
    case check_ok:
      break;
  }
  // Check that volcatinfo is good
  if (!dev->haveVolCatInfo()) {
    Dmsg0(210, "Do not have volcatinfo\n");
    if (!find_a_volume()) { goto mount_next_vol; }

    dev->VolCatInfo = VolCatInfo; /* structure assignment */

    // Apply the Volume Blocksizes to device
    dcr->VolMinBlocksize = VolCatInfo.VolMinBlocksize;
    dcr->VolMaxBlocksize = VolCatInfo.VolMaxBlocksize;
    Dmsg3(200,
          "applying vol block sizes to device %s: dcr->VolMinBlocksize set to "
          "%u, dcr->VolMaxBlocksize set to %u\n",
          dev->print_name(), dcr->VolMinBlocksize, dcr->VolMaxBlocksize);

    // Set the block sizes of the dcr in the device.
    dev->SetBlocksizes(dcr);
  }

  /* See if we have a fresh tape or a tape with data.
   *
   * Note, if the LabelType is PRE_LABEL, it was labeled
   *  but never written. If so, rewrite the label but set as
   *  VOL_LABEL.  We rewind and return the label (reconstructed)
   *  in the block so that in the case of a new tape, data can
   *  be appended just after the block label.  If we are writing
   *  a second volume, the calling routine will write the label
   *  before writing the overflow block.
   *
   *  If the tape is marked as Recycle, we rewrite the label. */
  recycle = bstrcmp(dev->VolCatInfo.VolCatStatus, "Recycle");
  if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
    if (!dcr->RewriteVolumeLabel(recycle)) {
      MarkVolumeInError();
      goto mount_next_vol;
    }
  } else {
    /* OK, at this point, we have a valid Bareos label, but
     * we need to position to the end of the volume, since we are
     * just now putting it into append mode. */
    Dmsg1(
        100,
        "Device previously written, moving to end of data. Expect %lld bytes\n",
        dev->VolCatInfo.VolCatBytes);
    Jmsg(jcr, M_INFO, 0, T_("Moving to end of data on volume \"%s\"\n"),
         VolumeName);

    if (!dev->eod(dcr)) {
      Dmsg2(050, "Unable to position to end of data on device %s: ERR=%s\n",
            dev->print_name(), dev->bstrerror());
      Jmsg(jcr, M_ERROR, 0,
           T_("Unable to position to end of data on device %s: ERR=%s\n"),
           dev->print_name(), dev->bstrerror());
      MarkVolumeInError();
      goto mount_next_vol;
    }
    if (!is_eod_valid()) {
      Dmsg0(100, "goto mount_next_vol\n");
      goto mount_next_vol;
    }

    dev->VolCatInfo.VolCatMounts++; /* Update mounts */
    Dmsg1(150, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
    if (!dcr->DirUpdateVolumeInfo(is_labeloperation::False)) { goto bail_out; }

    /* Return an empty block */
    EmptyBlock(block); /* we used it for reading so set for write */
  }
  dev->SetAppend();
  Dmsg1(150, "set APPEND, normal return from MountNextWriteVolume. dev=%s\n",
        dev->print_name());

  unlock_mutex(mount_mutex);
  return true;

bail_out:
  unlock_mutex(mount_mutex);

no_lock_bail_out:
  return false;
}

/**
 * This routine is meant to be called once the first pass
 * to ensure that we have a candidate volume to mount.
 * Otherwise, we ask the sysop to created one.
 *
 * Note, mount_mutex is already locked on entry and thus
 * must remain locked on exit from this function.
 */
bool DeviceControlRecord::find_a_volume()
{
  DeviceControlRecord* dcr = this;

  if (!IsSuitableVolumeMounted()) {
    bool have_vol = false;

    // Do we have a candidate volume?
    if (dev->vol) {
      bstrncpy(VolumeName, dev->vol->vol_name, sizeof(VolumeName));
      have_vol = dcr->DirGetVolumeInfo(GET_VOL_INFO_FOR_WRITE);
    }

    /* Get Director's idea of what tape we should have mounted, in
     * dcr->VolCatInfo */
    if (!have_vol) {
      Dmsg0(200, "Before DirFindNextAppendableVolume.\n");
      while (!dcr->DirFindNextAppendableVolume()) {
        Dmsg0(200, "not dir_find_next\n");
        if (jcr->IsJobCanceled()) { return false; }
        unlock_mutex(mount_mutex);
        if (!dcr->DirAskSysopToCreateAppendableVolume()) {
          lock_mutex(mount_mutex);
          return false;
        }
        lock_mutex(mount_mutex);
        if (jcr->IsJobCanceled()) { return false; }
        Dmsg0(150, "Again dir_find_next_append...\n");
      }
    }
  }

  if (dcr->haveVolCatInfo()) { return true; }

  return dcr->DirGetVolumeInfo(GET_VOL_INFO_FOR_WRITE);
}

int DeviceControlRecord::CheckVolumeLabel(bool& ask, bool& autochanger)
{
  DeviceControlRecord* dcr = this;
  int vol_label_status;

  /* If we are writing to a stream device, ASSUME the volume label
   *  is correct. */
  if (dev->HasCap(CAP_STREAM)) {
    vol_label_status = VOL_OK;
    CreateVolumeLabel(dev, VolumeName, "Default");
    dev->VolHdr.LabelType = PRE_LABEL;
  } else {
    vol_label_status = ReadDevVolumeLabel(dcr);
  }
  if (jcr->IsJobCanceled()) { goto check_bail_out; }

  Dmsg2(150, "Want dirVol=%s dirStat=%s\n", VolumeName,
        VolCatInfo.VolCatStatus);

  /* At this point, dev->VolCatInfo has what is in the drive, if anything,
   *          and   dcr->VolCatInfo has what the Director wants. */
  switch (vol_label_status) {
    case VOL_OK:
      Dmsg1(150, "Vol OK name=%s\n", dev->VolHdr.VolumeName);
      dev->VolCatInfo = VolCatInfo; /* structure assignment */
      break;                        /* got a Volume */
    case VOL_NAME_ERROR: {
      VolumeCatalogInfo dcrVolCatInfo, devVolCatInfo;
      char saveVolumeName[MAX_NAME_LENGTH];

      Dmsg2(150, "Vol NAME Error Have=%s, want=%s\n", dev->VolHdr.VolumeName,
            VolumeName);
      if (dev->IsVolumeToUnload()) {
        ask = true;
        goto check_next_volume;
      }

      /* If not removable, Volume is broken */
      if (!dev->IsRemovable()) {
        Jmsg(jcr, M_WARNING, 0, T_("Volume \"%s\" not on device %s.\n"),
             VolumeName, dev->print_name());
        MarkVolumeInError();
        goto check_next_volume;
      }

      /* OK, we got a different volume mounted. First save the
       *  requested Volume info (dcr) structure, then query if
       *  this volume is really OK. If not, put back the desired
       *  volume name, mark it not in changer and continue. */
      dcrVolCatInfo = VolCatInfo;      /* structure assignment */
      devVolCatInfo = dev->VolCatInfo; /* structure assignment */
      /* Check if this is a valid Volume in the pool */
      bstrncpy(saveVolumeName, VolumeName, sizeof(saveVolumeName));
      bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
      if (!dcr->DirGetVolumeInfo(GET_VOL_INFO_FOR_WRITE)) {
        PoolMem vol_info_msg;
        PmStrcpy(vol_info_msg, jcr->dir_bsock->msg); /* save error message */
        /* Restore desired volume name, note device info out of sync */
        /* This gets the info regardless of the Pool */
        bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
        if (autochanger && !dcr->DirGetVolumeInfo(GET_VOL_INFO_FOR_READ)) {
          /* If we get here, we know we cannot write on the Volume,
           *  and we know that we cannot read it either, so it
           *  is not in the autochanger. */
          mark_volume_not_inchanger();
        }
        dev->VolCatInfo = devVolCatInfo; /* structure assignment */
        dev->SetUnload();                /* unload this volume */
        Jmsg(jcr, M_WARNING, 0,
             T_("Director wanted Volume \"%s\".\n"
                "    Current Volume \"%s\" not acceptable because:\n"
                "    %s"),
             dcrVolCatInfo.VolCatName, dev->VolHdr.VolumeName,
             vol_info_msg.c_str());
        ask = true;
        /* Restore saved DeviceControlRecord before continuing */
        bstrncpy(VolumeName, saveVolumeName, sizeof(VolumeName));
        VolCatInfo = dcrVolCatInfo; /* structure assignment */
        goto check_next_volume;
      }
      /* This was not the volume we expected, but it is OK with
       * the Director, so use it. */
      Dmsg1(150, "Got new Volume name=%s\n", VolumeName);
      dev->VolCatInfo = VolCatInfo; /* structure assignment */
      Dmsg1(100, "Call reserve_volume=%s\n", dev->VolHdr.VolumeName);
      if (reserve_volume(dcr, dev->VolHdr.VolumeName) == NULL) {
        Jmsg2(jcr, M_WARNING, 0, T_("Could not reserve volume %s on %s\n"),
              dev->VolHdr.VolumeName, dev->print_name());
        ask = true;
        dev->setVolCatInfo(false);
        setVolCatInfo(false);
        goto check_next_volume;
      }
      break; /* got a Volume */
    }
    // At this point, we assume we have a blank tape mounted.
    case VOL_IO_ERROR:
      /* Fall through wanted */
    case VOL_NO_LABEL:
      switch (TryAutolabel(true)) {
        case try_next_vol:
          goto check_next_volume;
          [[fallthrough]];
        case try_read_vol:
          goto check_read_volume;
          [[fallthrough]];
        case try_error:
          goto check_bail_out;
          [[fallthrough]];
        case try_default:
          break;
      }
      [[fallthrough]];
    case VOL_NO_MEDIA:
    default:
      Dmsg0(200, "VOL_NO_MEDIA or default.\n");
      /* Send error message */
      if (!dev->poll) {
        Jmsg(jcr, M_WARNING, 0, "Could not check volume label: ERR=%s\n",
             jcr->errmsg);
      } else {
        Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
      }
      ask = true;
      /* Needed, so the medium can be changed */
      if (dev->RequiresMount()) {
        dev->close(dcr);
        FreeVolume(dev);
      }
      goto check_next_volume;
  }
  return check_ok;

check_next_volume:
  dev->setVolCatInfo(false);
  setVolCatInfo(false);
  return check_next_vol;

check_bail_out:
  return check_error;

check_read_volume:
  return check_read_vol;
}

bool DeviceControlRecord::IsSuitableVolumeMounted()
{
  /* Volume mounted? */
  if (dev->VolHdr.VolumeName[0] == 0 || dev->swap_dev || dev->MustUnload()) {
    return false; /* no */
  }
  bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
  return DirGetVolumeInfo(GET_VOL_INFO_FOR_WRITE);
}

bool DeviceControlRecord::DoUnload()
{
  DeviceControlRecord* dcr = this;

  if (GeneratePluginEvent(jcr, bSdEventVolumeUnload, dcr) != bRC_OK) {
    return false;
  }

  if (dev->MustUnload()) {
    Dmsg1(100, "MustUnload release %s\n", dev->print_name());
    ReleaseVolume();
  }
  return true;
}

bool DeviceControlRecord::DoLoad(bool IsWriting)
{
  DeviceControlRecord* dcr = this;
  bool retval = false;

  if (dev->must_load()) {
    Dmsg1(100, "Must load %s\n", dev->print_name());
    if (AutoloadDevice(dcr, IsWriting, NULL) > 0) {
      dev->clear_load();
      retval = true;
    }
  } else {
    retval = true;
  }

  if (GeneratePluginEvent(jcr, bSdEventVolumeLoad, dcr) != bRC_OK) {
    retval = false;
  }

  return retval;
}

void DeviceControlRecord::DoSwapping(bool)
{
  DeviceControlRecord* dcr = this;

  /* See if we are asked to swap the Volume from another device
   *  if so, unload the other device here, and attach the
   *  volume to our drive. */
  if (dev->swap_dev) {
    if (dev->swap_dev->MustUnload()) {
      if (dev->vol) { dev->swap_dev->SetSlotNumber(dev->vol->GetSlot()); }
      Dmsg2(100, "Swap unloading slot=%d %s\n", dev->swap_dev->GetSlot(),
            dev->swap_dev->print_name());
      UnloadDev(dcr, dev->swap_dev);
    }
    if (dev->vol) {
      dev->vol->ClearSwapping();
      Dmsg1(100, "=== set in_use vol=%s\n", dev->vol->vol_name);
      dev->vol->SetInUse();
      dev->VolHdr.VolumeName[0] = 0; /* don't yet have right Volume */
    } else {
      Dmsg1(100, "No vol on dev=%s\n", dev->print_name());
    }
    if (dev->swap_dev->vol) {
      Dmsg2(100, "Vol=%s on dev=%s\n", dev->swap_dev->vol->vol_name,
            dev->swap_dev->print_name());
    }
    Dmsg2(100, "Set swap_dev=NULL for dev=%s swap_dev=%s\n", dev->print_name(),
          dev->swap_dev->print_name());
    dev->swap_dev = NULL;
  } else {
    Dmsg0(100, "No swap_dev set\n");
  }
}

/**
 * Check if the current position on the volume corresponds to what is in the
 * catalog.
 */
bool DeviceControlRecord::is_eod_valid()
{
  switch (dev->GetSeekMode()) {
    case SeekMode::FILE_BLOCK: {
      /* Check if we are positioned on the tape at the same place
       * that the database says we should be. */
      if (dev->VolCatInfo.VolCatFiles == dev->GetFile()) {
        Jmsg(jcr, M_INFO, 0,
             T_("Ready to append to end of Volume \"%s\" at file=%d.\n"),
             VolumeName, dev->GetFile());
      } else if (dev->GetFile() > dev->VolCatInfo.VolCatFiles) {
        Jmsg(jcr, M_WARNING, 0,
             T_("For Volume \"%s\":\n"
                "The number of files mismatch! Volume=%u Catalog=%u\n"
                "Correcting Catalog\n"),
             VolumeName, dev->GetFile(), dev->VolCatInfo.VolCatFiles);
        dev->VolCatInfo.VolCatFiles = dev->GetFile();
        dev->VolCatInfo.VolCatBlocks = dev->GetBlockNum();
        if (!DirUpdateVolumeInfo(is_labeloperation::False)) {
          Jmsg(jcr, M_WARNING, 0, T_("Error updating Catalog\n"));
          MarkVolumeInError();
          return false;
        }
      } else {
        Jmsg(jcr, M_ERROR, 0,
             T_("Bareos cannot write on tape Volume \"%s\" because:\n"
                "The number of files mismatch! Volume=%u Catalog=%u\n"),
             VolumeName, dev->GetFile(), dev->VolCatInfo.VolCatFiles);
        MarkVolumeInError();
        return false;
      }
    } break;
    case SeekMode::BYTES: {
      char ed1[50], ed2[50];

      boffset_t pos;
      pos = dev->d_lseek(this, (boffset_t)0, SEEK_CUR);
      if (dev->VolCatInfo.VolCatBytes == (uint64_t)pos) {
        Jmsg(jcr, M_INFO, 0,
             T_("Ready to append to end of Volume \"%s\""
                " size=%s\n"),
             VolumeName, edit_uint64(dev->VolCatInfo.VolCatBytes, ed1));
      } else if ((uint64_t)pos > dev->VolCatInfo.VolCatBytes) {
        Jmsg(jcr, M_WARNING, 0,
             T_("For Volume \"%s\":\n"
                "The sizes do not match! Volume=%s Catalog=%s\n"
                "Correcting Catalog\n"),
             VolumeName, edit_uint64(pos, ed1),
             edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
        dev->VolCatInfo.VolCatBytes = (uint64_t)pos;
        dev->VolCatInfo.VolCatFiles = (uint32_t)(pos >> 32);
        if (!DirUpdateVolumeInfo(is_labeloperation::False)) {
          Jmsg(jcr, M_WARNING, 0, T_("Error updating Catalog\n"));
          MarkVolumeInError();
          return false;
        }
      } else {
        Mmsg(jcr->errmsg,
             T_("Bareos cannot write on disk Volume \"%s\" because: "
                "The sizes do not match! Volume=%s Catalog=%s\n"),
             VolumeName, edit_uint64(pos, ed1),
             edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
        Jmsg(jcr, M_ERROR, 0, jcr->errmsg);
        Dmsg0(050, jcr->errmsg);
        MarkVolumeInError();
        return false;
      }
    } break;
    case SeekMode::NOSEEK: {
      return true;
    } break;
  }
  return true;
}

/**
 * If permitted, we label the device, make sure we can do
 *   it by checking that the VolCatBytes is zero => not labeled,
 *   once the Volume is labeled we don't want to label another
 *   blank tape with the same name.  For disk, we go ahead and
 *   label it anyway, because the OS insures that there is only
 *   one Volume with that name.
 * As noted above, at this point dcr->VolCatInfo has what
 *   the Director wants and dev->VolCatInfo has info on the
 *   previous tape (or nothing).
 *
 * Return codes are:
 *   try_next_vol        label failed, look for another volume
 *   try_read_vol        labeled volume, now re-read the label
 *   try_error           hard error (catalog update)
 *   try_default         I couldn't do anything
 */
int DeviceControlRecord::TryAutolabel(bool opened)
{
  DeviceControlRecord* dcr = this;

  if (dev->poll && !dev->IsTape()) {
    return try_default; /* if polling, don't try to create new labels */
  }
  /* For a tape require it to be opened and read before labeling */
  if (!opened && dev->IsTape()) { return try_default; }
  if (dev->HasCap(CAP_LABEL)
      && (VolCatInfo.VolCatBytes == 0
          || (!dev->IsTape() && bstrcmp(VolCatInfo.VolCatStatus, "Recycle")))) {
    Dmsg0(150, "Create volume label\n");
    /* Create a new Volume label and write it to the device */
    if (!WriteNewVolumeLabelToDev(dcr, VolumeName, pool_name,
                                  false /* no relabel */)) {
      Dmsg2(150, "write_vol_label failed. vol=%s, pool=%s\n", VolumeName,
            pool_name);
      if (opened) { MarkVolumeInError(); }
      return try_next_vol;
    }
    Dmsg0(150, "dir_update_vol_info. Set Append\n");
    /* Copy Director's info into the device info */
    if (!dcr->DirUpdateVolumeInfo(
            is_labeloperation::True)) { /* indicate tape labeled */
      return try_error;
    }
    Jmsg(dcr->jcr, M_INFO, 0, T_("Labeled new Volume \"%s\" on device %s.\n"),
         VolumeName, dev->print_name());
    return try_read_vol; /* read label we just wrote */
  }
  if (!dev->HasCap(CAP_LABEL) && VolCatInfo.VolCatBytes == 0) {
    Jmsg(jcr, M_WARNING, 0,
         T_("Device %s not configured to autolabel Volumes.\n"),
         dev->print_name());
  }
  /* If not removable, Volume is broken */
  if (!dev->IsRemovable()) {
    Jmsg(jcr, M_WARNING, 0, T_("Volume \"%s\" not on device %s.\n"), VolumeName,
         dev->print_name());
    MarkVolumeInError();
    return try_next_vol;
  }
  return try_default;
}

// Mark volume in error in catalog
void DeviceControlRecord::MarkVolumeInError()
{
  DeviceControlRecord* dcr = this;

  Jmsg(jcr, M_INFO, 0, T_("Marking Volume \"%s\" in Error in Catalog.\n"),
       VolumeName);
  dev->VolCatInfo = VolCatInfo; /* structure assignment */
  bstrncpy(dev->VolCatInfo.VolCatStatus, "Error",
           sizeof(dev->VolCatInfo.VolCatStatus));
  Dmsg0(150, "dir_update_vol_info. Set Error.\n");
  dcr->DirUpdateVolumeInfo(is_labeloperation::False);
  VolumeUnused(dcr);
  Dmsg0(50, "SetUnload\n");
  dev->SetUnload(); /* must get a new volume */
}

/**
 * The Volume is not in the correct slot, so mark this
 * Volume as not being in the Changer.
 */
void DeviceControlRecord::mark_volume_not_inchanger()
{
  DeviceControlRecord* dcr = this;

  Jmsg(jcr, M_ERROR, 0,
       T_("Autochanger Volume \"%s\" not found in slot %d.\n"
          "    Setting InChanger to zero in catalog.\n"),
       getVolCatName(), VolCatInfo.Slot);
  dev->VolCatInfo = VolCatInfo; /* structure assignment */
  VolCatInfo.InChanger = false;
  dev->VolCatInfo.InChanger = false;
  Dmsg0(400, "update vol info in mount\n");
  dcr->DirUpdateVolumeInfo(is_labeloperation::True); /* set new status */
}

/**
 * Either because we are going to hang a new volume, or because
 * of explicit user request, we release the current volume.
 */
void DeviceControlRecord::ReleaseVolume()
{
  DeviceControlRecord* dcr = this;

  UnloadAutochanger(dcr, -1);

  GeneratePluginEvent(jcr, bSdEventVolumeUnload, dcr);

  if (WroteVol) {
    Jmsg0(jcr, M_ERROR, 0, T_("Hey!!!!! WroteVol non-zero !!!!!\n"));
    Pmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
  }
  // First erase all memory of the current volume
  FreeVolume(dev);
  dev->block_num = dev->file = 0;
  dev->EndBlock = dev->EndFile = 0;
  VolumeCatalogInfo empty_VolumeCatalogInfo;
  dev->VolCatInfo = empty_VolumeCatalogInfo;
  dev->ClearVolhdr();

  // Force re-read of label
  dev->ClearLabeled();
  dev->ClearRead();
  dev->ClearAppend();
  dev->label_type = B_BAREOS_LABEL;
  VolumeName[0] = 0;

  if (dev->IsOpen() && (!dev->IsTape() || !dev->HasCap(CAP_ALWAYSOPEN))) {
    dev->close(dcr);
  }

  // If we have not closed the device, then at least rewind the tape
  if (dev->IsOpen()) { dev->OfflineOrRewind(); }
  Dmsg0(190, "ReleaseVolume\n");
}

/**
 *      Insanity check
 *
 * Check to see if the tape position as defined by the OS is
 *  the same as our concept.  If it is not,
 *  it means the user has probably manually rewound the tape.
 * Note, we check only if num_writers == 0, but this code will
 *  also work fine for any number of writers. If num_writers > 0,
 *  we probably should cancel all jobs using this device, or
 *  perhaps even abort the SD, or at a minimum, mark the tape
 *  in error.  Another strategy with num_writers == 0, would be
 *  to rewind the tape and do a new eod() request.
 */
bool DeviceControlRecord::IsTapePositionOk()
{
  if (dev->IsTape() && dev->num_writers == 0) {
    int32_t file = dev->GetOsTapeFile();
    if (file >= 0 && file != (int32_t)dev->GetFile()) {
      Jmsg(jcr, M_ERROR, 0,
           T_("Invalid tape position on volume \"%s\""
              " on device %s. Expected %d, got %d\n"),
           dev->VolHdr.VolumeName, dev->print_name(), dev->GetFile(), file);
      /* If the current file is greater than zero, it means we probably
       *  have some bad count of EOF marks, so mark tape in error.  Otherwise
       *  the operator might have moved the tape, so we just release it
       *  and try again. */
      if (file > 0) { MarkVolumeInError(); }
      ReleaseVolume();
      return false;
    }
  }
  return true;
}

/**
 * If we are reading, we come here at the end of the tape
 *  and see if there are more volumes to be mounted.
 */
bool MountNextReadVolume(DeviceControlRecord* dcr)
{
  Device* dev = dcr->dev;
  JobControlRecord* jcr = dcr->jcr;
  Dmsg2(90, "NumReadVolumes=%d CurReadVolume=%d\n",
        jcr->sd_impl->NumReadVolumes, jcr->sd_impl->CurReadVolume);

  VolumeUnused(dcr); /* release current volume */
  // End Of Tape -- mount next Volume (if another specified)
  if (jcr->sd_impl->NumReadVolumes > 1
      && jcr->sd_impl->CurReadVolume < jcr->sd_impl->NumReadVolumes) {
    dev->Lock();
    dev->close(dcr);
    dev->SetRead();
    dcr->SetReserved();
    dev->Unlock();
    if (!AcquireDeviceForRead(dcr)) {
      Jmsg2(jcr, M_FATAL, 0, T_("Cannot open Dev=%s, Vol=%s\n"),
            dev->print_name(), dcr->VolumeName);
      return false;
    }
    return true; /* next volume mounted */
  }
  Dmsg0(90, "End of Device reached.\n");
  return false;
}

} /* namespace storagedaemon */
