1 /*- 2 * SPDX-License-Identifier: Beerware 3 * 4 * ---------------------------------------------------------------------------- 5 * "THE BEER-WARE LICENSE" (Revision 42): 6 * <phk@FreeBSD.ORG> wrote this file. As long as you retain this notice you 7 * can do whatever you want with this stuff. If we meet some day, and you think 8 * this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp 9 * ---------------------------------------------------------------------------- 10 * 11 * $FreeBSD$ 12 * 13 */ 14 15 #ifndef _SYS_DISK_H_ 16 #define _SYS_DISK_H_ 17 18 #include <sys/ioccom.h> 19 #include <sys/kerneldump.h> 20 #include <sys/types.h> 21 #include <sys/disk_zone.h> 22 #include <sys/socket.h> 23 24 #ifdef _KERNEL 25 26 void disk_err(struct bio *bp, const char *what, int blkdone, int nl); 27 28 #endif 29 30 #define DIOCGSECTORSIZE _IOR('d', 128, u_int) 31 /* 32 * Get the sector size of the device in bytes. The sector size is the 33 * smallest unit of data which can be transferred from this device. 34 * Usually this is a power of 2 but it might not be (i.e. CDROM audio). 35 */ 36 37 #define DIOCGMEDIASIZE _IOR('d', 129, off_t) /* Get media size in bytes */ 38 /* 39 * Get the size of the entire device in bytes. This should be a 40 * multiple of the sector size. 41 */ 42 43 #define DIOCGFWSECTORS _IOR('d', 130, u_int) /* Get firmware's sectorcount */ 44 /* 45 * Get the firmware's notion of number of sectors per track. This 46 * value is mostly used for compatibility with various ill designed 47 * disk label formats. Don't use it unless you have to. 48 */ 49 50 #define DIOCGFWHEADS _IOR('d', 131, u_int) /* Get firmware's headcount */ 51 /* 52 * Get the firmwares notion of number of heads per cylinder. This 53 * value is mostly used for compatibility with various ill designed 54 * disk label formats. Don't use it unless you have to. 55 */ 56 57 #define DIOCGFLUSH _IO('d', 135) /* Flush write cache */ 58 /* 59 * Flush write cache of the device. 60 */ 61 62 #define DIOCGDELETE _IOW('d', 136, off_t[2]) /* Delete data */ 63 /* 64 * Mark data on the device as unused. 65 */ 66 67 #define DISK_IDENT_SIZE 256 68 #define DIOCGIDENT _IOR('d', 137, char[DISK_IDENT_SIZE]) 69 /*- 70 * Get the ident of the given provider. Ident is (most of the time) 71 * a uniqe and fixed provider's identifier. Ident's properties are as 72 * follow: 73 * - ident value is preserved between reboots, 74 * - provider can be detached/attached and ident is preserved, 75 * - provider's name can change - ident can't, 76 * - ident value should not be based on on-disk metadata; in other 77 * words copying whole data from one disk to another should not 78 * yield the same ident for the other disk, 79 * - there could be more than one provider with the same ident, but 80 * only if they point at exactly the same physical storage, this is 81 * the case for multipathing for example, 82 * - GEOM classes that consumes single providers and provide single 83 * providers, like geli, gbde, should just attach class name to the 84 * ident of the underlying provider, 85 * - ident is an ASCII string (is printable), 86 * - ident is optional and applications can't relay on its presence. 87 */ 88 89 #define DIOCGPROVIDERNAME _IOR('d', 138, char[MAXPATHLEN]) 90 /* 91 * Store the provider name, given a device path, in a buffer. The buffer 92 * must be at least MAXPATHLEN bytes long. 93 */ 94 95 #define DIOCGSTRIPESIZE _IOR('d', 139, off_t) /* Get stripe size in bytes */ 96 /* 97 * Get the size of the device's optimal access block in bytes. 98 * This should be a multiple of the sector size. 99 */ 100 101 #define DIOCGSTRIPEOFFSET _IOR('d', 140, off_t) /* Get stripe offset in bytes */ 102 /* 103 * Get the offset of the first device's optimal access block in bytes. 104 * This should be a multiple of the sector size. 105 */ 106 107 #define DIOCGPHYSPATH _IOR('d', 141, char[MAXPATHLEN]) 108 /* 109 * Get a string defining the physical path for a given provider. 110 * This has similar rules to ident, but is intended to uniquely 111 * identify the physical location of the device, not the current 112 * occupant of that location. 113 */ 114 115 struct diocgattr_arg { 116 char name[64]; 117 int len; 118 union { 119 char str[DISK_IDENT_SIZE]; 120 off_t off; 121 int i; 122 uint16_t u16; 123 } value; 124 }; 125 #define DIOCGATTR _IOWR('d', 142, struct diocgattr_arg) 126 127 #define DIOCZONECMD _IOWR('d', 143, struct disk_zone_args) 128 129 #ifndef WITHOUT_NETDUMP 130 #include <net/if.h> 131 #include <netinet/in.h> 132 133 union kd_ip { 134 struct in_addr in4; 135 struct in6_addr in6; 136 }; 137 138 /* 139 * Sentinel values for kda_index. 140 * 141 * If kda_index is KDA_REMOVE_ALL, all dump configurations are cleared. 142 * 143 * If kda_index is KDA_REMOVE_DEV, all dump configurations for the specified 144 * device are cleared. 145 * 146 * If kda_index is KDA_REMOVE, only the specified dump configuration for the 147 * given device is removed from the list of fallback dump configurations. 148 * 149 * If kda_index is KDA_APPEND, the dump configuration is added after all 150 * existing dump configurations. 151 * 152 * Otherwise, the new configuration is inserted into the fallback dump list at 153 * index 'kda_index'. 154 */ 155 #define KDA_REMOVE UINT8_MAX 156 #define KDA_REMOVE_ALL (UINT8_MAX - 1) 157 #define KDA_REMOVE_DEV (UINT8_MAX - 2) 158 #define KDA_APPEND (UINT8_MAX - 3) 159 struct diocskerneldump_arg { 160 uint8_t kda_index; 161 uint8_t kda_compression; 162 uint8_t kda_encryption; 163 uint8_t kda_key[KERNELDUMP_KEY_MAX_SIZE]; 164 uint32_t kda_encryptedkeysize; 165 uint8_t *kda_encryptedkey; 166 char kda_iface[IFNAMSIZ]; 167 union kd_ip kda_server; 168 union kd_ip kda_client; 169 union kd_ip kda_gateway; 170 uint8_t kda_af; 171 }; 172 #define DIOCSKERNELDUMP _IOW('d', 145, struct diocskerneldump_arg) 173 /* 174 * Enable/Disable the device for kernel core dumps. 175 */ 176 177 #define DIOCGKERNELDUMP _IOWR('d', 146, struct diocskerneldump_arg) 178 /* 179 * Get current kernel netdump configuration details for a given index. 180 */ 181 #endif 182 183 #endif /* _SYS_DISK_H_ */ 184