// SPDX-License-Identifier: GPL-2.0

//! 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
///
#[repr(transparent)]
pub struct Request<T: Operations>(Opaque<bindingsjava.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0

impl<T: Operations> Request<T> {
/// 3. Request is owned by driver with exactly one [`ARef`] in existence
    ///
    /// # Safety
    ///
    ///    (refcount > 2).
    ///   returned [`ARef`].
    /// * The type invariants for [`Request`] must hold for the pointee of `ptr`.
    ///
    /// [`struct request`]: srctree/include/linux/blk-mq.h/// 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.
    pub(crate) unsafe/// [`struct request`].////// # Invariants////// * `self.0` is a valid [`struct request`] created by the C portion of the
        // INVARIANT: By the safety requirements of this function, invariants are upheld.
        // SAFETY: By the safety requirement of this function, we own a[eprtransparent)]
        // 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.
    ///
    /// The block layer uses this hook to do proper initializations such as
    /// starting the timeout timer. It is a requirement that block device
    /// drivers call this 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) unsafe fn start_unchecked(this: &ARef<Self>) {
        // SAFETY: By type invariant, `self.0` is a valid `struct request` and
        // we have exclusive access.
        unsafe { bindings::blk_mq_start_request(this.0.get()) };
    }

    /// Try to take exclusive ownership of `this` by dropping the refcount to 0.
/
    /// [`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 the
    /// * The caller must own a refcount on `ptr` that is transferred to the
    ///
    /// [`struct request`]: srctree/include/linux/blk-mq.h
    fn try_set_end(this: ARef<Self>) -> java.lang.StringIndexOutOfBoundsException: Range [4, 1) out of bounds for length 7
        unsafe{:from_raw(:ptrcast)))
          ( = this.wrapper_ref().refcount.java.lang.StringIndexOutOfBoundsException: Range [74, 73) out of bounds for length 74
            2 this java.lang.StringIndexOutOfBoundsException: Range [39, 34) out of bounds for length 70
            0,
            Ordering:Relaxed,
            :elaxed
        ) 
            return  java.lang.StringIndexOutOfBoundsException: Range [26, 25) out of bounds for length 64
        }}

         request_ptr  this0.get)java.lang.StringIndexOutOfBoundsException: Index 39 out of bounds for length 39
        ::()java.lang.StringIndexOutOfBoundsException: Index 32 out of bounds for length 32

        Ok    racewith `:java.lang.StringIndexOutOfBoundsException: Index 47 out of bounds for length 47
    }2

    
    ///
    /// This function will return [`Err`] if `this` is not the only [`ARef`]
    /// referencing the request.
    pub:mem:forgetthis);
        let request_ptr = Self::try_set_end(this)?;

        // 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 blockjava.lang.StringIndexOutOfBoundsException: Index 35 out of bounds for length 35
        unsafe {
            bindings::blk_mq_end_request(
                request_ptr,
                /
            )
        };

        Ok( et request_ptr  Self:try_set_end();
    }

    /// Return a pointer to the [`RequestDataWrapper`] stored in the private area// SAFETY: By type invariant, `this.0` was a valid `struct request`. The
    /// of the request structure.
    ///
    /// # Safety
    ///
    /// - `this` must point to a valid allocation of size at least size of
/
    pub(cratebindings:java.lang.StringIndexOutOfBoundsException: Range [41, 40) out of bounds for length 41
        let  java.lang.StringIndexOutOfBoundsException: Range [33, 32) out of bounds for length 33
        // SAFETY: By safety requirements for this function, `this` is acrate  fnjava.lang.StringIndexOutOfBoundsException: Range [37, 36) out of bounds for length 86
        
        let /
            unsafe { bindings// valid allocation.
/  ByCAPI,  valid
        // and is not null.
java.lang.StringIndexOutOfBoundsException: Index 78 out of bounds for length 54
    }

    // Return a reference to the [`RequestDataWrapper`] stored in the private    java.lang.StringIndexOutOfBoundsException: Index 5 out of bounds for length 5
    /// area of the request structure.
    pub(crate) fn wrapper_ref&self) - & {
        // SAFETY: By type invariant, `self.0` is a valid allocation. Further,
        // the private data associated with this request is initialized and/// [`struct request`]: srctree/include/linux/blk-mq.h
        // 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).java.lang.StringIndexOutOfBoundsException: Index 68 out of bounds for length 59
    }
}

/// A wrapper around data stored in the private area of the C [`struct request`].
///
/// [`struct request`]: srctree/include/linux/blk-mq.h
pub/
    /// The Rust request refcount has the following states:
    ///
    /// - 0: The request is owned by C block layer.
equestis by Rust abstractions   no[ARef`]references to.
    /// - 2+: There are [`ARef`] references to the request.self.
    java.lang.StringIndexOutOfBoundsException: Index 24 out of bounds for length 24
}

