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.
31 #include "libudev-private.h"
34 static const struct option options[] = {
35 { "device", required_argument, NULL, 'd' },
36 { "config", required_argument, NULL, 'f' },
37 { "page", required_argument, NULL, 'p' },
38 { "blacklisted", no_argument, NULL, 'b' },
39 { "whitelisted", no_argument, NULL, 'g' },
40 { "replace-whitespace", no_argument, NULL, 'u' },
41 { "sg-version", required_argument, NULL, 's' },
42 { "verbose", no_argument, NULL, 'v' },
43 { "version", no_argument, NULL, 'V' },
44 { "export", no_argument, NULL, 'x' },
45 { "help", no_argument, NULL, 'h' },
49 static const char short_options[] = "d:f:ghip:uvVx";
50 static const char dev_short_options[] = "bgp:";
53 static int dev_specified;
54 static char config_file[MAX_PATH_LEN] = SYSCONFDIR "/scsi_id.config";
55 static enum page_code default_page_code;
56 static int sg_version = 4;
57 static int use_stderr;
59 static int reformat_serial;
61 static char vendor_str[64];
62 static char model_str[64];
63 static char vendor_enc_str[256];
64 static char model_enc_str[256];
65 static char revision_str[16];
66 static char type_str[16];
68 static void log_fn(struct udev *udev, int priority,
69 const char *file, int line, const char *fn,
70 const char *format, va_list args)
72 vsyslog(priority, format, args);
75 static void set_type(const char *from, char *to, size_t len)
79 char *type = "generic";
81 type_num = strtoul(from, &eptr, 0);
109 util_strscpy(to, len, type);
115 * buf points to an '=' followed by a quoted string ("foo") or a string ending
116 * with a space or ','.
118 * Return a pointer to the NUL terminated string, returns NULL if no
121 static char *get_value(char **buffer)
123 static char *quote_string = "\"\n";
124 static char *comma_string = ",\n";
128 if (**buffer == '"') {
130 * skip leading quote, terminate when quote seen
137 val = strsep(buffer, end);
138 if (val && end == quote_string)
140 * skip trailing quote
144 while (isspace(**buffer))
150 static int argc_count(char *opts)
153 while (*opts != '\0')
162 * If vendor == NULL, find a line in the config file with only "OPTIONS=";
163 * if vendor and model are set find the first OPTIONS line in the config
164 * file that matches. Set argc and argv to match the OPTIONS string.
166 * vendor and model can end in '\n'.
168 static int get_file_options(struct udev *udev,
169 const char *vendor, const char *model,
170 int *argc, char ***newargv)
176 char *vendor_in, *model_in, *options_in; /* read in from file */
181 dbg(udev, "vendor='%s'; model='%s'\n", vendor, model);
182 fd = fopen(config_file, "r");
184 dbg(udev, "can't open %s\n", config_file);
185 if (errno == ENOENT) {
188 err(udev, "can't open %s: %s\n", config_file, strerror(errno));
194 * Allocate a buffer rather than put it on the stack so we can
195 * keep it around to parse any options (any allocated newargv
196 * points into this buffer for its strings).
198 buffer = malloc(MAX_BUFFER_LEN);
200 err(udev, "can't allocate memory\n");
207 vendor_in = model_in = options_in = NULL;
209 buf = fgets(buffer, MAX_BUFFER_LEN, fd);
213 if (buf[strlen(buffer) - 1] != '\n') {
214 err(udev, "Config file line %d too long\n", lineno);
218 while (isspace(*buf))
221 /* blank or all whitespace line */
229 dbg(udev, "lineno %d: '%s'\n", lineno, buf);
230 str1 = strsep(&buf, "=");
231 if (str1 && strcasecmp(str1, "VENDOR") == 0) {
232 str1 = get_value(&buf);
239 str1 = strsep(&buf, "=");
240 if (str1 && strcasecmp(str1, "MODEL") == 0) {
241 str1 = get_value(&buf);
247 str1 = strsep(&buf, "=");
251 if (str1 && strcasecmp(str1, "OPTIONS") == 0) {
252 str1 = get_value(&buf);
259 dbg(udev, "config file line %d:\n"
260 " vendor '%s'; model '%s'; options '%s'\n",
261 lineno, vendor_in, model_in, options_in);
263 * Only allow: [vendor=foo[,model=bar]]options=stuff
265 if (!options_in || (!vendor_in && model_in)) {
266 err(udev, "Error parsing config file line %d '%s'\n", lineno, buffer);
270 if (vendor == NULL) {
271 if (vendor_in == NULL) {
272 dbg(udev, "matched global option\n");
275 } else if ((vendor_in && strncmp(vendor, vendor_in,
276 strlen(vendor_in)) == 0) &&
277 (!model_in || (strncmp(model, model_in,
278 strlen(model_in)) == 0))) {
280 * Matched vendor and optionally model.
282 * Note: a short vendor_in or model_in can
283 * give a partial match (that is FOO
286 dbg(udev, "matched vendor/model\n");
289 dbg(udev, "no match\n");
294 if (vendor_in != NULL || model_in != NULL ||
295 options_in != NULL) {
297 * Something matched. Allocate newargv, and store
298 * values found in options_in.
300 strcpy(buffer, options_in);
301 c = argc_count(buffer) + 2;
302 *newargv = calloc(c, sizeof(**newargv));
304 err(udev, "can't allocate memory\n");
310 * argv[0] at 0 is skipped by getopt, but
311 * store the buffer address there for
314 (*newargv)[c] = buffer;
315 for (c = 1; c < *argc; c++)
316 (*newargv)[c] = strsep(&buffer, " \t");
329 static int set_options(struct udev *udev,
330 int argc, char **argv, const char *short_opts,
336 * optind is a global extern used by getopt. Since we can call
337 * set_options twice (once for command line, and once for config
338 * file) we have to reset this back to 1.
342 option = getopt_long(argc, argv, short_opts, options, NULL);
347 dbg(udev, "option '%c' arg '%s'\n", option, optarg);
349 dbg(udev, "option '%c'\n", option);
358 util_strscpy(maj_min_dev, MAX_PATH_LEN, optarg);
366 util_strscpy(config_file, MAX_PATH_LEN, optarg);
374 printf("Usage: scsi_id OPTIONS <device>\n"
375 " --device= device node for SG_IO commands\n"
376 " --config= location of config file\n"
377 " --page=0x80|0x83|pre-spc3-83 SCSI page (0x80, 0x83, pre-spc3-83)\n"
378 " --sg-version=3|4 use SGv3 or SGv4\n"
379 " --blacklisted threat device as blacklisted\n"
380 " --whitelisted threat device as whitelisted\n"
381 " --replace-whitespace replace all whitespaces by underscores\n"
382 " --verbose verbose logging\n"
383 " --version print version\n"
384 " --export print values as environment keys\n"
385 " --help print this help text\n\n");
389 if (strcmp(optarg, "0x80") == 0) {
390 default_page_code = PAGE_80;
391 } else if (strcmp(optarg, "0x83") == 0) {
392 default_page_code = PAGE_83;
393 } else if (strcmp(optarg, "pre-spc3-83") == 0) {
394 default_page_code = PAGE_83_PRE_SPC3;
396 err(udev, "Unknown page code '%s'\n", optarg);
402 sg_version = atoi(optarg);
403 if (sg_version < 3 || sg_version > 4) {
404 err(udev, "Unknown SG version '%s'\n", optarg);
422 printf("%s\n", VERSION);
430 if (optind < argc && !dev_specified) {
432 util_strscpy(maj_min_dev, MAX_PATH_LEN, argv[optind]);
437 static int per_dev_options(struct udev *udev,
438 struct scsi_id_device *dev_scsi, int *good_bad, int *page_code)
442 char **newargv = NULL;
445 *good_bad = all_good;
446 *page_code = default_page_code;
448 retval = get_file_options(udev, vendor_str, model_str, &newargc, &newargv);
450 optind = 1; /* reset this global extern */
451 while (retval == 0) {
452 option = getopt_long(newargc, newargv, dev_short_options, options, NULL);
457 dbg(udev, "option '%c' arg '%s'\n", option, optarg);
459 dbg(udev, "option '%c'\n", option);
471 if (strcmp(optarg, "0x80") == 0) {
472 *page_code = PAGE_80;
473 } else if (strcmp(optarg, "0x83") == 0) {
474 *page_code = PAGE_83;
475 } else if (strcmp(optarg, "pre-spc3-83") == 0) {
476 *page_code = PAGE_83_PRE_SPC3;
478 err(udev, "Unknown page code '%s'\n", optarg);
484 err(udev, "Unknown or bad option '%c' (0x%x)\n", option, option);
497 static int set_inq_values(struct udev *udev, struct scsi_id_device *dev_scsi, const char *path)
501 dev_scsi->use_sg = sg_version;
503 retval = scsi_std_inquiry(udev, dev_scsi, path);
507 udev_util_encode_string(dev_scsi->vendor, vendor_enc_str, sizeof(vendor_enc_str));
508 udev_util_encode_string(dev_scsi->model, model_enc_str, sizeof(model_enc_str));
510 udev_util_replace_whitespace(dev_scsi->vendor, vendor_str, sizeof(vendor_str));
511 udev_util_replace_chars(vendor_str, NULL);
512 udev_util_replace_whitespace(dev_scsi->model, model_str, sizeof(model_str));
513 udev_util_replace_chars(model_str, NULL);
514 set_type(dev_scsi->type, type_str, sizeof(type_str));
515 udev_util_replace_whitespace(dev_scsi->revision, revision_str, sizeof(revision_str));
516 udev_util_replace_chars(revision_str, NULL);
521 * scsi_id: try to get an id, if one is found, printf it to stdout.
522 * returns a value passed to exit() - 0 if printed an id, else 1.
524 static int scsi_id(struct udev *udev, char *maj_min_dev)
526 struct scsi_id_device dev_scsi;
531 memset(&dev_scsi, 0x00, sizeof(struct scsi_id_device));
533 if (set_inq_values(udev, &dev_scsi, maj_min_dev) < 0) {
538 /* get per device (vendor + model) options from the config file */
539 per_dev_options(udev, &dev_scsi, &good_dev, &page_code);
540 dbg(udev, "per dev options: good %d; page code 0x%x\n", good_dev, page_code);
546 /* read serial number from mode pages (no values for optical drives) */
547 scsi_get_serial(udev, &dev_scsi, maj_min_dev, page_code, MAX_SERIAL_LEN);
550 char serial_str[MAX_SERIAL_LEN];
552 printf("ID_SCSI=1\n");
553 printf("ID_VENDOR=%s\n", vendor_str);
554 printf("ID_VENDOR_ENC=%s\n", vendor_enc_str);
555 printf("ID_MODEL=%s\n", model_str);
556 printf("ID_MODEL_ENC=%s\n", model_enc_str);
557 printf("ID_REVISION=%s\n", revision_str);
558 printf("ID_TYPE=%s\n", type_str);
559 if (dev_scsi.serial[0] != '\0') {
560 udev_util_replace_whitespace(dev_scsi.serial, serial_str, sizeof(serial_str));
561 udev_util_replace_chars(serial_str, NULL);
562 printf("ID_SERIAL=%s\n", serial_str);
563 udev_util_replace_whitespace(dev_scsi.serial_short, serial_str, sizeof(serial_str));
564 udev_util_replace_chars(serial_str, NULL);
565 printf("ID_SERIAL_SHORT=%s\n", serial_str);
567 if (dev_scsi.wwn[0] != '\0') {
568 printf("ID_WWN=0x%s\n", dev_scsi.wwn);
570 if (dev_scsi.unit_serial_number[0] != '\0') {
571 printf("ID_SCSI_SERIAL=%s\n", dev_scsi.unit_serial_number);
576 if (dev_scsi.serial[0] == '\0') {
581 if (reformat_serial) {
582 char serial_str[MAX_SERIAL_LEN];
584 udev_util_replace_whitespace(dev_scsi.serial, serial_str, sizeof(serial_str));
585 udev_util_replace_chars(serial_str, NULL);
586 printf("%s\n", serial_str);
590 printf("%s\n", dev_scsi.serial);
595 int main(int argc, char **argv)
599 char maj_min_dev[MAX_PATH_LEN];
607 udev_log_init("scsi_id");
608 udev_set_log_fn(udev, log_fn);
611 * Get config file options.
614 retval = get_file_options(udev, NULL, NULL, &newargc, &newargv);
619 if (newargv && (retval == 0)) {
620 if (set_options(udev, newargc, newargv, short_options, maj_min_dev) < 0) {
628 * Get command line options (overriding any config file settings).
630 if (set_options(udev, argc, argv, short_options, maj_min_dev) < 0)
633 if (!dev_specified) {
634 err(udev, "no device specified\n");
639 retval = scsi_id(udev, maj_min_dev);