1
0
Fork 0
nvme-cli/nvme.h
Daniel Baumann d6fd2fdea9
Merging upstream version 1.14.
Signed-off-by: Daniel Baumann <daniel@debian.org>
2025-02-16 11:31:10 +01:00

147 lines
4.1 KiB
C

/*
* Definitions for the NVM Express interface
* Copyright (c) 2011-2014, Intel Corporation.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms and conditions of the GNU General Public License,
* version 2, as published by the Free Software Foundation.
*
* This program is distributed in the hope it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*/
#ifndef _NVME_H
#define _NVME_H
#include <dirent.h>
#include <stdbool.h>
#include <stdint.h>
#include <endian.h>
#include <sys/time.h>
#include "plugin.h"
#ifdef LIBJSONC
#include <json-c/json.h>
#define json_create_object(o) json_object_new_object(o)
#define json_create_array(a) json_object_new_array(a)
#define json_free_object(o) json_object_put(o)
#define json_free_array(a) json_object_put(a)
#define json_object_add_value_uint(o, k, v) \
json_object_object_add(o, k, json_object_new_int(v))
#define json_object_add_value_int(o, k, v) \
json_object_object_add(o, k, json_object_new_int(v))
#define json_object_add_value_float(o, k, v) \
json_object_object_add(o, k, json_object_new_double(v))
#define json_object_add_value_string(o, k, v) \
json_object_object_add(o, k, json_object_new_string(v))
#define json_object_add_value_array(o, k, v) \
json_object_object_add(o, k, v)
#define json_object_add_value_object(o, k, v) \
json_object_object_add(o, k, v)
#define json_array_add_value_object(o, k) \
json_object_array_add(o, k)
#define json_print_object(o, u) \
printf("%s", json_object_to_json_string_ext(o, JSON_C_TO_STRING_PRETTY))
#else
#include "util/json.h"
#endif
#include "util/argconfig.h"
#include "linux/nvme.h"
enum nvme_print_flags {
NORMAL = 0,
VERBOSE = 1 << 0, /* verbosely decode complex values for humans */
JSON = 1 << 1, /* display in json format */
VS = 1 << 2, /* hex dump vendor specific data areas */
BINARY = 1 << 3, /* binary dump raw bytes */
};
struct nvme_subsystem;
struct nvme_ctrl;
struct nvme_namespace {
char *name;
struct nvme_ctrl *ctrl;
unsigned nsid;
struct nvme_id_ns ns;
};
struct nvme_ctrl {
char *name;
char *path;
struct nvme_subsystem *subsys;
char *address;
char *transport;
char *state;
char *ana_state;
char *traddr;
char *trsvcid;
char *host_traddr;
char *hostnqn;
char *hostid;
struct nvme_id_ctrl id;
int nr_namespaces;
struct nvme_namespace *namespaces;
};
struct nvme_subsystem {
char *name;
char *subsysnqn;
int nr_ctrls;
struct nvme_ctrl *ctrls;
int nr_namespaces;
struct nvme_namespace *namespaces;
};
struct nvme_topology {
int nr_subsystems;
struct nvme_subsystem *subsystems;
};
#define SYS_NVME "/sys/class/nvme"
void register_extension(struct plugin *plugin);
int parse_and_open(int argc, char **argv, const char *desc,
const struct argconfig_commandline_options *clo);
extern const char *devicename;
extern const char *output_format;
enum nvme_print_flags validate_output_format(const char *format);
int __id_ctrl(int argc, char **argv, struct command *cmd,
struct plugin *plugin, void (*vs)(__u8 *vs, struct json_object *root));
char *nvme_char_from_block(char *block);
void *mmap_registers(const char *dev);
extern int current_index;
int scan_ctrl_namespace_filter(const struct dirent *d);
int scan_namespace_filter(const struct dirent *d);
int scan_ctrl_paths_filter(const struct dirent *d);
int scan_ctrls_filter(const struct dirent *d);
int scan_subsys_filter(const struct dirent *d);
int scan_dev_filter(const struct dirent *d);
int scan_subsystems(struct nvme_topology *t, const char *subsysnqn,
__u32 ns_instance, int nsid, char *dev_dir);
void free_topology(struct nvme_topology *t);
char *get_nvme_subsnqn(char *path);
char *nvme_get_ctrl_attr(const char *path, const char *attr);
void *nvme_alloc(size_t len, bool *huge);
void nvme_free(void *p, bool huge);
int uuid_from_dmi(char *uuid);
int uuid_from_systemd(char *uuid);
unsigned long long elapsed_utime(struct timeval start_time,
struct timeval end_time);
#endif /* _NVME_H */