/*

 * Block driver for RAW files (posix)

 *

 * Copyright (c) 2006 Fabrice Bellard

 *

 * Permission is hereby granted, free of charge, to any person obtaining a copy

 * of this software and associated documentation files (the "Software"), to deal

 * in the Software without restriction, including without limitation the rights

 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the Software is

 * furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be included in

 * all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

 * THE SOFTWARE.

 */

#include "qemu-common.h"

#include "qemu-timer.h"

#include "qemu-char.h"

#include "block_int.h"

#include <assert.h>

#ifdef CONFIG_AIO

#include "posix-aio-compat.h"

#endif

#ifdef CONFIG_COCOA

#include <paths.h>

#include <sys/param.h>

#include <IOKit/IOKitLib.h>

#include <IOKit/IOBSD.h>

#include <IOKit/storage/IOMediaBSDClient.h>

#include <IOKit/storage/IOMedia.h>

#include <IOKit/storage/IOCDMedia.h>

//#include <IOKit/storage/IOCDTypes.h>

#include <CoreFoundation/CoreFoundation.h>

#endif

#ifdef __sun__

#define _POSIX_PTHREAD_SEMANTICS 1

#include <signal.h>

#include <sys/dkio.h>

#endif

#ifdef __linux__

#include <sys/ioctl.h>

#include <linux/cdrom.h>

#include <linux/fd.h>

#endif

#ifdef __FreeBSD__

#include <signal.h>

#include <sys/disk.h>

#endif

#ifdef __OpenBSD__

#include <sys/ioctl.h>

#include <sys/disklabel.h>

#include <sys/dkio.h>

#endif

//#define DEBUG_FLOPPY

//#define DEBUG_BLOCK

#if defined(DEBUG_BLOCK)

