FreeDOS/kernel/blockio.c

/****************************************************************/
/*                                                              */
/*                          blockio.c                           */
/*                            DOS-C                             */
/*                                                              */
/*      Block cache functions and device driver interface       */
/*                                                              */
/*                      Copyright (c) 1995                      */
/*                      Pasquale J. Villani                     */
/*                      All Rights Reserved                     */
/*                                                              */
/* This file is part of DOS-C.                                  */
/*                                                              */
/* DOS-C is free software; you can redistribute it and/or       */
/* modify it under the terms of the GNU General Public License  */
/* as published by the Free Software Foundation; either version */
/* 2, or (at your option) any later version.                    */
/*                                                              */
/* DOS-C 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 General Public License for more details.             */
/*                                                              */
/* You should have received a copy of the GNU General Public    */
/* License along with DOS-C; see the file COPYING.  If not,     */
/* write to the Free Software Foundation, 675 Mass Ave,         */
/* Cambridge, MA 02139, USA.                                    */
/*                                                              */
/****************************************************************/

#include "portab.h"
#include "globals.h"

#ifdef VERSION_STRINGS
static BYTE *blockioRcsId = "$Id$";
#endif

/*
 * $Log$
 * Revision 1.4  2000/05/25 20:56:21  jimtabor
 * Fixed project history
 *
 * Revision 1.3  2000/05/11 04:26:26  jimtabor
 * Added code for DOS FN 69 & 6C
 *
 * Revision 1.2  2000/05/08 04:29:59  jimtabor
 * Update CVS to 2020
 *
 * Revision 1.1.1.1  2000/05/06 19:34:53  jhall1
 * The FreeDOS Kernel.  A DOS kernel that aims to be 100% compatible with
 * MS-DOS.  Distributed under the GNU GPL.
 *
 * Revision 1.15  2000/04/29 05:13:16  jtabor
 *  Added new functions and clean up code
 *
 * Revision 1.14  2000/03/09 06:07:10  kernel
 * 2017f updates by James Tabor
 *
 * Revision 1.13  1999/08/25 03:18:07  jprice
 * ror4 patches to allow TC 2.01 compile.
 *
 * Revision 1.12  1999/08/10 18:03:39  jprice
 * ror4 2011-03 patch
 *
 * Revision 1.11  1999/05/03 06:25:45  jprice
 * Patches from ror4 and many changed of signed to unsigned variables.
 *
 * Revision 1.10  1999/05/03 04:55:35  jprice
 * Changed getblock & getbuf so that they leave at least 3 buffer for FAT data.
 *
 * Revision 1.9  1999/04/21 01:44:40  jprice
 * no message
 *
 * Revision 1.8  1999/04/18 05:28:39  jprice
 * no message
 *
 * Revision 1.7  1999/04/16 21:43:40  jprice
 * ror4 multi-sector IO
 *
 * Revision 1.6  1999/04/16 00:53:32  jprice
 * Optimized FAT handling
 *
 * Revision 1.5  1999/04/12 23:41:53  jprice
 * Using getbuf to write data instead of getblock
 * using getblock made it read the block before it wrote it
 *
 * Revision 1.4  1999/04/11 05:28:10  jprice
 * Working on multi-block IO
 *
 * Revision 1.3  1999/04/11 04:33:38  jprice
 * ror4 patches
 *
 * Revision 1.1.1.1  1999/03/29 15:41:43  jprice
 * New version without IPL.SYS
 *
 * Revision 1.5  1999/02/09 02:54:23  jprice
 * Added Pat's 1937 kernel patches
 *
 * Revision 1.4  1999/02/01 01:43:27  jprice
 * Fixed findfirst function to find volume label with Windows long filenames
 *
 * Revision 1.3  1999/01/30 08:25:34  jprice
 * Clean up; Fixed bug with set attribute function.  If you tried to
 * change the attributes of a directory, it would erase it.
 *
 * Revision 1.2  1999/01/22 04:15:28  jprice
 * Formating
 *
 * Revision 1.1.1.1  1999/01/20 05:51:00  jprice
 * Imported sources
 *
 *
 *    Rev 1.8   06 Dec 1998  8:43:16   patv
 * Changes in block I/O because of new I/O subsystem.
 *
 *    Rev 1.7   22 Jan 1998  4:09:00   patv
 * Fixed pointer problems affecting SDA
 *
 *    Rev 1.6   04 Jan 1998 23:14:36   patv
 * Changed Log for strip utility
 *
 *    Rev 1.5   03 Jan 1998  8:36:02   patv
 * Converted data area to SDA format
 *
 *    Rev 1.4   16 Jan 1997 12:46:34   patv
 * pre-Release 0.92 feature additions
 *
 *    Rev 1.3   29 May 1996 21:15:10   patv
 * bug fixes for v0.91a
 *
 *    Rev 1.2   01 Sep 1995 17:48:46   patv
 * First GPL release.
 *
 *    Rev 1.1   30 Jul 1995 20:50:28   patv
 * Eliminated version strings in ipl
 *
 *    Rev 1.0   02 Jul 1995  8:04:06   patv
 * Initial revision.
 */