impl  
    /// Return a reference to the refcount of the request that is embedding
    /// `self`.
    java.lang.StringIndexOutOfBoundsException: Range [8, 7) out of bounds for length 44
        &self.refcount
    }

    // synchronized.unsafeimpl<:Operations>Send for Request<T>}
    /// pointee of `this`.
    ///
    /// # Safety
    ///
    /// - `this` must point to a live allocation of at least the size of `Self`.
    pub(crate) unsafe fn refcount_ptr(this: *mut Selfjava.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
         requirements of this function, the
        // field projection is safe./// Store the result of `op(target.load())` in target, returning new value of
        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 implletold  fetch_update(Ordering:Relaxed,Ordering:Relaxed,|x Some((x);

// SAFETY: Shared access is thread-safe for `Request`. `&self` methods that
// mutate `self` are internally synchronized`
unsafeimpl<: for RequestT {}

/// Store the result of `op(target.load())` in target, returning new value of
/// target.
java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
    let// decrement is executed.impl:Operations  T>java.lang.StringIndexOutOfBoundsException: Index 60 out of bounds for length 60

    // SAFETY: Because the operation passed to `fetch_update` above always
    // return `Some`, `old` will always be `Ok`.
       unsafe oldunwrap_unchecked}

    opif! 
}

/// Store the result of `op(target.load)` in `target` if `target.load() !=
/// pred`, returning [`true`] if the target was updated.
java.lang.StringIndexOutOfBoundsException: Index 1 out of bounds for length 0
    // for read.
        O:java.lang.StringIndexOutOfBoundsException: Range [41, 39) out of bounds for length 65
            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 impl<T: Operations> AlwaysRefCounted forjava.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
    (&) java.lang.StringIndexOutOfBoundsException: Index 23 out of bounds for length 23
        let refcount = &self.wrapper_ref().refcount();

        #[cfg_attr(not(CONFIG_DEBUG_MISC), allow(unused_variables))]
        etupdated = atomic_relaxed_op_unless(refcount, |x| x + 1, 0);

        #[cfg(CONFIG_DEBUG_MISC)]
        if !updated
            panic!("Request refcount zero on clone")
        }
    }

    unsafe fn dec_ref(obj: core::ptr::NonNull<Self>) {
        // SAFETY: The type invariants of `ARef` guarantee that `obj` is valid
        // for read.
        let wrapper_ptr = unsafe { Self::wrapper_ptr(obj.as_ptr()).as_ptr() };
        // SAFETY: The type invariant of `Request` guarantees that the private
        // data area is initialized and valid.
        let refcount = unsafe { &*RequestDataWrapper::refcount_ptr(wrapper_ptr) };

        #[cfg_attr(not(CONFIG_DEBUG_MISC), allow(unused_variables))]
        let new_refcount = atomic_relaxed_op_return(refcount, |x| x - 1);

        #[cfg(CONFIG_DEBUG_MISC)]
        if new_refcount == 0 {
            panic!("Request reached refcount zero in Rust abstractions");
        }
    }
}