mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2026-05-26 12:12:13 +03:00
Add libzutil for libzfs or libzpool consumers
Adds a libzutil for utility functions that are common to libzfs and libzpool consumers (most of what was in libzfs_import.c). This removes the need for utilities to link against both libzpool and libzfs. Reviewed-by: Matthew Ahrens <mahrens@delphix.com> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Don Brady <don.brady@delphix.com> Closes #8050
This commit is contained in:
committed by
Brian Behlendorf
parent
6644e5bb6e
commit
e89f1295d4
+1
-402
@@ -29,10 +29,8 @@
|
||||
* Copyright (c) 2017, Intel Corporation.
|
||||
*/
|
||||
|
||||
#include <ctype.h>
|
||||
#include <errno.h>
|
||||
#include <devid.h>
|
||||
#include <fcntl.h>
|
||||
#include <libintl.h>
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
@@ -47,6 +45,7 @@
|
||||
#include <sys/zfs_ioctl.h>
|
||||
#include <sys/vdev_disk.h>
|
||||
#include <dlfcn.h>
|
||||
#include <libzutil.h>
|
||||
|
||||
#include "zfs_namecheck.h"
|
||||
#include "zfs_prop.h"
|
||||
@@ -3697,80 +3696,6 @@ set_path(zpool_handle_t *zhp, nvlist_t *nv, const char *path)
|
||||
}
|
||||
#endif /* sun */
|
||||
|
||||
/*
|
||||
* Remove partition suffix from a vdev path. Partition suffixes may take three
|
||||
* forms: "-partX", "pX", or "X", where X is a string of digits. The second
|
||||
* case only occurs when the suffix is preceded by a digit, i.e. "md0p0" The
|
||||
* third case only occurs when preceded by a string matching the regular
|
||||
* expression "^([hsv]|xv)d[a-z]+", i.e. a scsi, ide, virtio or xen disk.
|
||||
*
|
||||
* caller must free the returned string
|
||||
*/
|
||||
char *
|
||||
zfs_strip_partition(char *path)
|
||||
{
|
||||
char *tmp = strdup(path);
|
||||
char *part = NULL, *d = NULL;
|
||||
if (!tmp)
|
||||
return (NULL);
|
||||
|
||||
if ((part = strstr(tmp, "-part")) && part != tmp) {
|
||||
d = part + 5;
|
||||
} else if ((part = strrchr(tmp, 'p')) &&
|
||||
part > tmp + 1 && isdigit(*(part-1))) {
|
||||
d = part + 1;
|
||||
} else if ((tmp[0] == 'h' || tmp[0] == 's' || tmp[0] == 'v') &&
|
||||
tmp[1] == 'd') {
|
||||
for (d = &tmp[2]; isalpha(*d); part = ++d) { }
|
||||
} else if (strncmp("xvd", tmp, 3) == 0) {
|
||||
for (d = &tmp[3]; isalpha(*d); part = ++d) { }
|
||||
}
|
||||
if (part && d && *d != '\0') {
|
||||
for (; isdigit(*d); d++) { }
|
||||
if (*d == '\0')
|
||||
*part = '\0';
|
||||
}
|
||||
|
||||
return (tmp);
|
||||
}
|
||||
|
||||
/*
|
||||
* Same as zfs_strip_partition, but allows "/dev/" to be in the pathname
|
||||
*
|
||||
* path: /dev/sda1
|
||||
* returns: /dev/sda
|
||||
*
|
||||
* Returned string must be freed.
|
||||
*/
|
||||
char *
|
||||
zfs_strip_partition_path(char *path)
|
||||
{
|
||||
char *newpath = strdup(path);
|
||||
char *sd_offset;
|
||||
char *new_sd;
|
||||
|
||||
if (!newpath)
|
||||
return (NULL);
|
||||
|
||||
/* Point to "sda1" part of "/dev/sda1" */
|
||||
sd_offset = strrchr(newpath, '/') + 1;
|
||||
|
||||
/* Get our new name "sda" */
|
||||
new_sd = zfs_strip_partition(sd_offset);
|
||||
if (!new_sd) {
|
||||
free(newpath);
|
||||
return (NULL);
|
||||
}
|
||||
|
||||
/* Paste the "sda" where "sda1" was */
|
||||
strlcpy(sd_offset, new_sd, strlen(sd_offset) + 1);
|
||||
|
||||
/* Free temporary "sda" */
|
||||
free(new_sd);
|
||||
|
||||
return (newpath);
|
||||
}
|
||||
|
||||
#define PATH_BUF_LEN 64
|
||||
|
||||
/*
|
||||
@@ -4133,54 +4058,6 @@ get_history(zpool_handle_t *zhp, char *buf, uint64_t *off, uint64_t *len)
|
||||
return (0);
|
||||
}
|
||||
|
||||
/*
|
||||
* Process the buffer of nvlists, unpacking and storing each nvlist record
|
||||
* into 'records'. 'leftover' is set to the number of bytes that weren't
|
||||
* processed as there wasn't a complete record.
|
||||
*/
|
||||
int
|
||||
zpool_history_unpack(char *buf, uint64_t bytes_read, uint64_t *leftover,
|
||||
nvlist_t ***records, uint_t *numrecords)
|
||||
{
|
||||
uint64_t reclen;
|
||||
nvlist_t *nv;
|
||||
int i;
|
||||
void *tmp;
|
||||
|
||||
while (bytes_read > sizeof (reclen)) {
|
||||
|
||||
/* get length of packed record (stored as little endian) */
|
||||
for (i = 0, reclen = 0; i < sizeof (reclen); i++)
|
||||
reclen += (uint64_t)(((uchar_t *)buf)[i]) << (8*i);
|
||||
|
||||
if (bytes_read < sizeof (reclen) + reclen)
|
||||
break;
|
||||
|
||||
/* unpack record */
|
||||
if (nvlist_unpack(buf + sizeof (reclen), reclen, &nv, 0) != 0)
|
||||
return (ENOMEM);
|
||||
bytes_read -= sizeof (reclen) + reclen;
|
||||
buf += sizeof (reclen) + reclen;
|
||||
|
||||
/* add record to nvlist array */
|
||||
(*numrecords)++;
|
||||
if (ISP2(*numrecords + 1)) {
|
||||
tmp = realloc(*records,
|
||||
*numrecords * 2 * sizeof (nvlist_t *));
|
||||
if (tmp == NULL) {
|
||||
nvlist_free(nv);
|
||||
(*numrecords)--;
|
||||
return (ENOMEM);
|
||||
}
|
||||
*records = tmp;
|
||||
}
|
||||
(*records)[*numrecords - 1] = nv;
|
||||
}
|
||||
|
||||
*leftover = bytes_read;
|
||||
return (0);
|
||||
}
|
||||
|
||||
/*
|
||||
* Retrieve the command history of a pool.
|
||||
*/
|
||||
@@ -4669,281 +4546,3 @@ zpool_label_disk(libzfs_handle_t *hdl, zpool_handle_t *zhp, char *name)
|
||||
|
||||
return (0);
|
||||
}
|
||||
|
||||
/*
|
||||
* Allocate and return the underlying device name for a device mapper device.
|
||||
* If a device mapper device maps to multiple devices, return the first device.
|
||||
*
|
||||
* For example, dm_name = "/dev/dm-0" could return "/dev/sda". Symlinks to a
|
||||
* DM device (like /dev/disk/by-vdev/A0) are also allowed.
|
||||
*
|
||||
* Returns device name, or NULL on error or no match. If dm_name is not a DM
|
||||
* device then return NULL.
|
||||
*
|
||||
* NOTE: The returned name string must be *freed*.
|
||||
*/
|
||||
char *
|
||||
dm_get_underlying_path(char *dm_name)
|
||||
{
|
||||
DIR *dp = NULL;
|
||||
struct dirent *ep;
|
||||
char *realp;
|
||||
char *tmp = NULL;
|
||||
char *path = NULL;
|
||||
char *dev_str;
|
||||
int size;
|
||||
|
||||
if (dm_name == NULL)
|
||||
return (NULL);
|
||||
|
||||
/* dm name may be a symlink (like /dev/disk/by-vdev/A0) */
|
||||
realp = realpath(dm_name, NULL);
|
||||
if (realp == NULL)
|
||||
return (NULL);
|
||||
|
||||
/*
|
||||
* If they preface 'dev' with a path (like "/dev") then strip it off.
|
||||
* We just want the 'dm-N' part.
|
||||
*/
|
||||
tmp = strrchr(realp, '/');
|
||||
if (tmp != NULL)
|
||||
dev_str = tmp + 1; /* +1 since we want the chr after '/' */
|
||||
else
|
||||
dev_str = tmp;
|
||||
|
||||
size = asprintf(&tmp, "/sys/block/%s/slaves/", dev_str);
|
||||
if (size == -1 || !tmp)
|
||||
goto end;
|
||||
|
||||
dp = opendir(tmp);
|
||||
if (dp == NULL)
|
||||
goto end;
|
||||
|
||||
/* Return first sd* entry in /sys/block/dm-N/slaves/ */
|
||||
while ((ep = readdir(dp))) {
|
||||
if (ep->d_type != DT_DIR) { /* skip "." and ".." dirs */
|
||||
size = asprintf(&path, "/dev/%s", ep->d_name);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
end:
|
||||
if (dp != NULL)
|
||||
closedir(dp);
|
||||
free(tmp);
|
||||
free(realp);
|
||||
return (path);
|
||||
}
|
||||
|
||||
/*
|
||||
* Return 1 if device is a device mapper or multipath device.
|
||||
* Return 0 if not.
|
||||
*/
|
||||
int
|
||||
zfs_dev_is_dm(char *dev_name)
|
||||
{
|
||||
|
||||
char *tmp;
|
||||
tmp = dm_get_underlying_path(dev_name);
|
||||
if (tmp == NULL)
|
||||
return (0);
|
||||
|
||||
free(tmp);
|
||||
return (1);
|
||||
}
|
||||
|
||||
/*
|
||||
* By "whole disk" we mean an entire physical disk (something we can
|
||||
* label, toggle the write cache on, etc.) as opposed to the full
|
||||
* capacity of a pseudo-device such as lofi or did. We act as if we
|
||||
* are labeling the disk, which should be a pretty good test of whether
|
||||
* it's a viable device or not. Returns B_TRUE if it is and B_FALSE if
|
||||
* it isn't.
|
||||
*/
|
||||
int
|
||||
zfs_dev_is_whole_disk(char *dev_name)
|
||||
{
|
||||
struct dk_gpt *label;
|
||||
int fd;
|
||||
|
||||
if ((fd = open(dev_name, O_RDONLY | O_DIRECT)) < 0)
|
||||
return (0);
|
||||
|
||||
if (efi_alloc_and_init(fd, EFI_NUMPAR, &label) != 0) {
|
||||
(void) close(fd);
|
||||
return (0);
|
||||
}
|
||||
|
||||
efi_free(label);
|
||||
(void) close(fd);
|
||||
|
||||
return (1);
|
||||
}
|
||||
|
||||
/*
|
||||
* Lookup the underlying device for a device name
|
||||
*
|
||||
* Often you'll have a symlink to a device, a partition device,
|
||||
* or a multipath device, and want to look up the underlying device.
|
||||
* This function returns the underlying device name. If the device
|
||||
* name is already the underlying device, then just return the same
|
||||
* name. If the device is a DM device with multiple underlying devices
|
||||
* then return the first one.
|
||||
*
|
||||
* For example:
|
||||
*
|
||||
* 1. /dev/disk/by-id/ata-QEMU_HARDDISK_QM00001 -> ../../sda
|
||||
* dev_name: /dev/disk/by-id/ata-QEMU_HARDDISK_QM00001
|
||||
* returns: /dev/sda
|
||||
*
|
||||
* 2. /dev/mapper/mpatha (made up of /dev/sda and /dev/sdb)
|
||||
* dev_name: /dev/mapper/mpatha
|
||||
* returns: /dev/sda (first device)
|
||||
*
|
||||
* 3. /dev/sda (already the underlying device)
|
||||
* dev_name: /dev/sda
|
||||
* returns: /dev/sda
|
||||
*
|
||||
* 4. /dev/dm-3 (mapped to /dev/sda)
|
||||
* dev_name: /dev/dm-3
|
||||
* returns: /dev/sda
|
||||
*
|
||||
* 5. /dev/disk/by-id/scsi-0QEMU_drive-scsi0-0-0-0-part9 -> ../../sdb9
|
||||
* dev_name: /dev/disk/by-id/scsi-0QEMU_drive-scsi0-0-0-0-part9
|
||||
* returns: /dev/sdb
|
||||
*
|
||||
* 6. /dev/disk/by-uuid/5df030cf-3cd9-46e4-8e99-3ccb462a4e9a -> ../dev/sda2
|
||||
* dev_name: /dev/disk/by-uuid/5df030cf-3cd9-46e4-8e99-3ccb462a4e9a
|
||||
* returns: /dev/sda
|
||||
*
|
||||
* Returns underlying device name, or NULL on error or no match.
|
||||
*
|
||||
* NOTE: The returned name string must be *freed*.
|
||||
*/
|
||||
char *
|
||||
zfs_get_underlying_path(char *dev_name)
|
||||
{
|
||||
char *name = NULL;
|
||||
char *tmp;
|
||||
|
||||
if (dev_name == NULL)
|
||||
return (NULL);
|
||||
|
||||
tmp = dm_get_underlying_path(dev_name);
|
||||
|
||||
/* dev_name not a DM device, so just un-symlinkize it */
|
||||
if (tmp == NULL)
|
||||
tmp = realpath(dev_name, NULL);
|
||||
|
||||
if (tmp != NULL) {
|
||||
name = zfs_strip_partition_path(tmp);
|
||||
free(tmp);
|
||||
}
|
||||
|
||||
return (name);
|
||||
}
|
||||
|
||||
/*
|
||||
* Given a dev name like "sda", return the full enclosure sysfs path to
|
||||
* the disk. You can also pass in the name with "/dev" prepended
|
||||
* to it (like /dev/sda).
|
||||
*
|
||||
* For example, disk "sda" in enclosure slot 1:
|
||||
* dev: "sda"
|
||||
* returns: "/sys/class/enclosure/1:0:3:0/Slot 1"
|
||||
*
|
||||
* 'dev' must be a non-devicemapper device.
|
||||
*
|
||||
* Returned string must be freed.
|
||||
*/
|
||||
char *
|
||||
zfs_get_enclosure_sysfs_path(char *dev_name)
|
||||
{
|
||||
DIR *dp = NULL;
|
||||
struct dirent *ep;
|
||||
char buf[MAXPATHLEN];
|
||||
char *tmp1 = NULL;
|
||||
char *tmp2 = NULL;
|
||||
char *tmp3 = NULL;
|
||||
char *path = NULL;
|
||||
size_t size;
|
||||
int tmpsize;
|
||||
|
||||
if (dev_name == NULL)
|
||||
return (NULL);
|
||||
|
||||
/* If they preface 'dev' with a path (like "/dev") then strip it off */
|
||||
tmp1 = strrchr(dev_name, '/');
|
||||
if (tmp1 != NULL)
|
||||
dev_name = tmp1 + 1; /* +1 since we want the chr after '/' */
|
||||
|
||||
tmpsize = asprintf(&tmp1, "/sys/block/%s/device", dev_name);
|
||||
if (tmpsize == -1 || tmp1 == NULL) {
|
||||
tmp1 = NULL;
|
||||
goto end;
|
||||
}
|
||||
|
||||
dp = opendir(tmp1);
|
||||
if (dp == NULL) {
|
||||
tmp1 = NULL; /* To make free() at the end a NOP */
|
||||
goto end;
|
||||
}
|
||||
|
||||
/*
|
||||
* Look though all sysfs entries in /sys/block/<dev>/device for
|
||||
* the enclosure symlink.
|
||||
*/
|
||||
while ((ep = readdir(dp))) {
|
||||
/* Ignore everything that's not our enclosure_device link */
|
||||
if (strstr(ep->d_name, "enclosure_device") == NULL)
|
||||
continue;
|
||||
|
||||
if (asprintf(&tmp2, "%s/%s", tmp1, ep->d_name) == -1 ||
|
||||
tmp2 == NULL)
|
||||
break;
|
||||
|
||||
size = readlink(tmp2, buf, sizeof (buf));
|
||||
|
||||
/* Did readlink fail or crop the link name? */
|
||||
if (size == -1 || size >= sizeof (buf)) {
|
||||
free(tmp2);
|
||||
tmp2 = NULL; /* To make free() at the end a NOP */
|
||||
break;
|
||||
}
|
||||
|
||||
/*
|
||||
* We got a valid link. readlink() doesn't terminate strings
|
||||
* so we have to do it.
|
||||
*/
|
||||
buf[size] = '\0';
|
||||
|
||||
/*
|
||||
* Our link will look like:
|
||||
*
|
||||
* "../../../../port-11:1:2/..STUFF../enclosure/1:0:3:0/SLOT 1"
|
||||
*
|
||||
* We want to grab the "enclosure/1:0:3:0/SLOT 1" part
|
||||
*/
|
||||
tmp3 = strstr(buf, "enclosure");
|
||||
if (tmp3 == NULL)
|
||||
break;
|
||||
|
||||
if (asprintf(&path, "/sys/class/%s", tmp3) == -1) {
|
||||
/* If asprintf() fails, 'path' is undefined */
|
||||
path = NULL;
|
||||
break;
|
||||
}
|
||||
|
||||
if (path == NULL)
|
||||
break;
|
||||
}
|
||||
|
||||
end:
|
||||
free(tmp2);
|
||||
free(tmp1);
|
||||
|
||||
if (dp != NULL)
|
||||
closedir(dp);
|
||||
|
||||
return (path);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user