/************************************************************************/
/*                                                                      */
/*                      block cache routines                            */
/*                                                                      */
/************************************************************************/

/*                                                                      */
/* Initialize the buffer structure                                      */
/*                                                                      */
/* XXX: This should go into `INIT_TEXT'. -- ror4 */
VOID FAR init_buffers(void)
{
  REG WORD i;
  REG WORD count;

  for (i = 0; i < Config.cfgBuffers; ++i)
  {
    buffers[i].b_unit = 0;
    buffers[i].b_flag = 0;
    buffers[i].b_blkno = 0;
    buffers[i].b_copies = 0;
    buffers[i].b_offset_lo = 0;
    buffers[i].b_offset_hi = 0;
    if (i < (Config.cfgBuffers - 1))
      buffers[i].b_next = &buffers[i + 1];
    else
      buffers[i].b_next = NULL;
  }
  firstbuf = &buffers[0];
  lastbuf = &buffers[Config.cfgBuffers - 1];
}

/* Extract the block number from a buffer structure. */
ULONG getblkno(struct buffer FAR * bp)
{
  if (bp->b_blkno == 0xffffu)
    return bp->b_huge_blkno;
  else
    return bp->b_blkno;
}

/*  Set the block number of a buffer structure. (The caller should  */
/*  set the unit number before calling this function.)     */
VOID setblkno(struct buffer FAR * bp, ULONG blkno)
{
  if (blkno >= 0xffffu)
  {
    bp->b_blkno = 0xffffu;
    bp->b_huge_blkno = blkno;
  }
  else
  {
    bp->b_blkno = blkno;
/*    bp->b_dpbp = &blk_devices[bp->b_unit]; */

      bp->b_dpbp = CDSp->cds_table[bp->b_unit].cdsDpb;

  }
}

/*                                                                      */
/*      Return the address of a buffer structure containing the         */
/*      requested block.                                                */
/*                                                                      */
/*      returns:                                                        */
/*              requested block with data                               */
/*      failure:                                                        */
/*              returns NULL                                            */
/*                                                                      */
struct buffer FAR *getblock(ULONG blkno, COUNT dsk)
{
  REG struct buffer FAR *bp;
  REG struct buffer FAR *lbp;
  REG struct buffer FAR *mbp;
  REG BYTE fat_count = 0;

  /* Search through buffers to see if the required block  */
  /* is already in a buffer                               */

#ifdef DISPLAY_GETBLOCK
  printf("[getblock %d, blk %ld, buf ", dsk, blkno);
#endif
  bp = firstbuf;
  lbp = NULL;
  mbp = NULL;
  while (bp != NULL)
  {
    if ((bp->b_flag & BFR_VALID) && (bp->b_unit == dsk)
        && (getblkno(bp) == blkno))
    {
      /* found it -- rearrange LRU links      */
      if (lbp != NULL)
      {
        lbp->b_next = bp->b_next;
        bp->b_next = firstbuf;
        firstbuf = bp;
      }
#ifdef DISPLAY_GETBLOCK
      printf("HIT]\n");
#endif
      return (bp);
    }
    else
    {
      if (bp->b_flag & BFR_FAT)
        fat_count++;
      mbp = lbp;                /* move along to next buffer */
      lbp = bp;
      bp = bp->b_next;
    }
  }
  /* The block we need is not in a buffer, we must make a buffer  */
  /* available, and fill it with the desired block                */

  /* detach lru buffer                                            */
#ifdef DISPLAY_GETBLOCK
  printf("MISS]\n");
#endif

  /* make sure we keep at least 3 buffers for the FAT.  If this is not a */
  /* FAT buffer, or there are at least 3 already, then we can use this  */
  /* buffer.  */
  /* otherwise, search again, and find the last non-FAT buffer.   */
  if ((lbp->b_flag & BFR_FAT) && (fat_count < 3))
  {
    bp = firstbuf;
    lbp = NULL;
    mbp = NULL;
    while ((bp != NULL) && (bp->b_flag & BFR_FAT))
    {
      /* if this is a FAT buffer, then move to the next one, else we found */
      /* the one we want.      */
      mbp = lbp;                /* move along to next buffer */
      lbp = bp;
      bp = bp->b_next;
    }
    /* if we get to the end of the list here, then we must only have 3  */
    /* buffers, which is not suppose to happen, but if it does, then we */
    /* end up using the last buffer (even though it is FAT).                                                                                                    */

    if (bp == NULL)
    {
      /* put lbp at the top of the chain. */
      if (mbp != NULL)
        mbp->b_next = NULL;
      lbp->b_next = firstbuf;
      firstbuf = bp = lbp;
    }
    else if (lbp != NULL)
    {
      lbp->b_next = bp->b_next;
      bp->b_next = firstbuf;
      firstbuf = bp;
    }
    lbp = bp;
  }
  else
  {
    /* put lbp at the top of the chain. */
    if (mbp != NULL)
      mbp->b_next = NULL;
    lbp->b_next = firstbuf;
    firstbuf = lbp;
  }

