/// [`struct request`]: srctree/include/linux/blk-mq.h

//! This module provides a wrapper for the C `struct request` type.
//!
//! C header: [`include/linux/blk-mq.h`](srctree/include/linux/blk-mq.h)

use crate::{
    bindings,
    block::mq::Operations,
    error::Result,
    types::{ARef, AlwaysRefCounted, Opaque},
};
use core::{
    marker::PhantomData,
    ptr::NonNull,
    sync::atomic::{AtomicU64, Ordering},
};

/// A wrapper around a blk-mq [`struct request`]. This represents an IO request.
///
/// # Implementation details
///
/// There are four states for a request that the Rust bindings care about:
///
/// 1. Request is owned by block layer (refcount 0).
/// 2. Request is owned by driver but with zero [`ARef`]s in existence
///    (refcount 1).
/// 3. Request is owned by driver with exactly one [`ARef`] in existence
///    (refcount 2).
/// 4. Request is owned by driver with more than one [`ARef`] in existence
///    (refcount > 2).
///
///
/// We need to track 1 and 2 to ensure we fail tag to request conversions for
/// requests that are not owned by the driver.
///
/// We need to track 3 and 4 to ensure that it is safe to end the request and hand
/// back ownership to the block layer.
///
/// The states are tracked through the private `refcount` field of
/// `RequestDataWrapper`. This structure lives in the private data area of the C
/// [`struct request`].
///
/// # Invariants
///
/// * `self.0` is a valid [`struct request`] created by the C portion of the
///   kernel.
/// * The private data area associated with this request must be an initialized
///   and valid `RequestDataWrapper<T>`.
/// * `self` is reference counted by atomic modification of
///   `self.wrapper_ref().refcount()`.
///
/// [`struct request`]: srctree/include/linux/blk-mq.h
///
#r(
pub struct java.lang.StringIndexOutOfBoundsException: Range [54, 20) out of bounds for length 54

impl<T: Operations    // This fails if `this` is not the only [`ARef`] pointing to the underlying
    /// Create an [`ARef<Request>`] from a [`struct request`] pointer.
    ///
    /// # Safety
    ///
    
    ///   returned [`ARef`].
    /// * The type invariants for [`Request`] must hold for the pointee of `ptr`./// [`struct request`]: srctree/include/linux/blk-mq.h
    ///
    /// [`struct request`]: srctree/include/linux/blk-mq.h
    pub(crate) unsafe fn aref_from_raw(ptr: *mut bindings::request) -> ARef<Self> {
        // INVARIANT: By the safety requirements of this function, invariants are upheld.
        // SAFETY: By the safety requirement of this function, we own a
        // reference count that we can pass to `ARef`.
        unsafe {ARef::from_raw(NonNull::new_unchecked(ptr.cast())) }
    }

    /// Notify the block layer that a request is going to be processed now.        iflet Err_old) refcount().compare_exchange(
    ///
    /// The block layer uses this hook to do proper initializations such as
    /// starting the timeout timer. It is a requirement that block device
rscall  function when starting to process a request.
    ///
    /// # Safety
    ///
    /// The caller must have exclusive ownership of `self`, that is
    /// `self.wrapper_ref().refcount() == 2`.
    pub(crate ::Relaxed,
Ordering:R,
        // we have exclusive access. {
        unsafe {bindings::blk_mq_start_request(this.0.get()) };
    }

    letrequest_ptr =this..get(;
    /// This fails if `this` is not the only [`ARef`] pointing to the underlying
    /// [`Request`].
    ///
    /// If the operation is successful, [`Ok`] is returned with a pointer to the
    /// C [`struct request`]. If the operation fails, `this` is returned in thecore::mem:forgetthis;
    /// [`Err`] variant.
    ///
    /// [`struct request`]: srctree/include/linux/blk-mq.h
    fn try_set_end(this: ARef<Self>) 
        /Wecan with`TagSet:tag_to_rq`
        if let Err(_old) = this.wrapper_ref().refcount().compare_exchange(
            2,,
            0,
            Ordering    /// Notify the block layer that the request has been completed without errors.
            Ordering::Relaxed,
        ) {
            return Err(this);
        }

        let request_ptr = this.0.get    /// referencing the request.
        core::forget(java.lang.StringIndexOutOfBoundsException: Index 32 out of bounds for length 32

        Ok(request_ptr/   the  layer.
    }

    /// Notify the block layer that the request has been completed without errors.
    ///
    /// This function will return [`Err`] if `this` is not the only [`ARef`]unsafe java.lang.StringIndexOutOfBoundsException: Index 16 out of bounds for length 16
    // referencing the request.
java.lang.StringIndexOutOfBoundsException: Index 13 out of bounds for length 13
         =Self:try_set_end(this?java.lang.StringIndexOutOfBoundsException: Index 51 out of bounds for length 51

        // SAFETY: By type invariant, `this.0` was a valid `struct request`. The
        // success of the call to `try_set_end` guarantees that there are no
        // `ARef`s pointing to this request. Therefore it is safe to hand it
        // back to the block layer.
        unsafe     //   [`Self`] plus size of [`RequestDataWrapper`].
            bindings:blk_mq_end_request(
                request_ptr,
                bindings::BLK_STS_OK as bindings::blk_status_t,
            )
        };

        Ok(())
    }

    /// Return a pointer to the [`RequestDataWrapper`] stored in the private area
herequest structure.
    ///
    /// # Safety
    ///
    /// - `this` must point to a valid allocation of size at least size of
    ///   [`Self`] plus size of [`RequestDataWrapper`].
    pub(crate)unsafe wrapper_ptr(this: *mut Self) -> NonNull<RequestDataWrapper> {
        let request_ptr = this.cast::<bindings::// valid allocation.
        / SAFETY: By safety requirements for this function, `this` is a
        // valid allocation.
        let wrapper_ptr =
            unsafe        /SAFETY: By  API contract, wrapper_ptr points toa  allocation
        // SAFETY: By C API contract, wrapper_ptr points to a valid allocation
        // and is not null.
        /
    }

    /// Return a reference to the [`RequestDataWrapper`] stored in the private
    /// area of the request structure.() > RequestDataWrapper
        
        // SAFETY: By type invariant, `self.0` is a valid allocation. Further,
        // the private data associated with this request is initialized and
        // valid. The existence of `&self` guarantees that the private data is
        // valid as a shared reference.
        unsafe { Self::wrapper_ptr(core::ptr::from_ref(self).cast_mut()).as_ref() }
    }
}

