lamzfs 0.1.0

// SPDX-License-Identifier: MIT
// Adapted from rzfs @ea41cf0b5b29 (dual GPL-2.0 OR MIT; MIT elected); see NOTICE.

use core::fmt;

#[cfg(feature = "std")]
use std::error;

use crate::phys::{
    BinaryDecodeError, BinaryDecoder, BinaryEncodeError, BinaryEncoder, BlockPointer,
    BlockPointerDecodeError, BlockPointerEncodeError,
};

////////////////////////////////////////////////////////////////////////////////

/** ZIL header.
 *
 * ### Byte layout.
 *
 * - Bytes: 192
 *
 * ```text
 * +---------------+------+-------------+
 * | Field         | Size | SPA Version |
 * +---------------+------+-------------+
 * |     claim_txg |    8 |           1 |
 * |    replay_seq |    8 |           1 |
 * |           log |  128 |           1 |
 * | claim_blk_seq |    8 |           3 |
 * |         flags |    8 |          15 |
 * |  claim_lr_seq |    8 |          21 |
 * |       padding |   24 |             |
 * +---------------+------+-------------+
 * ```
 */
#[derive(Debug)]
pub struct ZilHeader {
    /// ???
    pub claim_blk_seq: u64,

    /// ???
    pub claim_lr_seq: u64,

    /// ???
    pub claim_txg: u64,

    /// ???
    pub flags: u64,

    /// ???
    pub log: Option<BlockPointer>,

    /// ???
    pub replay_seq: u64,
}

impl ZilHeader {
    /// Byte size of an encoded [`ZilHeader`] (192).
    pub const SIZE: usize = BlockPointer::SIZE + 64;

    /// Padding byte size.
    const PADDING_SIZE: usize = 24;

    /** Decodes a [`ZilHeader`].
     *
     * # Errors
     *
     * Returns [`ZilHeaderDecodeError`] on error.
     */
    pub fn from_decoder(
        decoder: &mut dyn BinaryDecoder<'_>,
    ) -> Result<ZilHeader, ZilHeaderDecodeError> {
        let zil_header = ZilHeader {
            claim_txg: decoder.get_u64()?,
            replay_seq: decoder.get_u64()?,
            log: BlockPointer::from_decoder(decoder)?,
            claim_blk_seq: decoder.get_u64()?,
            flags: decoder.get_u64()?,
            claim_lr_seq: decoder.get_u64()?,
        };

        decoder.skip_zeros(ZilHeader::PADDING_SIZE)?;

        Ok(zil_header)
    }

    /** Encodes a [`ZilHeader`].
     *
     * # Errors
     *
     * Returns [`ZilHeaderEncodeError`] on error.
     */
    pub fn to_encoder(
        &self,
        encoder: &mut dyn BinaryEncoder<'_>,
    ) -> Result<(), ZilHeaderEncodeError> {
        encoder.put_u64(self.claim_txg)?;
        encoder.put_u64(self.replay_seq)?;
        match &self.log {
            Some(ptr) => ptr.to_encoder(encoder)?,
            None => BlockPointer::empty_to_encoder(encoder)?,
        };
        encoder.put_u64(self.claim_blk_seq)?;
        encoder.put_u64(self.flags)?;
        encoder.put_u64(self.claim_lr_seq)?;
        encoder.put_zeros(ZilHeader::PADDING_SIZE)?;

        Ok(())
    }
}

////////////////////////////////////////////////////////////////////////////////

/// [`ZilHeader`] decode error.
#[derive(Debug)]
pub enum ZilHeaderDecodeError {
    /// [`BinaryDecoder`] error.
    Binary {
        /// Error.
        err: BinaryDecodeError,
    },

    /// [`BlockPointer`] decode error.
    BlockPointer {
        /// Error.
        err: BlockPointerDecodeError,
    },
}

impl From<BinaryDecodeError> for ZilHeaderDecodeError {
    fn from(err: BinaryDecodeError) -> Self {
        ZilHeaderDecodeError::Binary { err }
    }
}

impl From<BlockPointerDecodeError> for ZilHeaderDecodeError {
    fn from(err: BlockPointerDecodeError) -> Self {
        ZilHeaderDecodeError::BlockPointer { err }
    }
}

impl fmt::Display for ZilHeaderDecodeError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ZilHeaderDecodeError::Binary { err } => {
                write!(f, "ZilHeader decode error | {err}")
            }
            ZilHeaderDecodeError::BlockPointer { err } => {
                write!(f, "ZilHeader decode error | {err}")
            }
        }
    }
}

#[cfg(feature = "std")]
impl error::Error for ZilHeaderDecodeError {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match self {
            ZilHeaderDecodeError::Binary { err } => Some(err),
            ZilHeaderDecodeError::BlockPointer { err } => Some(err),
        }
    }
}

////////////////////////////////////////////////////////////////////////////////

/// [`ZilHeader`] encode error.
#[derive(Debug)]
pub enum ZilHeaderEncodeError {
    /// [`BinaryEncoder`] error.
    Binary {
        /// Error.
        err: BinaryEncodeError,
    },

    /// [`BlockPointer`] encode error.
    BlockPointer {
        /// Error.
        err: BlockPointerEncodeError,
    },
}

impl From<BinaryEncodeError> for ZilHeaderEncodeError {
    fn from(err: BinaryEncodeError) -> Self {
        ZilHeaderEncodeError::Binary { err }
    }
}

impl From<BlockPointerEncodeError> for ZilHeaderEncodeError {
    fn from(err: BlockPointerEncodeError) -> Self {
        ZilHeaderEncodeError::BlockPointer { err }
    }
}

impl fmt::Display for ZilHeaderEncodeError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ZilHeaderEncodeError::Binary { err } => {
                write!(f, "ZilHeader encode error | {err}")
            }
            ZilHeaderEncodeError::BlockPointer { err } => {
                write!(f, "ZilHeader encode error | {err}")
            }
        }
    }
}

#[cfg(feature = "std")]
impl error::Error for ZilHeaderEncodeError {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match self {
            ZilHeaderEncodeError::Binary { err } => Some(err),
            ZilHeaderEncodeError::BlockPointer { err } => Some(err),
        }
    }
}