  /* take the buffer than lbp points to and flush it, then read new block. */
  if (flush1(lbp) && fill(lbp, blkno, dsk))	/* success             */
    mbp = lbp;
  else
    mbp = NULL;                 /* failure */
  return (mbp);
}

/*
   Return the address of a buffer structure for the
   requested block.  This is for writing new data to a block, so
   we really don't care what is in the buffer now.

   returns:
   TRUE = buffer available, flushed if necessary
   parameter is filled with pointer to buffer
   FALSE = there was an error flushing the buffer.
   parameter is set to NULL
 */
BOOL getbuf(struct buffer FAR ** pbp, ULONG blkno, COUNT dsk)
{
  REG struct buffer FAR *bp;
  REG struct buffer FAR *lbp;
  REG struct buffer FAR *mbp;
  REG BYTE fat_count = 0;

  /* Search through buffers to see if the required block  */
  /* is already in a buffer                               */

#ifdef DISPLAY_GETBLOCK
  printf("[getbuf %d, blk %ld, buf ", dsk, blkno);
#endif
  bp = firstbuf;
  lbp = NULL;
  mbp = NULL;
  while (bp != NULL)
  {
    if ((bp->b_flag & BFR_VALID) && (bp->b_unit == dsk)
        && (getblkno(bp) == blkno))
    {
      /* found it -- rearrange LRU links      */
      if (lbp != NULL)
      {
        lbp->b_next = bp->b_next;
        bp->b_next = firstbuf;
        firstbuf = bp;
      }
      *pbp = bp;
#ifdef DISPLAY_GETBLOCK
      printf("HIT]\n");
#endif
      return TRUE;
    }
    else
    {
      if (bp->b_flag & BFR_FAT)
        fat_count++;
      mbp = lbp;                /* move along to next buffer */
      lbp = bp;
      bp = bp->b_next;
    }
  }
  /* The block we need is not in a buffer, we must make a buffer  */
  /* available. */

#ifdef DISPLAY_GETBLOCK
  printf("MISS]\n");
#endif

  /* make sure we keep at least 3 buffers for the FAT.  If this is not a */
  /* FAT buffer, or there are at least 3 already, then we can use this   */
  /* buffer.                                                            */
  /* otherwise, search again, and find the last non-FAT buffer.         */
  if ((lbp->b_flag & BFR_FAT) && (fat_count < 3))
  {
    bp = firstbuf;
    lbp = NULL;
    mbp = NULL;
    while ((bp != NULL) && (bp->b_flag & BFR_FAT))
    {
      /* if this is a FAT buffer, then move to the next one, else we found */
      /* the one we want.      */
      mbp = lbp;                /* move along to next buffer */
      lbp = bp;
      bp = bp->b_next;
    }
    /* if we get to the end of the list here, then we must only have 3    */
    /* buffers, which is not suppose to happen, but if it does, then we   */
    /* end up using the last buffer (even though it is FAT).    */

    if (bp == NULL)
    {
      /* put lbp at the top of the chain. */
      if (mbp != NULL)
        mbp->b_next = NULL;
      lbp->b_next = firstbuf;
      firstbuf = bp = lbp;
    }
    else if (lbp != NULL)
    {
      lbp->b_next = bp->b_next;
      bp->b_next = firstbuf;
      firstbuf = bp;
    }
    lbp = bp;
  }
  else
  {
    /* put lbp at the top of the chain. */
    if (mbp != NULL)
      mbp->b_next = NULL;
    lbp->b_next = firstbuf;
    firstbuf = lbp;
  }

  /* take the buffer than lbp points to and flush it, then make it available. */
  if (flush1(lbp))              /* success              */
  {
    lbp->b_flag = 0;
    lbp->b_unit = dsk;
    setblkno(lbp, blkno);
    *pbp = lbp;
    return TRUE;
  }
  else
    /* failure              */
  {
    *pbp = NULL;
    return FALSE;
  }
}

/*                                                                      */
/*      Mark all buffers for a disk as not valid                        */
/*                                                                      */
VOID setinvld(REG COUNT dsk)
{
  REG struct buffer FAR *bp;

  bp = firstbuf;
  while (bp)
  {
    if (bp->b_unit == dsk)
      bp->b_flag = 0;
    bp = bp->b_next;
  }
}