#define DEBUG_BLOCK_PRINT(formatCstr, args...) do { if (loglevel != 0)	\

    { fprintf(logfile, formatCstr, ##args); fflush(logfile); } } while (0)

#else

#define DEBUG_BLOCK_PRINT(formatCstr, args...)

#endif

/* OS X does not have O_DSYNC */

#ifndef O_DSYNC

#define O_DSYNC O_SYNC

#endif

/* Approximate O_DIRECT with O_DSYNC if O_DIRECT isn't available */

#ifndef O_DIRECT

#define O_DIRECT O_DSYNC

#endif

#define FTYPE_FILE   0

#define FTYPE_CD     1

#define FTYPE_FD     2

#define ALIGNED_BUFFER_SIZE (32 * 512)

/* if the FD is not accessed during that time (in ms), we try to

   reopen it to see if the disk has been changed */

#define FD_OPEN_TIMEOUT 1000

typedef struct BDRVRawState {

    int fd;

    int type;

    unsigned int lseek_err_cnt;

#if defined(__linux__)

    /* linux floppy specific */

    int fd_open_flags;

    int64_t fd_open_time;

    int64_t fd_error_time;

    int fd_got_error;

    int fd_media_changed;

#endif

    uint8_t* aligned_buf;

} BDRVRawState;

static int posix_aio_init(void);

static int fd_open(BlockDriverState *bs);

static int raw_open(BlockDriverState *bs, const char *filename, int flags)

{

    BDRVRawState *s = bs->opaque;

    int fd, open_flags, ret;

    posix_aio_init();

    s->lseek_err_cnt = 0;

    open_flags = O_BINARY;

    if ((flags & BDRV_O_ACCESS) == O_RDWR) {

        open_flags |= O_RDWR;

    } else {

        open_flags |= O_RDONLY;

        bs->read_only = 1;

    }

    if (flags & BDRV_O_CREAT)

        open_flags |= O_CREAT | O_TRUNC;

    /* Use O_DSYNC for write-through caching, no flags for write-back caching,

     * and O_DIRECT for no caching. */

    if ((flags & BDRV_O_NOCACHE))

        open_flags |= O_DIRECT;

    else if (!(flags & BDRV_O_CACHE_WB))

        open_flags |= O_DSYNC;

    s->type = FTYPE_FILE;

    fd = open(filename, open_flags, 0644);

    if (fd < 0) {

        ret = -errno;

        if (ret == -EROFS)

            ret = -EACCES;

        return ret;

    }

    s->fd = fd;

    s->aligned_buf = NULL;

    if ((flags & BDRV_O_NOCACHE)) {

        s->aligned_buf = qemu_memalign(512, ALIGNED_BUFFER_SIZE);

        if (s->aligned_buf == NULL) {

            ret = -errno;

            close(fd);

            return ret;

        }

    }

    return 0;

}

/* XXX: use host sector size if necessary with:

#ifdef DIOCGSECTORSIZE

        {

            unsigned int sectorsize = 512;

            if (!ioctl(fd, DIOCGSECTORSIZE, &sectorsize) &&

                sectorsize > bufsize)

                bufsize = sectorsize;

        }

#endif

#ifdef CONFIG_COCOA

        u_int32_t   blockSize = 512;

        if ( !ioctl( fd, DKIOCGETBLOCKSIZE, &blockSize ) && blockSize > bufsize) {

            bufsize = blockSize;

        }

#endif

*/

/*

 * offset and count are in bytes, but must be multiples of 512 for files

 * opened with O_DIRECT. buf must be aligned to 512 bytes then.

 *

 * This function may be called without alignment if the caller ensures

 * that O_DIRECT is not in effect.

 */

static int raw_pread_aligned(BlockDriverState *bs, int64_t offset,

                     uint8_t *buf, int count)

{

    BDRVRawState *s = bs->opaque;

    int ret;

    ret = fd_open(bs);

    if (ret < 0)

        return ret;

    if (offset >= 0 && lseek(s->fd, offset, SEEK_SET) == (off_t)-1) {

        ++(s->lseek_err_cnt);

        if(s->lseek_err_cnt <= 10) {

            DEBUG_BLOCK_PRINT("raw_pread(%d:%s, %" PRId64 ", %p, %d) [%" PRId64

                              "] lseek failed : %d = %s\n",

                              s->fd, bs->filename, offset, buf, count,

                              bs->total_sectors, errno, strerror(errno));

        }

        return -1;

    }

    s->lseek_err_cnt=0;

    ret = read(s->fd, buf, count);

    if (ret == count)

        goto label__raw_read__success;

    DEBUG_BLOCK_PRINT("raw_pread(%d:%s, %" PRId64 ", %p, %d) [%" PRId64

                      "] read failed %d : %d = %s\n",

                      s->fd, bs->filename, offset, buf, count,

                      bs->total_sectors, ret, errno, strerror(errno));

    /* Try harder for CDrom. */

    if (bs->type == BDRV_TYPE_CDROM) {

        lseek(s->fd, offset, SEEK_SET);

        ret = read(s->fd, buf, count);

        if (ret == count)

            goto label__raw_read__success;

        lseek(s->fd, offset, SEEK_SET);

        ret = read(s->fd, buf, count);

        if (ret == count)

            goto label__raw_read__success;

        DEBUG_BLOCK_PRINT("raw_pread(%d:%s, %" PRId64 ", %p, %d) [%" PRId64

                          "] retry read failed %d : %d = %s\n",

                          s->fd, bs->filename, offset, buf, count,

                          bs->total_sectors, ret, errno, strerror(errno));

    }

label__raw_read__success:

    return ret;

}

/*

 * offset and count are in bytes, but must be multiples of 512 for files

 * opened with O_DIRECT. buf must be aligned to 512 bytes then.

 *

 * This function may be called without alignment if the caller ensures

 * that O_DIRECT is not in effect.

 */

static int raw_pwrite_aligned(BlockDriverState *bs, int64_t offset,

                      const uint8_t *buf, int count)

{

    BDRVRawState *s = bs->opaque;

    int ret;

    ret = fd_open(bs);

    if (ret < 0)

        return ret;

    if (offset >= 0 && lseek(s->fd, offset, SEEK_SET) == (off_t)-1) {

        ++(s->lseek_err_cnt);

        if(s->lseek_err_cnt) {

            DEBUG_BLOCK_PRINT("raw_pwrite(%d:%s, %" PRId64 ", %p, %d) [%"

                              PRId64 "] lseek failed : %d = %s\n",

                              s->fd, bs->filename, offset, buf, count,

                              bs->total_sectors, errno, strerror(errno));

        }

        return -1;

    }

    s->lseek_err_cnt = 0;

    ret = write(s->fd, buf, count);

    if (ret == count)

        goto label__raw_write__success;

    DEBUG_BLOCK_PRINT("raw_pwrite(%d:%s, %" PRId64 ", %p, %d) [%" PRId64

                      "] write failed %d : %d = %s\n",

                      s->fd, bs->filename, offset, buf, count,

                      bs->total_sectors, ret, errno, strerror(errno));

label__raw_write__success:

    return ret;

}

/*

 * offset and count are in bytes and possibly not aligned. For files opened

 * with O_DIRECT, necessary alignments are ensured before calling

 * raw_pread_aligned to do the actual read.

 */

static int raw_pread(BlockDriverState *bs, int64_t offset,

                     uint8_t *buf, int count)

{

    BDRVRawState *s = bs->opaque;

    int size, ret, shift, sum;

    sum = 0;

    if (s->aligned_buf != NULL)  {

        if (offset & 0x1ff) {

            /* align offset on a 512 bytes boundary */

            shift = offset & 0x1ff;

            size = (shift + count + 0x1ff) & ~0x1ff;

            if (size > ALIGNED_BUFFER_SIZE)

                size = ALIGNED_BUFFER_SIZE;

            ret = raw_pread_aligned(bs, offset - shift, s->aligned_buf, size);

            if (ret < 0)

                return ret;

            size = 512 - shift;

            if (size > count)

                size = count;

            memcpy(buf, s->aligned_buf + shift, size);

            buf += size;

            offset += size;

            count -= size;

            sum += size;

            if (count == 0)

                return sum;

        }

        if (count & 0x1ff || (uintptr_t) buf & 0x1ff) {

            /* read on aligned buffer */

            while (count) {

                size = (count + 0x1ff) & ~0x1ff;

                if (size > ALIGNED_BUFFER_SIZE)

                    size = ALIGNED_BUFFER_SIZE;

                ret = raw_pread_aligned(bs, offset, s->aligned_buf, size);

                if (ret < 0)

                    return ret;

                size = ret;

                if (size > count)

                    size = count;

                memcpy(buf, s->aligned_buf, size);

                buf += size;

                offset += size;

                count -= size;

                sum += size;

            }

            return sum;

        }

    }

    return raw_pread_aligned(bs, offset, buf, count) + sum;

}

/*

 * offset and count are in bytes and possibly not aligned. For files opened

 * with O_DIRECT, necessary alignments are ensured before calling

 * raw_pwrite_aligned to do the actual write.

 */

static int raw_pwrite(BlockDriverState *bs, int64_t offset,

                      const uint8_t *buf, int count)

{

    BDRVRawState *s = bs->opaque;

    int size, ret, shift, sum;

    sum = 0;

    if (s->aligned_buf != NULL) {

        if (offset & 0x1ff) {

            /* align offset on a 512 bytes boundary */

            shift = offset & 0x1ff;

            ret = raw_pread_aligned(bs, offset - shift, s->aligned_buf, 512);

            if (ret < 0)

                return ret;

            size = 512 - shift;

            if (size > count)

                size = count;

            memcpy(s->aligned_buf + shift, buf, size);

            ret = raw_pwrite_aligned(bs, offset - shift, s->aligned_buf, 512);

            if (ret < 0)

                return ret;

            buf += size;

            offset += size;

            count -= size;

            sum += size;

            if (count == 0)

                return sum;

        }

        if (count & 0x1ff || (uintptr_t) buf & 0x1ff) {

            while ((size = (count & ~0x1ff)) != 0) {

                if (size > ALIGNED_BUFFER_SIZE)

                    size = ALIGNED_BUFFER_SIZE;

                memcpy(s->aligned_buf, buf, size);

                ret = raw_pwrite_aligned(bs, offset, s->aligned_buf, size);

                if (ret < 0)

                    return ret;

                buf += ret;

                offset += ret;

                count -= ret;

                sum += ret;

            }

            /* here, count < 512 because (count & ~0x1ff) == 0 */

            if (count) {

                ret = raw_pread_aligned(bs, offset, s->aligned_buf, 512);

                if (ret < 0)

                    return ret;

                 memcpy(s->aligned_buf, buf, count);

                 ret = raw_pwrite_aligned(bs, offset, s->aligned_buf, 512);

                 if (ret < 0)

                     return ret;

                 if (count < ret)

                     ret = count;

                 sum += ret;

            }

            return sum;

        }

    }

    return raw_pwrite_aligned(bs, offset, buf, count) + sum;

}

#ifdef CONFIG_AIO

/***********************************************************/

/* Unix AIO using POSIX AIO */

typedef struct RawAIOCB {

    BlockDriverAIOCB common;

    struct qemu_paiocb aiocb;

    struct RawAIOCB *next;

    int ret;

} RawAIOCB;

typedef struct PosixAioState

{

    int rfd, wfd;

    RawAIOCB *first_aio;

} PosixAioState;

static void posix_aio_read(void *opaque)

{

    PosixAioState *s = opaque;

    RawAIOCB *acb, **pacb;

    int ret;

    ssize_t len;

    /* read all bytes from signal pipe */

    for (;;) {

        char bytes[16];

        len = read(s->rfd, bytes, sizeof(bytes));

        if (len == -1 && errno == EINTR)

            continue; /* try again */

        if (len == sizeof(bytes))

            continue; /* more to read */

        break;

    }

    for(;;) {

        pacb = &s->first_aio;

        for(;;) {

            acb = *pacb;

            if (!acb)

                goto the_end;

            ret = qemu_paio_error(&acb->aiocb);

            if (ret == ECANCELED) {

                /* remove the request */

                *pacb = acb->next;

                qemu_aio_release(acb);

            } else if (ret != EINPROGRESS) {

                /* end of aio */

                if (ret == 0) {

                    ret = qemu_paio_return(&acb->aiocb);

                    if (ret == acb->aiocb.aio_nbytes)

                        ret = 0;

                    else

                        ret = -EINVAL;

                } else {

                    ret = -ret;

                }

                /* remove the request */

                *pacb = acb->next;

                /* call the callback */

                acb->common.cb(acb->common.opaque, ret);

                qemu_aio_release(acb);

                break;

            } else {

                pacb = &acb->next;

            }

        }

    }

 the_end: ;

}

static int posix_aio_flush(void *opaque)

{

    PosixAioState *s = opaque;

    return !!s->first_aio;

}

static PosixAioState *posix_aio_state;

static void aio_signal_handler(int signum)

{

    if (posix_aio_state) {

        char byte = 0;

        write(posix_aio_state->wfd, &byte, sizeof(byte));

    }

    qemu_service_io();

}

static int posix_aio_init(void)

{

    struct sigaction act;

    PosixAioState *s;