2 * Copyright (C) IBM Corp. 2003
3 * Copyright (C) SUSE Linux Products GmbH, 2006
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 #include "libudev-private.h"
35 #include "udev-util.h"
37 static const struct option options
[] = {
38 { "device", required_argument
, NULL
, 'd' },
39 { "config", required_argument
, NULL
, 'f' },
40 { "page", required_argument
, NULL
, 'p' },
41 { "blacklisted", no_argument
, NULL
, 'b' },
42 { "whitelisted", no_argument
, NULL
, 'g' },
43 { "replace-whitespace", no_argument
, NULL
, 'u' },
44 { "sg-version", required_argument
, NULL
, 's' },
45 { "verbose", no_argument
, NULL
, 'v' },
46 { "version", no_argument
, NULL
, 'V' }, /* don't advertise -V */
47 { "export", no_argument
, NULL
, 'x' },
48 { "help", no_argument
, NULL
, 'h' },
52 static bool all_good
= false;
53 static bool dev_specified
= false;
54 static char config_file
[MAX_PATH_LEN
] = "/etc/scsi_id.config";
55 static enum page_code default_page_code
= PAGE_UNSPECIFIED
;
56 static int sg_version
= 4;
57 static bool reformat_serial
= false;
58 static bool export
= false;
59 static char vendor_str
[64];
60 static char model_str
[64];
61 static char vendor_enc_str
[256];
62 static char model_enc_str
[256];
63 static char revision_str
[16];
64 static char type_str
[16];
66 static void set_type(const char *from
, char *to
, size_t len
)
70 const char *type
= "generic";
72 type_num
= strtoul(from
, &eptr
, 0);
100 strscpy(to
, len
, type
);
106 * buf points to an '=' followed by a quoted string ("foo") or a string ending
107 * with a space or ','.
109 * Return a pointer to the NUL terminated string, returns NULL if no
112 static char *get_value(char **buffer
)
114 static const char *quote_string
= "\"\n";
115 static const char *comma_string
= ",\n";
119 if (**buffer
== '"') {
121 * skip leading quote, terminate when quote seen
128 val
= strsep(buffer
, end
);
129 if (val
&& end
== quote_string
)
131 * skip trailing quote
135 while (isspace(**buffer
))
141 static int argc_count(char *opts
)
144 while (*opts
!= '\0')
153 * If vendor == NULL, find a line in the config file with only "OPTIONS=";
154 * if vendor and model are set find the first OPTIONS line in the config
155 * file that matches. Set argc and argv to match the OPTIONS string.
157 * vendor and model can end in '\n'.
159 static int get_file_options(struct udev
*udev
,
160 const char *vendor
, const char *model
,
161 int *argc
, char ***newargv
)
164 _cleanup_fclose_
FILE *f
;
167 char *vendor_in
, *model_in
, *options_in
; /* read in from file */
172 f
= fopen(config_file
, "re");
177 log_error_errno(errno
, "can't open %s: %m", config_file
);
183 * Allocate a buffer rather than put it on the stack so we can
184 * keep it around to parse any options (any allocated newargv
185 * points into this buffer for its strings).
187 buffer
= malloc(MAX_BUFFER_LEN
);
194 vendor_in
= model_in
= options_in
= NULL
;
196 buf
= fgets(buffer
, MAX_BUFFER_LEN
, f
);
200 if (buf
[strlen(buffer
) - 1] != '\n') {
201 log_error("Config file line %d too long", lineno
);
205 while (isspace(*buf
))
208 /* blank or all whitespace line */
216 str1
= strsep(&buf
, "=");
217 if (str1
&& strcaseeq(str1
, "VENDOR")) {
218 str1
= get_value(&buf
);
225 str1
= strsep(&buf
, "=");
226 if (str1
&& strcaseeq(str1
, "MODEL")) {
227 str1
= get_value(&buf
);
233 str1
= strsep(&buf
, "=");
237 if (str1
&& strcaseeq(str1
, "OPTIONS")) {
238 str1
= get_value(&buf
);
247 * Only allow: [vendor=foo[,model=bar]]options=stuff
249 if (!options_in
|| (!vendor_in
&& model_in
)) {
250 log_error("Error parsing config file line %d '%s'", lineno
, buffer
);
254 if (vendor
== NULL
) {
255 if (vendor_in
== NULL
)
257 } else if (vendor_in
&&
258 strneq(vendor
, vendor_in
, strlen(vendor_in
)) &&
260 (strneq(model
, model_in
, strlen(model_in
))))) {
262 * Matched vendor and optionally model.
264 * Note: a short vendor_in or model_in can
265 * give a partial match (that is FOO
273 if (vendor_in
!= NULL
|| model_in
!= NULL
||
274 options_in
!= NULL
) {
276 * Something matched. Allocate newargv, and store
277 * values found in options_in.
279 strcpy(buffer
, options_in
);
280 c
= argc_count(buffer
) + 2;
281 *newargv
= calloc(c
, sizeof(**newargv
));
288 * argv[0] at 0 is skipped by getopt, but
289 * store the buffer address there for
292 (*newargv
)[c
] = buffer
;
293 for (c
= 1; c
< *argc
; c
++)
294 (*newargv
)[c
] = strsep(&buffer
, " \t");
306 static void help(void) {
307 printf("Usage: %s [OPTION...] DEVICE\n\n"
308 "SCSI device identification.\n\n"
309 " -h --help Print this message\n"
310 " --version Print version of the program\n\n"
311 " -d --device= Device node for SG_IO commands\n"
312 " -f --config= Location of config file\n"
313 " -p --page=0x80|0x83|pre-spc3-83 SCSI page (0x80, 0x83, pre-spc3-83)\n"
314 " -s --sg-version=3|4 Use SGv3 or SGv4\n"
315 " -b --blacklisted Treat device as blacklisted\n"
316 " -g --whitelisted Treat device as whitelisted\n"
317 " -u --replace-whitespace Replace all whitespace by underscores\n"
318 " -v --verbose Verbose logging\n"
319 " -x --export Print values as environment keys\n"
320 , program_invocation_short_name
);
324 static int set_options(struct udev
*udev
,
325 int argc
, char **argv
,
331 * optind is a global extern used by getopt. Since we can call
332 * set_options twice (once for command line, and once for config
333 * file) we have to reset this back to 1.
336 while ((option
= getopt_long(argc
, argv
, "d:f:gp:uvVxh", options
, NULL
)) >= 0)
343 dev_specified
= true;
344 strscpy(maj_min_dev
, MAX_PATH_LEN
, optarg
);
348 strscpy(config_file
, MAX_PATH_LEN
, optarg
);
360 if (streq(optarg
, "0x80"))
361 default_page_code
= PAGE_80
;
362 else if (streq(optarg
, "0x83"))
363 default_page_code
= PAGE_83
;
364 else if (streq(optarg
, "pre-spc3-83"))
365 default_page_code
= PAGE_83_PRE_SPC3
;
367 log_error("Unknown page code '%s'", optarg
);
373 sg_version
= atoi(optarg
);
374 if (sg_version
< 3 || sg_version
> 4) {
375 log_error("Unknown SG version '%s'", optarg
);
381 reformat_serial
= true;
385 log_set_target(LOG_TARGET_CONSOLE
);
386 log_set_max_level(LOG_DEBUG
);
391 printf("%s\n", VERSION
);
402 assert_not_reached("Unknown option");
405 if (optind
< argc
&& !dev_specified
) {
406 dev_specified
= true;
407 strscpy(maj_min_dev
, MAX_PATH_LEN
, argv
[optind
]);
413 static int per_dev_options(struct udev
*udev
,
414 struct scsi_id_device
*dev_scsi
, int *good_bad
, int *page_code
)
418 char **newargv
= NULL
;
421 *good_bad
= all_good
;
422 *page_code
= default_page_code
;
424 retval
= get_file_options(udev
, vendor_str
, model_str
, &newargc
, &newargv
);
426 optind
= 1; /* reset this global extern */
427 while (retval
== 0) {
428 option
= getopt_long(newargc
, newargv
, "bgp:", options
, NULL
);
442 if (streq(optarg
, "0x80")) {
443 *page_code
= PAGE_80
;
444 } else if (streq(optarg
, "0x83")) {
445 *page_code
= PAGE_83
;
446 } else if (streq(optarg
, "pre-spc3-83")) {
447 *page_code
= PAGE_83_PRE_SPC3
;
449 log_error("Unknown page code '%s'", optarg
);
455 log_error("Unknown or bad option '%c' (0x%x)", option
, option
);
468 static int set_inq_values(struct udev
*udev
, struct scsi_id_device
*dev_scsi
, const char *path
)
472 dev_scsi
->use_sg
= sg_version
;
474 retval
= scsi_std_inquiry(udev
, dev_scsi
, path
);
478 udev_util_encode_string(dev_scsi
->vendor
, vendor_enc_str
, sizeof(vendor_enc_str
));
479 udev_util_encode_string(dev_scsi
->model
, model_enc_str
, sizeof(model_enc_str
));
481 util_replace_whitespace(dev_scsi
->vendor
, vendor_str
, sizeof(vendor_str
));
482 util_replace_chars(vendor_str
, NULL
);
483 util_replace_whitespace(dev_scsi
->model
, model_str
, sizeof(model_str
));
484 util_replace_chars(model_str
, NULL
);
485 set_type(dev_scsi
->type
, type_str
, sizeof(type_str
));
486 util_replace_whitespace(dev_scsi
->revision
, revision_str
, sizeof(revision_str
));
487 util_replace_chars(revision_str
, NULL
);
492 * scsi_id: try to get an id, if one is found, printf it to stdout.
493 * returns a value passed to exit() - 0 if printed an id, else 1.
495 static int scsi_id(struct udev
*udev
, char *maj_min_dev
)
497 struct scsi_id_device dev_scsi
= {};
502 if (set_inq_values(udev
, &dev_scsi
, maj_min_dev
) < 0) {
507 /* get per device (vendor + model) options from the config file */
508 per_dev_options(udev
, &dev_scsi
, &good_dev
, &page_code
);
514 /* read serial number from mode pages (no values for optical drives) */
515 scsi_get_serial(udev
, &dev_scsi
, maj_min_dev
, page_code
, MAX_SERIAL_LEN
);
518 char serial_str
[MAX_SERIAL_LEN
];
520 printf("ID_SCSI=1\n");
521 printf("ID_VENDOR=%s\n", vendor_str
);
522 printf("ID_VENDOR_ENC=%s\n", vendor_enc_str
);
523 printf("ID_MODEL=%s\n", model_str
);
524 printf("ID_MODEL_ENC=%s\n", model_enc_str
);
525 printf("ID_REVISION=%s\n", revision_str
);
526 printf("ID_TYPE=%s\n", type_str
);
527 if (dev_scsi
.serial
[0] != '\0') {
528 util_replace_whitespace(dev_scsi
.serial
, serial_str
, sizeof(serial_str
));
529 util_replace_chars(serial_str
, NULL
);
530 printf("ID_SERIAL=%s\n", serial_str
);
531 util_replace_whitespace(dev_scsi
.serial_short
, serial_str
, sizeof(serial_str
));
532 util_replace_chars(serial_str
, NULL
);
533 printf("ID_SERIAL_SHORT=%s\n", serial_str
);
535 if (dev_scsi
.wwn
[0] != '\0') {
536 printf("ID_WWN=0x%s\n", dev_scsi
.wwn
);
537 if (dev_scsi
.wwn_vendor_extension
[0] != '\0') {
538 printf("ID_WWN_VENDOR_EXTENSION=0x%s\n", dev_scsi
.wwn_vendor_extension
);
539 printf("ID_WWN_WITH_EXTENSION=0x%s%s\n", dev_scsi
.wwn
, dev_scsi
.wwn_vendor_extension
);
541 printf("ID_WWN_WITH_EXTENSION=0x%s\n", dev_scsi
.wwn
);
543 if (dev_scsi
.tgpt_group
[0] != '\0')
544 printf("ID_TARGET_PORT=%s\n", dev_scsi
.tgpt_group
);
545 if (dev_scsi
.unit_serial_number
[0] != '\0')
546 printf("ID_SCSI_SERIAL=%s\n", dev_scsi
.unit_serial_number
);
550 if (dev_scsi
.serial
[0] == '\0') {
555 if (reformat_serial
) {
556 char serial_str
[MAX_SERIAL_LEN
];
558 util_replace_whitespace(dev_scsi
.serial
, serial_str
, sizeof(serial_str
));
559 util_replace_chars(serial_str
, NULL
);
560 printf("%s\n", serial_str
);
564 printf("%s\n", dev_scsi
.serial
);
569 int main(int argc
, char **argv
)
571 _cleanup_udev_unref_
struct udev
*udev
;
573 char maj_min_dev
[MAX_PATH_LEN
];
575 char **newargv
= NULL
;
577 log_parse_environment();
585 * Get config file options.
587 retval
= get_file_options(udev
, NULL
, NULL
, &newargc
, &newargv
);
595 if (set_options(udev
, newargc
, newargv
, maj_min_dev
) < 0) {
602 * Get command line options (overriding any config file settings).
604 if (set_options(udev
, argc
, argv
, maj_min_dev
) < 0)
607 if (!dev_specified
) {
608 log_error("No device specified.");
613 retval
= scsi_id(udev
, maj_min_dev
);