/*                                                                      */
/*                      Flush all buffers for a disk                    */
/*                                                                      */
/*      returns:                                                        */
/*              TRUE on success                                         */
/*                                                                      */
BOOL flush_buffers(REG COUNT dsk)
{
  REG struct buffer FAR *bp;
  REG BOOL ok = TRUE;

  bp = firstbuf;
  while (bp)
  {
    if (bp->b_unit == dsk)
      if (!flush1(bp))
        ok = FALSE;
    bp = bp->b_next;
  }
  return ok;
}

/*                                                                      */
/*      Write one disk buffer                                           */
/*                                                                      */
BOOL flush1(struct buffer FAR * bp)
{
  REG WORD ok;

  if ((bp->b_flag & BFR_VALID) && (bp->b_flag & BFR_DIRTY))
  {
    ok = dskxfer(bp->b_unit, getblkno(bp),
                 (VOID FAR *) bp->b_buffer, 1, DSKWRITE);
    if (bp->b_flag & BFR_FAT)
    {
      int i = bp->b_copies;
      LONG blkno = getblkno(bp);
      UWORD offset = ((UWORD) bp->b_offset_hi << 8) | bp->b_offset_lo;

      while (--i > 0)
      {
        blkno += offset;
        ok &= dskxfer(bp->b_unit, blkno,
                      (VOID FAR *) bp->b_buffer, 1, DSKWRITE);
      }
    }
  }
  else
    ok = TRUE;
  bp->b_flag &= ~BFR_DIRTY;     /* even if error, mark not dirty */
  if (!ok)                      /* otherwise system has trouble  */
    bp->b_flag &= ~BFR_VALID;   /* continuing.           */
  return (ok);
}

/*                                                                      */
/*      Write all disk buffers                                          */
/*                                                                      */
BOOL flush(void)
{
  REG struct buffer FAR *bp;
  REG BOOL ok;

  ok = TRUE;
  bp = firstbuf;
  while (bp)
  {
    if (!flush1(bp))
      ok = FALSE;
    bp->b_flag &= ~BFR_VALID;
    bp = bp->b_next;
  }

  int2f_Remote_call(REM_FLUSHALL, 0, 0, 0, 0, 0, 0);

  return (ok);
}

/*                                                                      */
/*      Fill the indicated disk buffer with the current track and sector */
/*                                                                      */
/* This function assumes that the buffer is ready for use and that the
   sector is not already in the buffer ring  */
BOOL fill(REG struct buffer FAR * bp, ULONG blkno, COUNT dsk)
{
  REG WORD ok;

  ok = dskxfer(dsk, blkno, (VOID FAR *) bp->b_buffer, 1, DSKREAD);
  bp->b_flag = BFR_VALID | BFR_DATA;
  bp->b_unit = dsk;
  setblkno(bp, blkno);
  return (ok);
}

/************************************************************************/
/*                                                                      */
/*              Device Driver Interface Functions                       */
/*                                                                      */
/************************************************************************/
/*                                                                      */
/* Transfer one or more blocks to/from disk                             */
/*                                                                      */
BOOL dskxfer(COUNT dsk, ULONG blkno, VOID FAR * buf, UWORD numblocks, COUNT mode)
{
/*  REG struct dpb *dpbp = &blk_devices[dsk]; */

    REG struct dpb *dpbp = (struct dpb *)CDSp->cds_table[dsk].cdsDpb;

  for (;;)
  {
    IoReqHdr.r_length = sizeof(request);
    IoReqHdr.r_unit = dpbp->dpb_subunit;
    IoReqHdr.r_command =
        mode == DSKWRITE ?
        (verify_ena ? C_OUTVFY : C_OUTPUT)
        : C_INPUT;
    IoReqHdr.r_status = 0;
    IoReqHdr.r_meddesc = dpbp->dpb_mdb;
    IoReqHdr.r_trans = (BYTE FAR *) buf;
    IoReqHdr.r_count = numblocks;
    if (blkno >= MAXSHORT)
    {
      IoReqHdr.r_start = HUGECOUNT;
      IoReqHdr.r_huge = blkno;
    }
    else
      IoReqHdr.r_start = blkno;
    execrh((request FAR *) & IoReqHdr, dpbp->dpb_device);
    if (!(IoReqHdr.r_status & S_ERROR) && (IoReqHdr.r_status & S_DONE))
      break;
    else
    {
    loop:
      switch (block_error(&IoReqHdr, dpbp->dpb_unit, dpbp->dpb_device))
      {
        case ABORT:
        case FAIL:
          return FALSE;

        case RETRY:
          continue;

        case CONTINUE:
          break;

        default:
          goto loop;
      }
    }
  }
  return TRUE;
}