2 * SPDX-License-Identifier: Beerware
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 * ----------------------------------------------------------------------------
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>
27 #include <sys/conf.h> /* XXX: temporary to avoid breakage */
30 void disk_err(struct bio *bp, const char *what, int blkdone, int nl);
34 #define DIOCGSECTORSIZE _IOR('d', 128, u_int)
36 * Get the sector size of the device in bytes. The sector size is the
37 * smallest unit of data which can be transferred from this device.
38 * Usually this is a power of 2 but it might not be (i.e. CDROM audio).
41 #define DIOCGMEDIASIZE _IOR('d', 129, off_t) /* Get media size in bytes */
43 * Get the size of the entire device in bytes. This should be a
44 * multiple of the sector size.
47 #define DIOCGFWSECTORS _IOR('d', 130, u_int) /* Get firmware's sectorcount */
49 * Get the firmware's notion of number of sectors per track. This
50 * value is mostly used for compatibility with various ill designed
51 * disk label formats. Don't use it unless you have to.
54 #define DIOCGFWHEADS _IOR('d', 131, u_int) /* Get firmware's headcount */
56 * Get the firmwares notion of number of heads per cylinder. This
57 * value is mostly used for compatibility with various ill designed
58 * disk label formats. Don't use it unless you have to.
61 #define DIOCSKERNELDUMP_FREEBSD11 _IOW('d', 133, u_int)
63 * Enable/Disable (the argument is boolean) the device for kernel
67 #define DIOCGFLUSH _IO('d', 135) /* Flush write cache */
69 * Flush write cache of the device.
72 #define DIOCGDELETE _IOW('d', 136, off_t[2]) /* Delete data */
74 * Mark data on the device as unused.
77 #define DISK_IDENT_SIZE 256
78 #define DIOCGIDENT _IOR('d', 137, char[DISK_IDENT_SIZE])
80 * Get the ident of the given provider. Ident is (most of the time)
81 * a uniqe and fixed provider's identifier. Ident's properties are as
83 * - ident value is preserved between reboots,
84 * - provider can be detached/attached and ident is preserved,
85 * - provider's name can change - ident can't,
86 * - ident value should not be based on on-disk metadata; in other
87 * words copying whole data from one disk to another should not
88 * yield the same ident for the other disk,
89 * - there could be more than one provider with the same ident, but
90 * only if they point at exactly the same physical storage, this is
91 * the case for multipathing for example,
92 * - GEOM classes that consumes single providers and provide single
93 * providers, like geli, gbde, should just attach class name to the
94 * ident of the underlying provider,
95 * - ident is an ASCII string (is printable),
96 * - ident is optional and applications can't relay on its presence.
99 #define DIOCGPROVIDERNAME _IOR('d', 138, char[MAXPATHLEN])
101 * Store the provider name, given a device path, in a buffer. The buffer
102 * must be at least MAXPATHLEN bytes long.
105 #define DIOCGSTRIPESIZE _IOR('d', 139, off_t) /* Get stripe size in bytes */
107 * Get the size of the device's optimal access block in bytes.
108 * This should be a multiple of the sector size.
111 #define DIOCGSTRIPEOFFSET _IOR('d', 140, off_t) /* Get stripe offset in bytes */
113 * Get the offset of the first device's optimal access block in bytes.
114 * This should be a multiple of the sector size.
117 #define DIOCGPHYSPATH _IOR('d', 141, char[MAXPATHLEN])
119 * Get a string defining the physical path for a given provider.
120 * This has similar rules to ident, but is intended to uniquely
121 * identify the physical location of the device, not the current
122 * occupant of that location.
125 struct diocgattr_arg {
129 char str[DISK_IDENT_SIZE];
135 #define DIOCGATTR _IOWR('d', 142, struct diocgattr_arg)
137 #define DIOCZONECMD _IOWR('d', 143, struct disk_zone_args)
139 struct diocskerneldump_arg_freebsd12 {
140 uint8_t kda12_enable;
141 uint8_t kda12_compression;
142 uint8_t kda12_encryption;
143 uint8_t kda12_key[KERNELDUMP_KEY_MAX_SIZE];
144 uint32_t kda12_encryptedkeysize;
145 uint8_t *kda12_encryptedkey;
147 #define DIOCSKERNELDUMP_FREEBSD12 \
148 _IOW('d', 144, struct diocskerneldump_arg_freebsd12)
150 #ifndef WITHOUT_NETDUMP
152 #include <netinet/in.h>
160 * Sentinel values for kda_index.
162 * If kda_index is KDA_REMOVE_ALL, all dump configurations are cleared.
164 * If kda_index is KDA_REMOVE_DEV, all dump configurations for the specified
165 * device are cleared.
167 * If kda_index is KDA_REMOVE, only the specified dump configuration for the
168 * given device is removed from the list of fallback dump configurations.
170 * If kda_index is KDA_APPEND, the dump configuration is added after all
171 * existing dump configurations.
173 * Otherwise, the new configuration is inserted into the fallback dump list at
176 #define KDA_REMOVE UINT8_MAX
177 #define KDA_REMOVE_ALL (UINT8_MAX - 1)
178 #define KDA_REMOVE_DEV (UINT8_MAX - 2)
179 #define KDA_APPEND (UINT8_MAX - 3)
180 struct diocskerneldump_arg {
182 uint8_t kda_compression;
183 uint8_t kda_encryption;
184 uint8_t kda_key[KERNELDUMP_KEY_MAX_SIZE];
185 uint32_t kda_encryptedkeysize;
186 uint8_t *kda_encryptedkey;
187 char kda_iface[IFNAMSIZ];
188 union kd_ip kda_server;
189 union kd_ip kda_client;
190 union kd_ip kda_gateway;
193 _Static_assert(__offsetof(struct diocskerneldump_arg, kda_iface) ==
194 sizeof(struct diocskerneldump_arg_freebsd12), "simplifying assumption");
195 #define DIOCSKERNELDUMP _IOW('d', 145, struct diocskerneldump_arg)
197 * Enable/Disable the device for kernel core dumps.
200 #define DIOCGKERNELDUMP _IOWR('d', 146, struct diocskerneldump_arg)
202 * Get current kernel netdump configuration details for a given index.
206 #endif /* _SYS_DISK_H_ */