4 * Main section of the scsi_id program
6 * Copyright (C) IBM Corp. 2003
7 * Copyright (C) SUSE Linux Products GmbH, 2006
10 * Patrick Mansfield<patmans@us.ibm.com>
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation version 2 of the License.
30 #include "../../udev/udev.h"
33 static const struct option options[] = {
34 { "device", required_argument, NULL, 'd' },
35 { "config", required_argument, NULL, 'f' },
36 { "page", required_argument, NULL, 'p' },
37 { "blacklisted", no_argument, NULL, 'b' },
38 { "whitelisted", no_argument, NULL, 'g' },
39 { "replace-whitespace", no_argument, NULL, 'u' },
40 { "sg-version", required_argument, NULL, 's' },
41 { "verbose", no_argument, NULL, 'v' },
42 { "version", no_argument, NULL, 'V' },
43 { "export", no_argument, NULL, 'x' },
44 { "help", no_argument, NULL, 'h' },
48 static const char short_options[] = "d:f:ghip:uvVx";
49 static const char dev_short_options[] = "bgp:";
52 static int dev_specified;
53 static char config_file[MAX_PATH_LEN] = SYSCONFDIR "/scsi_id.config";
54 static enum page_code default_page_code;
55 static int sg_version = 4;
56 static int use_stderr;
58 static int reformat_serial;
60 static char vendor_str[64];
61 static char model_str[64];
62 static char revision_str[16];
63 static char type_str[16];
65 static void log_fn(struct udev *udev, int priority,
66 const char *file, int line, const char *fn,
67 const char *format, va_list args)
69 vsyslog(priority, format, args);
72 static void set_type(const char *from, char *to, size_t len)
76 char *type = "generic";
78 type_num = strtoul(from, &eptr, 0);
106 util_strlcpy(to, type, len);
112 * buf points to an '=' followed by a quoted string ("foo") or a string ending
113 * with a space or ','.
115 * Return a pointer to the NUL terminated string, returns NULL if no
118 static char *get_value(char **buffer)
120 static char *quote_string = "\"\n";
121 static char *comma_string = ",\n";
125 if (**buffer == '"') {
127 * skip leading quote, terminate when quote seen
134 val = strsep(buffer, end);
135 if (val && end == quote_string)
137 * skip trailing quote
141 while (isspace(**buffer))
147 static int argc_count(char *opts)
150 while (*opts != '\0')
159 * If vendor == NULL, find a line in the config file with only "OPTIONS=";
160 * if vendor and model are set find the first OPTIONS line in the config
161 * file that matches. Set argc and argv to match the OPTIONS string.
163 * vendor and model can end in '\n'.
165 static int get_file_options(struct udev *udev,
166 const char *vendor, const char *model,
167 int *argc, char ***newargv)
173 char *vendor_in, *model_in, *options_in; /* read in from file */
178 dbg(udev, "vendor='%s'; model='%s'\n", vendor, model);
179 fd = fopen(config_file, "r");
181 dbg(udev, "can't open %s\n", config_file);
182 if (errno == ENOENT) {
185 err(udev, "can't open %s: %s\n", config_file, strerror(errno));
191 * Allocate a buffer rather than put it on the stack so we can
192 * keep it around to parse any options (any allocated newargv
193 * points into this buffer for its strings).
195 buffer = malloc(MAX_BUFFER_LEN);
197 err(udev, "can't allocate memory\n");
204 vendor_in = model_in = options_in = NULL;
206 buf = fgets(buffer, MAX_BUFFER_LEN, fd);
210 if (buf[strlen(buffer) - 1] != '\n') {
211 err(udev, "Config file line %d too long\n", lineno);
215 while (isspace(*buf))
218 /* blank or all whitespace line */
226 dbg(udev, "lineno %d: '%s'\n", lineno, buf);
227 str1 = strsep(&buf, "=");
228 if (str1 && strcasecmp(str1, "VENDOR") == 0) {
229 str1 = get_value(&buf);
236 str1 = strsep(&buf, "=");
237 if (str1 && strcasecmp(str1, "MODEL") == 0) {
238 str1 = get_value(&buf);
244 str1 = strsep(&buf, "=");
248 if (str1 && strcasecmp(str1, "OPTIONS") == 0) {
249 str1 = get_value(&buf);
256 dbg(udev, "config file line %d:\n"
257 " vendor '%s'; model '%s'; options '%s'\n",
258 lineno, vendor_in, model_in, options_in);
260 * Only allow: [vendor=foo[,model=bar]]options=stuff
262 if (!options_in || (!vendor_in && model_in)) {
263 err(udev, "Error parsing config file line %d '%s'\n", lineno, buffer);
267 if (vendor == NULL) {
268 if (vendor_in == NULL) {
269 dbg(udev, "matched global option\n");
272 } else if ((vendor_in && strncmp(vendor, vendor_in,
273 strlen(vendor_in)) == 0) &&
274 (!model_in || (strncmp(model, model_in,
275 strlen(model_in)) == 0))) {
277 * Matched vendor and optionally model.
279 * Note: a short vendor_in or model_in can
280 * give a partial match (that is FOO
283 dbg(udev, "matched vendor/model\n");
286 dbg(udev, "no match\n");
291 if (vendor_in != NULL || model_in != NULL ||
292 options_in != NULL) {
294 * Something matched. Allocate newargv, and store
295 * values found in options_in.
297 strcpy(buffer, options_in);
298 c = argc_count(buffer) + 2;
299 *newargv = calloc(c, sizeof(**newargv));
301 err(udev, "can't allocate memory\n");
307 * argv[0] at 0 is skipped by getopt, but
308 * store the buffer address there for
311 (*newargv)[c] = buffer;
312 for (c = 1; c < *argc; c++)
313 (*newargv)[c] = strsep(&buffer, " \t");
326 static int set_options(struct udev *udev,
327 int argc, char **argv, const char *short_opts,
333 * optind is a global extern used by getopt. Since we can call
334 * set_options twice (once for command line, and once for config
335 * file) we have to reset this back to 1.
339 option = getopt_long(argc, argv, short_opts, options, NULL);
344 dbg(udev, "option '%c' arg '%s'\n", option, optarg);
346 dbg(udev, "option '%c'\n", option);
355 util_strlcpy(maj_min_dev, optarg, MAX_PATH_LEN);
363 util_strlcpy(config_file, optarg, MAX_PATH_LEN);
371 printf("Usage: scsi_id OPTIONS <device>\n"
372 " --device= device node for SG_IO commands\n"
373 " --config= location of config file\n"
374 " --page=0x80|0x83|pre-spc3-83 SCSI page (0x80, 0x83, pre-spc3-83)\n"
375 " --sg-version=3|4 use SGv3 or SGv4\n"
376 " --blacklisted threat device as blacklisted\n"
377 " --whitelisted threat device as whitelisted\n"
378 " --replace-whitespace replace all whitespaces by underscores\n"
379 " --verbose verbose logging\n"
380 " --version print version\n"
381 " --export print values as environment keys\n"
382 " --help print this help text\n\n");
386 if (strcmp(optarg, "0x80") == 0) {
387 default_page_code = PAGE_80;
388 } else if (strcmp(optarg, "0x83") == 0) {
389 default_page_code = PAGE_83;
390 } else if (strcmp(optarg, "pre-spc3-83") == 0) {
391 default_page_code = PAGE_83_PRE_SPC3;
393 err(udev, "Unknown page code '%s'\n", optarg);
399 sg_version = atoi(optarg);
400 if (sg_version < 3 || sg_version > 4) {
401 err(udev, "Unknown SG version '%s'\n", optarg);
419 printf("%s\n", VERSION);
427 if (optind < argc && !dev_specified) {
429 util_strlcpy(maj_min_dev, argv[optind], MAX_PATH_LEN);
434 static int per_dev_options(struct udev *udev,
435 struct scsi_id_device *dev_scsi, int *good_bad, int *page_code)
439 char **newargv = NULL;
442 *good_bad = all_good;
443 *page_code = default_page_code;
445 retval = get_file_options(udev, vendor_str, model_str, &newargc, &newargv);
447 optind = 1; /* reset this global extern */
448 while (retval == 0) {
449 option = getopt_long(newargc, newargv, dev_short_options, options, NULL);
454 dbg(udev, "option '%c' arg '%s'\n", option, optarg);
456 dbg(udev, "option '%c'\n", option);
468 if (strcmp(optarg, "0x80") == 0) {
469 *page_code = PAGE_80;
470 } else if (strcmp(optarg, "0x83") == 0) {
471 *page_code = PAGE_83;
472 } else if (strcmp(optarg, "pre-spc3-83") == 0) {
473 *page_code = PAGE_83_PRE_SPC3;
475 err(udev, "Unknown page code '%s'\n", optarg);
481 err(udev, "Unknown or bad option '%c' (0x%x)\n", option, option);
494 static int set_inq_values(struct udev *udev, struct scsi_id_device *dev_scsi, const char *path)
498 dev_scsi->use_sg = sg_version;
500 retval = scsi_std_inquiry(udev, dev_scsi, path);
504 udev_util_replace_whitespace(dev_scsi->vendor, vendor_str, sizeof(vendor_str));
505 udev_util_replace_chars(vendor_str, NULL);
506 udev_util_replace_whitespace(dev_scsi->model, model_str, sizeof(model_str));
507 udev_util_replace_chars(model_str, NULL);
508 set_type(dev_scsi->type, type_str, sizeof(type_str));
509 udev_util_replace_whitespace(dev_scsi->revision, revision_str, sizeof(revision_str));
510 udev_util_replace_chars(revision_str, NULL);
515 * format_serial: replace to whitespaces by underscores for calling
516 * programs that use the serial for device naming (multipath, Suse
519 static void format_serial(char *serial)
521 char *p = serial, *q;
526 if (q > serial && q[-1] != '_') {
540 * scsi_id: try to get an id, if one is found, printf it to stdout.
541 * returns a value passed to exit() - 0 if printed an id, else 1.
543 static int scsi_id(struct udev *udev, char *maj_min_dev)
545 struct scsi_id_device dev_scsi;
550 memset(&dev_scsi, 0x00, sizeof(struct scsi_id_device));
552 if (set_inq_values(udev, &dev_scsi, maj_min_dev) < 0) {
557 /* get per device (vendor + model) options from the config file */
558 per_dev_options(udev, &dev_scsi, &good_dev, &page_code);
559 dbg(udev, "per dev options: good %d; page code 0x%x\n", good_dev, page_code);
565 /* read serial number from mode pages (no values for optical drives) */
566 scsi_get_serial(udev, &dev_scsi, maj_min_dev, page_code, MAX_SERIAL_LEN);
569 char serial_str[MAX_SERIAL_LEN];
571 printf("ID_VENDOR=%s\n", vendor_str);
572 printf("ID_MODEL=%s\n", model_str);
573 printf("ID_REVISION=%s\n", revision_str);
574 printf("ID_TYPE=%s\n", type_str);
575 if (dev_scsi.serial[0] != '\0') {
576 udev_util_replace_whitespace(dev_scsi.serial, serial_str, sizeof(serial_str));
577 udev_util_replace_chars(serial_str, NULL);
578 printf("ID_SERIAL=%s\n", serial_str);
579 udev_util_replace_whitespace(dev_scsi.serial_short, serial_str, sizeof(serial_str));
580 udev_util_replace_chars(serial_str, NULL);
581 printf("ID_SERIAL_SHORT=%s\n", serial_str);
586 if (dev_scsi.serial[0] == '\0') {
591 format_serial(dev_scsi.serial);
592 printf("%s\n", dev_scsi.serial);
597 int main(int argc, char **argv)
601 char maj_min_dev[MAX_PATH_LEN];
609 logging_init("scsi_id");
610 udev_set_log_fn(udev, log_fn);
613 * Get config file options.
616 retval = get_file_options(udev, NULL, NULL, &newargc, &newargv);
621 if (newargv && (retval == 0)) {
622 if (set_options(udev, newargc, newargv, short_options, maj_min_dev) < 0) {
630 * Get command line options (overriding any config file settings).
632 if (set_options(udev, argc, argv, short_options, maj_min_dev) < 0)
635 if (!dev_specified) {
636 err(udev, "no device specified\n");
641 retval = scsi_id(udev, maj_min_dev);