1 // SPDX-License-Identifier: GPL-2.0 2 3 //! Generic disk abstraction. 4 //! 5 //! C header: [`include/linux/blkdev.h`](srctree/include/linux/blkdev.h) 6 //! C header: [`include/linux/blk_mq.h`](srctree/include/linux/blk_mq.h) 7 8 use crate::block::mq::{raw_writer::RawWriter, Operations, TagSet}; 9 use crate::error; 10 use crate::{bindings, error::from_err_ptr, error::Result, sync::Arc}; 11 use core::fmt::{self, Write}; 12 13 /// A builder for [`GenDisk`]. 14 /// 15 /// Use this struct to configure and add new [`GenDisk`] to the VFS. 16 pub struct GenDiskBuilder { 17 rotational: bool, 18 logical_block_size: u32, 19 physical_block_size: u32, 20 capacity_sectors: u64, 21 } 22 23 impl Default for GenDiskBuilder { 24 fn default() -> Self { 25 Self { 26 rotational: false, 27 logical_block_size: bindings::PAGE_SIZE as u32, 28 physical_block_size: bindings::PAGE_SIZE as u32, 29 capacity_sectors: 0, 30 } 31 } 32 } 33 34 impl GenDiskBuilder { 35 /// Create a new instance. 36 pub fn new() -> Self { 37 Self::default() 38 } 39 40 /// Set the rotational media attribute for the device to be built. 41 pub fn rotational(mut self, rotational: bool) -> Self { 42 self.rotational = rotational; 43 self 44 } 45 46 /// Validate block size by verifying that it is between 512 and `PAGE_SIZE`, 47 /// and that it is a power of two. 48 fn validate_block_size(size: u32) -> Result<()> { 49 if !(512..=bindings::PAGE_SIZE as u32).contains(&size) || !size.is_power_of_two() { 50 Err(error::code::EINVAL) 51 } else { 52 Ok(()) 53 } 54 } 55 56 /// Set the logical block size of the device to be built. 57 /// 58 /// This method will check that block size is a power of two and between 512 59 /// and 4096. If not, an error is returned and the block size is not set. 60 /// 61 /// This is the smallest unit the storage device can address. It is 62 /// typically 4096 bytes. 63 pub fn logical_block_size(mut self, block_size: u32) -> Result<Self> { 64 Self::validate_block_size(block_size)?; 65 self.logical_block_size = block_size; 66 Ok(self) 67 } 68 69 /// Set the physical block size of the device to be built. 70 /// 71 /// This method will check that block size is a power of two and between 512 72 /// and 4096. If not, an error is returned and the block size is not set. 73 /// 74 /// This is the smallest unit a physical storage device can write 75 /// atomically. It is usually the same as the logical block size but may be 76 /// bigger. One example is SATA drives with 4096 byte physical block size 77 /// that expose a 512 byte logical block size to the operating system. 78 pub fn physical_block_size(mut self, block_size: u32) -> Result<Self> { 79 Self::validate_block_size(block_size)?; 80 self.physical_block_size = block_size; 81 Ok(self) 82 } 83 84 /// Set the capacity of the device to be built, in sectors (512 bytes). 85 pub fn capacity_sectors(mut self, capacity: u64) -> Self { 86 self.capacity_sectors = capacity; 87 self 88 } 89 90 /// Build a new `GenDisk` and add it to the VFS. 91 pub fn build<T: Operations>( 92 self, 93 name: fmt::Arguments<'_>, 94 tagset: Arc<TagSet<T>>, 95 ) -> Result<GenDisk<T>> { 96 let lock_class_key = crate::sync::LockClassKey::new(); 97 98 // SAFETY: `bindings::queue_limits` contain only fields that are valid when zeroed. 99 let mut lim: bindings::queue_limits = unsafe { core::mem::zeroed() }; 100 101 lim.logical_block_size = self.logical_block_size; 102 lim.physical_block_size = self.physical_block_size; 103 if self.rotational { 104 lim.features = bindings::BLK_FEAT_ROTATIONAL; 105 } 106 107 // SAFETY: `tagset.raw_tag_set()` points to a valid and initialized tag set 108 let gendisk = from_err_ptr(unsafe { 109 bindings::__blk_mq_alloc_disk( 110 tagset.raw_tag_set(), 111 &mut lim, 112 core::ptr::null_mut(), 113 lock_class_key.as_ptr(), 114 ) 115 })?; 116 117 const TABLE: bindings::block_device_operations = bindings::block_device_operations { 118 submit_bio: None, 119 open: None, 120 release: None, 121 ioctl: None, 122 compat_ioctl: None, 123 check_events: None, 124 unlock_native_capacity: None, 125 getgeo: None, 126 set_read_only: None, 127 swap_slot_free_notify: None, 128 report_zones: None, 129 devnode: None, 130 alternative_gpt_sector: None, 131 get_unique_id: None, 132 // TODO: Set to THIS_MODULE. Waiting for const_refs_to_static feature to 133 // be merged (unstable in rustc 1.78 which is staged for linux 6.10) 134 // https://github.com/rust-lang/rust/issues/119618 135 owner: core::ptr::null_mut(), 136 pr_ops: core::ptr::null_mut(), 137 free_disk: None, 138 poll_bio: None, 139 }; 140 141 // SAFETY: `gendisk` is a valid pointer as we initialized it above 142 unsafe { (*gendisk).fops = &TABLE }; 143 144 let mut raw_writer = RawWriter::from_array( 145 // SAFETY: `gendisk` points to a valid and initialized instance. We 146 // have exclusive access, since the disk is not added to the VFS 147 // yet. 148 unsafe { &mut (*gendisk).disk_name }, 149 )?; 150 raw_writer.write_fmt(name)?; 151 raw_writer.write_char('\0')?; 152 153 // SAFETY: `gendisk` points to a valid and initialized instance of 154 // `struct gendisk`. `set_capacity` takes a lock to synchronize this 155 // operation, so we will not race. 156 unsafe { bindings::set_capacity(gendisk, self.capacity_sectors) }; 157 158 crate::error::to_result( 159 // SAFETY: `gendisk` points to a valid and initialized instance of 160 // `struct gendisk`. 161 unsafe { 162 bindings::device_add_disk(core::ptr::null_mut(), gendisk, core::ptr::null_mut()) 163 }, 164 )?; 165 166 // INVARIANT: `gendisk` was initialized above. 167 // INVARIANT: `gendisk` was added to the VFS via `device_add_disk` above. 168 Ok(GenDisk { 169 _tagset: tagset, 170 gendisk, 171 }) 172 } 173 } 174 175 /// A generic block device. 176 /// 177 /// # Invariants 178 /// 179 /// - `gendisk` must always point to an initialized and valid `struct gendisk`. 180 /// - `gendisk` was added to the VFS through a call to 181 /// `bindings::device_add_disk`. 182 pub struct GenDisk<T: Operations> { 183 _tagset: Arc<TagSet<T>>, 184 gendisk: *mut bindings::gendisk, 185 } 186 187 // SAFETY: `GenDisk` is an owned pointer to a `struct gendisk` and an `Arc` to a 188 // `TagSet` It is safe to send this to other threads as long as T is Send. 189 unsafe impl<T: Operations + Send> Send for GenDisk<T> {} 190 191 impl<T: Operations> Drop for GenDisk<T> { 192 fn drop(&mut self) { 193 // SAFETY: By type invariant, `self.gendisk` points to a valid and 194 // initialized instance of `struct gendisk`, and it was previously added 195 // to the VFS. 196 unsafe { bindings::del_gendisk(self.gendisk) }; 197 } 198 } 199