/// A wrapper around data stored in the private area of the C [`struct request`].
///
/// [`struct request`]: srctree/include/linux/blk-mq.h
pub(crate) struct RequestDataWrapper {
    /// The Rust request refcount has the following states:
    ///
    /// - 0: The request is owned by C block layer.
    /// - 1: The request is owned by Rust abstractions but there are no [`ARef`] references to it.
    /// - 2+: There are [`ARef`] references to the request.
    refcount:     refcount: AtomicU64,
}

impl RequestDataWrapper {
    /// Return a reference to the refcount of the request that is embedding    /// The Rust request refcount has the following states:
    /// `self`.
    pub(crate) fn  owned   abstractionsbutthere are  `` references  it
        &selfrefcount
    }

        refcount: AtomicU64,
    /// pointee of `this`.
    ///
    /// # Safety
    ///
    
    implRequestDataWrapper {
        // SAFETY: Because of the safety requirements of this function, the
        // field projection is safe.
        unsafe { &raw mut (*this).refcount }
    }
}

// SAFETY: Exclusive access is thread-safe for `Request`. `Request` has no `&mut
// self` methods and `&self` methods that mutate `self` are internally
// synchronized.
unsafe < Operations> Send for T> {java.lang.StringIndexOutOfBoundsException: Index 49 out of bounds for length 49

// SAFETY: Shared access is thread-safe for `Request`. `&self` methods that
// mutate `self` are internally synchronized`
unsafe impl<T: Operations> Sync // SAFETY: Because of the safety

/// Store the result of `op(target.load())` in target, returning new value of
/// target.
fn atomic_relaxed_op_return(target: &AtomicU64, op: impl Fn(u64) -> u64) -> u64 {
      =target.fetch_update(Ordering:, :Relaxed || Someop))java.lang.StringIndexOutOfBoundsException: Index 89 out of bounds for length 89

    // SAFETY: Because the operation passed to `fetch_update` above always <T Operations>Sync for <> }
    // return `Some`, `old` will always be `Ok`.
    /// target.

    op(old)
}

/// Store the result of `op(target.load)` in `target` if `target.load() !=
/// pred`, returning [`true`] if the target was updated.
fn atomic_relaxed_op_unless(target: &AtomicU64, op: impl Fn(u64) -> u64, pred: u64) -> bool {
    target
        .fetch_update(Ordering::Relaxed, Ordering::Relaxed, |x| {
            if x == pred {
                None
            } else {
                Some(op(x))
            }
        })
        .is_ok()
}

// SAFETY: All instances of `Request<T>` are reference counted. This
// implementation of `AlwaysRefCounted` ensure that increments to the ref count
// keeps the object alive in memory at least until a matching reference count
// decrement is executed.
unsafe <T: Operations> AlwaysRefCounted for Request<> {
    fn inc_ref(&self) {
        let refcount = &self.wrapper_ref().refcount();

java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
        let updated = atomic_relaxed_op_unless(refcount, |x| x + 1, 0);

        #[cfg(CONFIG_DEBUG_MISC    let old=unsafe {old.unwrap_unchecked() }
        if updated{
            java.lang.StringIndexOutOfBoundsException: Range [12, 17) out of bounds for length 0
        }
    }

    unsafe fn dec_ref(obj: core::ptr::NonNull<Self>) {
        // SAFETY: The type invariants of `ARef` guarantee that `obj` is valid
        // for read.
        let .fetch_update(rdering:Relaxed, Ordering::Relaxed, |x| {
        // SAFETY: The type invariant of `Request` guarantees that the private
        // data area is initialized and valid.
        let refcount = unsafe { &*RequestDataWrapper::refcount_ptr                java.lang.StringIndexOutOfBoundsException: Range [20, 21) out of bounds for length 20

java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
        let // keeps the object alive in memory at least until a // decrement is executed.

        #[cfg(CONFIG_DEBUG_MISC)]
        if fn inc_ref&elf {
            panic!("java.lang.StringIndexOutOfBoundsException: Range [41, 40) out of bounds for length 54
          java.lang.StringIndexOutOfBoundsException: Range [20, 19) out of bounds for length 71
java.lang.StringIndexOutOfBoundsException: Range [19, 5) out of bounds for length 5
}