1/*-
2 * Copyright (c) 2000 Kelly Yancey <kbyanc@posi.net>
3 * Derived from work done by Julian Elischer <julian@tfs.com,
4 * julian@dialix.oz.au>, 1993, and Peter Dufault <dufault@hda.com>, 1994.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef lint
30static const char rcsid[] =
31 "$FreeBSD: head/sbin/camcontrol/modeedit.c 64382 2000-08-08 06:24:17Z kbyanc $";
32#endif /* not lint */
33
34#include <sys/queue.h>
35#include <sys/types.h>
36
37#include <assert.h>
38#include <ctype.h>
39#include <err.h>
40#include <errno.h>
41#include <stdlib.h>
42#include <string.h>
43#include <stdio.h>
44#include <sysexits.h>
45#include <unistd.h>
46
47#include <cam/scsi/scsi_all.h>
48#include <cam/cam.h>
49#include <cam/cam_ccb.h>
50#include <camlib.h>
51#include "camcontrol.h"
52
53int verbose = 0;
54
55#define DEFAULT_SCSI_MODE_DB "/usr/share/misc/scsi_modes"
56#define DEFAULT_EDITOR "vi"
57#define MAX_FORMAT_SPEC 4096 /* Max CDB format specifier. */
58#define MAX_PAGENUM_LEN 10 /* Max characters in page num. */
59#define MAX_PAGENAME_LEN 64 /* Max characters in page name. */
60#define PAGEDEF_START '{' /* Page definition delimiter. */
61#define PAGEDEF_END '}' /* Page definition delimiter. */
62#define PAGENAME_START '"' /* Page name delimiter. */
63#define PAGENAME_END '"' /* Page name delimiter. */
64#define PAGEENTRY_END ';' /* Page entry terminator (optional). */
65#define MAX_COMMAND_SIZE 255 /* Mode/Log sense data buffer size. */
66
67
68/* Macros for working with mode pages. */
69#define MODE_PAGE_HEADER(mh) \
70 (struct scsi_mode_page_header *)find_mode_page_6(mh)
71
72#define MODE_PAGE_DATA(mph) \
73 (u_int8_t *)(mph) + sizeof(struct scsi_mode_page_header)
74
75
76struct editentry {
77 STAILQ_ENTRY(editentry) link;
78 char *name;
79 char type;
80 int editable;
81 int size;
82 union {
83 int ivalue;
84 char *svalue;
85 } value;
86};
87STAILQ_HEAD(, editentry) editlist; /* List of page entries. */
88int editlist_changed = 0; /* Whether any entries were changed. */
89
90struct pagename {
91 SLIST_ENTRY(pagename) link;
92 int pagenum;
93 char *name;
94};
95SLIST_HEAD(, pagename) namelist; /* Page number to name mappings. */
96
97static char format[MAX_FORMAT_SPEC]; /* Buffer for scsi cdb format def. */
98
99static FILE *edit_file = NULL; /* File handle for edit file. */
100static char edit_path[] = "/tmp/camXXXXXX";
101
102
103/* Function prototypes. */
104static void editentry_create(void *hook, int letter, void *arg,
105 int count, char *name);
106static void editentry_update(void *hook, int letter, void *arg,
107 int count, char *name);
108static int editentry_save(void *hook, char *name);
109static struct editentry *editentry_lookup(char *name);
110static int editentry_set(char *name, char *newvalue,
111 int editonly);
112static void editlist_populate(struct cam_device *device,
113 int modepage, int page_control,
114 int dbd, int retries, int timeout);
115static void editlist_save(struct cam_device *device, int modepage,
116 int page_control, int dbd, int retries,
117 int timeout);
118static void nameentry_create(int pagenum, char *name);
119static struct pagename *nameentry_lookup(int pagenum);
120static int load_format(char *pagedb_path, int page);
121static int modepage_write(FILE *file, int editonly);
122static int modepage_read(FILE *file);
123static void modepage_edit(void);
124static void modepage_dump(struct cam_device *device, int page,
125 int page_control, int dbd, int retries,
126 int timeout);
127static void cleanup_editfile(void);
128void mode_edit(struct cam_device *device, int page,
129 int page_control, int dbd, int edit,
130 int binary, int retry_count, int timeout);
131void mode_list(struct cam_device *device, int page_control,
132 int dbd, int retry_count, int timeout);
133
134
135#define returnerr(code) do { \
136 errno = code; \
137 return (-1); \
138} while (0)
139
140
141#define RTRIM(string) do { \
142 register int _length; \
143 while (isspace(string[_length = strlen(string) - 1])) \
144 string[_length] = '\0'; \
145} while (0)
146
147
148static void
149editentry_create(void *hook, int letter, void *arg, int count, char *name)
150{
151 struct editentry *newentry; /* Buffer to hold new entry. */
152
153 /* Allocate memory for the new entry and a copy of the entry name. */
154 if ((newentry = malloc(sizeof(struct editentry))) == NULL ||
155 (newentry->name = strdup(name)) == NULL)
156 err(EX_OSERR, NULL);
157
158 /* Trim any trailing whitespace for the entry name. */
159 RTRIM(newentry->name);
160
161 newentry->editable = (arg != NULL);
162 newentry->type = letter;
163 newentry->size = count; /* Placeholder; not accurate. */
164 newentry->value.svalue = NULL;
165
166 STAILQ_INSERT_TAIL(&editlist, newentry, link);
167}
168
169static void
170editentry_update(void *hook, int letter, void *arg, int count, char *name)
171{
172 struct editentry *dest; /* Buffer to hold entry to update. */
173
174 dest = editentry_lookup(name);
175 assert(dest != NULL);
176
177 dest->type = letter;
178 dest->size = count; /* We get the real size now. */
179
180 switch (dest->type) {
181 case 'i': /* Byte-sized integral type. */
182 case 'b': /* Bit-sized integral types. */
183 case 't':
184 dest->value.ivalue = (intptr_t)arg;
185 break;
186
187 case 'c': /* Character array. */
188 case 'z': /* Null-padded string. */
189 editentry_set(name, (char *)arg, 0);
190 break;
191 default:
192 /* NOTREACHED */
193 }
194}
195
196static int
197editentry_save(void *hook, char *name)
198{
199 struct editentry *src; /* Entry value to save. */
200
201 src = editentry_lookup(name);
202 assert(src != NULL);
203
204 switch (src->type) {
205 case 'i': /* Byte-sized integral type. */
206 case 'b': /* Bit-sized integral types. */
207 case 't':
208 return (src->value.ivalue);
209 /* NOTREACHED */
210
211 case 'c': /* Character array. */
212 case 'z': /* Null-padded string. */
213 return ((intptr_t)src->value.svalue);
214 /* NOTREACHED */
215
216 default:
217 /* NOTREACHED */
218 }
219
220 return (0); /* This should never happen. */
221}
222
223static struct editentry *
224editentry_lookup(char *name)
225{
226 struct editentry *scan;
227
228 assert(name != NULL);
229
230 STAILQ_FOREACH(scan, &editlist, link) {
231 if (strcasecmp(scan->name, name) == 0)
232 return (scan);
233 }
234
235 /* Not found during list traversal. */
236 return (NULL);
237}
238
239static int
240editentry_set(char *name, char *newvalue, int editonly)
241{
242 struct editentry *dest; /* Modepage entry to update. */
243 char *cval; /* Pointer to new string value. */
244 char *convertend; /* End-of-conversion pointer. */
245 int ival; /* New integral value. */
246 int resolution; /* Resolution in bits for integer conversion. */
247
248/*
249 * Macro to determine the maximum value of the given size for the current
250 * resolution.
251 * XXX Lovely x86's optimize out the case of shifting by 32 and gcc doesn't
252 * currently workaround it (even for int64's), so we have to kludge it.
253 */
254#define RESOLUTION_MAX(size) ((resolution * (size) == 32)? \
255 0xffffffff: 1 << (resolution * (size)) - 1)
256
257 assert(newvalue != NULL);
258 if (*newvalue == '\0')
259 return (0); /* Nothing to do. */
260
261 if ((dest = editentry_lookup(name)) == NULL)
262 returnerr(ENOENT);
263 if (!dest->editable && editonly)
264 returnerr(EPERM);
265
266 switch (dest->type) {
267 case 'i': /* Byte-sized integral type. */
268 case 'b': /* Bit-sized integral types. */
269 case 't':
270 /* Convert the value string to an integer. */
271 resolution = (dest->type == 'i')? 8: 1;
272 ival = (int)strtol(newvalue, &convertend, 0);
273 if (*convertend != '\0')
274 returnerr(EINVAL);
275 if (ival > RESOLUTION_MAX(dest->size) || ival < 0) {
276 int newival = (ival < 0)? 0: RESOLUTION_MAX(dest->size);
277 warnx("value %d is out of range for entry %s; clipping "
278 "to %d", ival, name, newival);
279 ival = newival;
280 }
281 if (dest->value.ivalue != ival)
282 editlist_changed = 1;
283 dest->value.ivalue = ival;
284 break;
285
286 case 'c': /* Character array. */
287 case 'z': /* Null-padded string. */
288 if ((cval = malloc(dest->size + 1)) == NULL)
289 err(EX_OSERR, NULL);
290 bzero(cval, dest->size + 1);
291 strncpy(cval, newvalue, dest->size);
292 if (dest->type == 'z') {
293 /* Convert trailing spaces to nulls. */
294 char *convertend;
295
296 for (convertend = cval + dest->size;
297 convertend >= cval; convertend--) {
298 if (*convertend == ' ')
299 *convertend = '\0';
300 else if (*convertend != '\0')
301 break;
302 }
303 }
304 if (strncmp(dest->value.svalue, cval, dest->size) == 0) {
305 /* Nothing changed, free the newly allocated string. */
306 free(cval);
307 break;
308 }
309 if (dest->value.svalue != NULL) {
310 /* Free the current string buffer. */
311 free(dest->value.svalue);
312 dest->value.svalue = NULL;
313 }
314 dest->value.svalue = cval;
315 editlist_changed = 1;
316 break;
317
318 default:
319 /* NOTREACHED */
320 }
321
322 return (0);
323#undef RESOLUTION_MAX
324}
325
326static void
327nameentry_create(int pagenum, char *name) {
328 struct pagename *newentry;
329
330 if (pagenum < 0 || name == NULL || name[0] == '\0')
331 return;
332
333 /* Allocate memory for the new entry and a copy of the entry name. */
334 if ((newentry = malloc(sizeof(struct pagename))) == NULL ||
335 (newentry->name = strdup(name)) == NULL)
336 err(EX_OSERR, NULL);
337
338 /* Trim any trailing whitespace for the page name. */
339 RTRIM(newentry->name);
340
341 newentry->pagenum = pagenum;
342 SLIST_INSERT_HEAD(&namelist, newentry, link);
343}
344
345static struct pagename *
346nameentry_lookup(int pagenum) {
347 struct pagename *scan;
348
349 SLIST_FOREACH(scan, &namelist, link) {
350 if (pagenum == scan->pagenum)
351 return (scan);
352 }
353
354 /* Not found during list traversal. */
355 return (NULL);
356}
357
358static int
359load_format(char *pagedb_path, int page)
360{
361 FILE *pagedb;
362 char str_pagenum[MAX_PAGENUM_LEN];
363 char str_pagename[MAX_PAGENAME_LEN];
364 int pagenum;
365 int depth; /* Quoting depth. */
366 int found;
367 int lineno;
368 enum { LOCATE, PAGENAME, PAGEDEF } state;
369 char c;
370
371#define SETSTATE_LOCATE do { \
372 str_pagenum[0] = '\0'; \
373 str_pagename[0] = '\0'; \
374 pagenum = -1; \
375 state = LOCATE; \
376} while (0)
377
378#define SETSTATE_PAGENAME do { \
379 str_pagename[0] = '\0'; \
380 state = PAGENAME; \
381} while (0)
382
383#define SETSTATE_PAGEDEF do { \
384 format[0] = '\0'; \
385 state = PAGEDEF; \
386} while (0)
387
388#define UPDATE_LINENO do { \
389 if (c == '\n') \
390 lineno++; \
391} while (0)
392
393#define BUFFERFULL(buffer) (strlen(buffer) + 1 >= sizeof(buffer))
394
395 if ((pagedb = fopen(pagedb_path, "r")) == NULL)
396 returnerr(ENOENT);
397
398 SLIST_INIT(&namelist);
399
400 depth = 0;
401 lineno = 0;
402 found = 0;
403 SETSTATE_LOCATE;
404 while ((c = fgetc(pagedb)) != EOF) {
405
406 /* Keep a line count to make error messages more useful. */
407 UPDATE_LINENO;
408
409 /* Skip over comments anywhere in the mode database. */
410 if (c == '#') {
411 do {
412 c = fgetc(pagedb);
413 } while (c != '\n' && c != EOF);
414 UPDATE_LINENO;
415 continue;
416 }
417
418 /* Strip out newline characters. */
419 if (c == '\n')
420 continue;
421
422 /* Keep track of the nesting depth for braces. */
423 if (c == PAGEDEF_START)
424 depth++;
425 else if (c == PAGEDEF_END) {
426 depth--;
427 if (depth < 0) {
428 errx(EX_OSFILE, "%s:%d: %s", pagedb_path,
429 lineno, "mismatched bracket");
430 }
431 }
432
433 switch (state) {
434 case LOCATE:
435 /*
436 * Locate the page the user is interested in, skipping
437 * all others.
438 */
439 if (isspace(c)) {
440 /* Ignore all whitespace between pages. */
441 break;
442 } else if (depth == 0 && c == PAGEENTRY_END) {
443 /*
444 * A page entry terminator will reset page
445 * scanning (useful for assigning names to
446 * modes without providing a mode definition).
447 */
448 /* Record the name of this page. */
449 pagenum = strtol(str_pagenum, NULL, 0);
450 nameentry_create(pagenum, str_pagename);
451 SETSTATE_LOCATE;
452 } else if (depth == 0 && c == PAGENAME_START) {
453 SETSTATE_PAGENAME;
454 } else if (c == PAGEDEF_START) {
455 pagenum = strtol(str_pagenum, NULL, 0);
456 if (depth == 1) {
457 /* Record the name of this page. */
458 nameentry_create(pagenum, str_pagename);
459 /*
460 * Only record the format if this is
461 * the page we are interested in.
462 */
463 if (page == pagenum && !found)
464 SETSTATE_PAGEDEF;
465 }
466 } else if (c == PAGEDEF_END) {
467 /* Reset the processor state. */
468 SETSTATE_LOCATE;
469 } else if (depth == 0 && ! BUFFERFULL(str_pagenum)) {
470 strncat(str_pagenum, &c, 1);
471 } else if (depth == 0) {
472 errx(EX_OSFILE, "%s:%d: %s %d %s", pagedb_path,
473 lineno, "page identifier exceeds",
474 sizeof(str_pagenum) - 1, "characters");
475 }
476 break;
477
478 case PAGENAME:
479 if (c == PAGENAME_END) {
480 /*
481 * Return to LOCATE state without resetting the
482 * page number buffer.
483 */
484 state = LOCATE;
485 } else if (! BUFFERFULL(str_pagename)) {
486 strncat(str_pagename, &c, 1);
487 } else {
488 errx(EX_OSFILE, "%s:%d: %s %d %s", pagedb_path,
489 lineno, "page name exceeds",
490 sizeof(str_pagenum) - 1, "characters");
491 }
492 break;
493
494 case PAGEDEF:
495 /*
496 * Transfer the page definition into a format buffer
497 * suitable for use with CDB encoding/decoding routines.
498 */
499 if (depth == 0) {
500 found = 1;
501 SETSTATE_LOCATE;
502 } else if (! BUFFERFULL(format)) {
503 strncat(format, &c, 1);
504 } else {
505 errx(EX_OSFILE, "%s:%d: %s %d %s", pagedb_path,
506 lineno, "page definition exceeds",
507 sizeof(format) - 1, "characters");
508 }
509 break;
510
511 default:
512 /* NOTREACHED */
513 }
514
515 /* Repeat processing loop with next character. */
516 }
517
518 if (ferror(pagedb))
519 err(EX_OSFILE, "%s", pagedb_path);
520
521 /* Close the SCSI page database. */
522 fclose(pagedb);
523
524 if (!found) /* Never found a matching page. */
525 returnerr(ESRCH);
526
527 return (0);
528}
529
530static void
531editlist_populate(struct cam_device *device, int modepage, int page_control,
532 int dbd, int retries, int timeout)
533{
534 u_int8_t data[MAX_COMMAND_SIZE];/* Buffer to hold sense data. */
535 u_int8_t *mode_pars; /* Pointer to modepage params. */
536 struct scsi_mode_header_6 *mh; /* Location of mode header. */
537 struct scsi_mode_page_header *mph;
538
539 STAILQ_INIT(&editlist);
540
541 /* Fetch changeable values; use to build initial editlist. */
542 mode_sense(device, modepage, 1, dbd, retries, timeout, data,
543 sizeof(data));
544
545 mh = (struct scsi_mode_header_6 *)data;
546 mph = MODE_PAGE_HEADER(mh);
547 mode_pars = MODE_PAGE_DATA(mph);
548
549 /* Decode the value data, creating edit_entries for each value. */
550 buff_decode_visit(mode_pars, mh->data_length, format,
551 editentry_create, 0);
552
553 /* Fetch the current/saved values; use to set editentry values. */
554 mode_sense(device, modepage, page_control, dbd, retries, timeout, data,
555 sizeof(data));
556 buff_decode_visit(mode_pars, mh->data_length, format,
557 editentry_update, 0);
558}
559
560static void
561editlist_save(struct cam_device *device, int modepage, int page_control,
562 int dbd, int retries, int timeout)
563{
564 u_int8_t data[MAX_COMMAND_SIZE];/* Buffer to hold sense data. */
565 u_int8_t *mode_pars; /* Pointer to modepage params. */
566 struct scsi_mode_header_6 *mh; /* Location of mode header. */
567 struct scsi_mode_page_header *mph;
568
569 /* Make sure that something changed before continuing. */
570 if (! editlist_changed)
571 return;
572
573 /*
574 * Preload the CDB buffer with the current mode page data.
575 * XXX If buff_encode_visit would return the number of bytes encoded
576 * we *should* use that to build a header from scratch. As it is
577 * now, we need mode_sense to find out the page length.
578 */
579 mode_sense(device, modepage, page_control, dbd, retries, timeout, data,
580 sizeof(data));
581
582 /* Initial headers & offsets. */
583 mh = (struct scsi_mode_header_6 *)data;
584 mph = MODE_PAGE_HEADER(mh);
585 mode_pars = MODE_PAGE_DATA(mph);
586
587 /* Encode the value data to be passed back to the device. */
588 buff_encode_visit(mode_pars, mh->data_length, format,
589 editentry_save, 0);
590
591 /* Eliminate block descriptors. */
592 bcopy(mph, ((u_int8_t *)mh) + sizeof(*mh),
593 sizeof(*mph) + mph->page_length);
594
595 /* Recalculate headers & offsets. */
596 mh->blk_desc_len = 0; /* No block descriptors. */
597 mh->dev_spec = 0; /* Clear device-specific parameters. */
598 mph = MODE_PAGE_HEADER(mh);
599 mode_pars = MODE_PAGE_DATA(mph);
600
601 mph->page_code &= SMS_PAGE_CODE;/* Isolate just the page code. */
602 mh->data_length = 0; /* Reserved for MODE SELECT command. */
603
604 /*
605 * Write the changes back to the device. If the user editted control
606 * page 3 (saved values) then request the changes be permanently
607 * recorded.
608 */
609 mode_select(device, (page_control == SMS_PAGE_CTRL_SAVED), retries,
610 timeout, (u_int8_t *)mh, sizeof(*mh) + mh->blk_desc_len +
611 sizeof(*mph) + mph->page_length);
612}
613
614static int
615modepage_write(FILE *file, int editonly)
616{
617 struct editentry *scan;
618 int written = 0;
619
620 STAILQ_FOREACH(scan, &editlist, link) {
621 if (scan->editable || !editonly) {
622 written++;
623 if (scan->type == 'c' || scan->type == 'z') {
624 fprintf(file, "%s: %s\n", scan->name,
625 scan->value.svalue);
626 } else {
627 fprintf(file, "%s: %d\n", scan->name,
628 scan->value.ivalue);
629 }
630 }
631 }
632 return (written);
633}
634
635static int
636modepage_read(FILE *file)
637{
638 char *buffer; /* Pointer to dynamic line buffer. */
639 char *line; /* Pointer to static fgetln buffer. */
640 char *name; /* Name portion of the line buffer. */
641 char *value; /* Value portion of line buffer. */
642 int length; /* Length of static fgetln buffer. */
643
644#define ABORT_READ(message, param) do { \
645 warnx(message, param); \
646 free(buffer); \
647 returnerr(EAGAIN); \
648} while (0)
649
650 while ((line = fgetln(file, &length)) != NULL) {
651 /* Trim trailing whitespace (including optional newline). */
652 while (length > 0 && isspace(line[length - 1]))
653 length--;
654
655 /* Allocate a buffer to hold the line + terminating null. */
656 if ((buffer = malloc(length + 1)) == NULL)
657 err(EX_OSERR, NULL);
658 memcpy(buffer, line, length);
659 buffer[length] = '\0';
660
661 /* Strip out comments. */
662 if ((value = strchr(buffer, '#')) != NULL)
663 *value = '\0';
664
665 /* The name is first in the buffer. Trim whitespace.*/
666 name = buffer;
667 RTRIM(name);
668 while (isspace(*name))
669 name++;
670
671 /* Skip empty lines. */
672 if (strlen(name) == 0)
673 continue;
674
675 /* The name ends at the colon; the value starts there. */
676 if ((value = strrchr(buffer, ':')) == NULL)
677 ABORT_READ("no value associated with %s", name);
678 *value = '\0'; /* Null-terminate name. */
679 value++; /* Value starts afterwards. */
680
681 /* Trim leading and trailing whitespace. */
682 RTRIM(value);
683 while (isspace(*value))
684 value++;
685
686 /* Make sure there is a value left. */
687 if (strlen(value) == 0)
688 ABORT_READ("no value associated with %s", name);
689
690 /* Update our in-memory copy of the modepage entry value. */
691 if (editentry_set(name, value, 1) != 0) {
692 if (errno == ENOENT) {
693 /* No entry by the name. */
694 ABORT_READ("no such modepage entry \"%s\"",
695 name);
696 } else if (errno == EINVAL) {
697 /* Invalid value. */
698 ABORT_READ("Invalid value for entry \"%s\"",
699 name);
700 } else if (errno == ERANGE) {
701 /* Value out of range for entry type. */
702 ABORT_READ("value out of range for %s", name);
703 } else if (errno == EPERM) {
704 /* Entry is not editable; not fatal. */
705 warnx("modepage entry \"%s\" is read-only; "
706 "skipping.", name);
707 }
708 }
709
710 free(buffer);
711 }
712 return (ferror(file)? -1: 0);
713
714#undef ABORT_READ
715}
716
717static void
718modepage_edit(void)
719{
720 char *editor;
721 char *commandline;
722 int fd;
723 int written;
724
725 if (!isatty(fileno(stdin))) {
726 /* Not a tty, read changes from stdin. */
727 modepage_read(stdin);
728 return;
729 }
730
731 /* Lookup editor to invoke. */
732 if ((editor = getenv("EDITOR")) == NULL)
733 editor = DEFAULT_EDITOR;
734
735 /* Create temp file for editor to modify. */
736 if ((fd = mkstemp(edit_path)) == -1)
737 errx(EX_CANTCREAT, "mkstemp failed");
738
739 atexit(cleanup_editfile);
740
741 if ((edit_file = fdopen(fd, "w")) == NULL)
742 err(EX_NOINPUT, "%s", edit_path);
743
744 written = modepage_write(edit_file, 1);
745
746 fclose(edit_file);
747 edit_file = NULL;
748
749 if (written == 0) {
750 warnx("no editable entries");
751 cleanup_editfile();
752 return;
753 }
754
755 /*
756 * Allocate memory to hold the command line (the 2 extra characters
757 * are to hold the argument separator (a space), and the terminating
758 * null character.
759 */
760 commandline = malloc(strlen(editor) + strlen(edit_path) + 2);
761 if (commandline == NULL)
762 err(EX_OSERR, NULL);
763 sprintf(commandline, "%s %s", editor, edit_path);
764
765 /* Invoke the editor on the temp file. */
766 if (system(commandline) == -1)
767 err(EX_UNAVAILABLE, "could not invoke %s", editor);
768 free(commandline);
769
770 if ((edit_file = fopen(edit_path, "r")) == NULL)
771 err(EX_NOINPUT, "%s", edit_path);
772
773 /* Read any changes made to the temp file. */
774 modepage_read(edit_file);
775
776 cleanup_editfile();
777}
778
779static void
780modepage_dump(struct cam_device *device, int page, int page_control, int dbd,
781 int retries, int timeout)
782{
783 u_int8_t data[MAX_COMMAND_SIZE];/* Buffer to hold sense data. */
784 u_int8_t *mode_pars; /* Pointer to modepage params. */
785 struct scsi_mode_header_6 *mh; /* Location of mode header. */
786 struct scsi_mode_page_header *mph;
787 int index; /* Index for scanning mode params. */
788
789 mode_sense(device, page, page_control, dbd, retries, timeout, data,
790 sizeof(data));
791
792 mh = (struct scsi_mode_header_6 *)data;
793 mph = MODE_PAGE_HEADER(mh);
794 mode_pars = MODE_PAGE_DATA(mph);
795
796 /* Print the raw mode page data with newlines each 8 bytes. */
797 for (index = 0; index < mph->page_length; index++) {
798 printf("%02x%c",mode_pars[index],
799 (((index + 1) % 8) == 0) ? '\n' : ' ');
800 }
801 putchar('\n');
802}
803
804static void
805cleanup_editfile(void)
806{
807 if (edit_file == NULL)
808 return;
809 if (fclose(edit_file) != 0 || unlink(edit_path) != 0)
810 warn("%s", edit_path);
811 edit_file = NULL;
812}
813
814void
815mode_edit(struct cam_device *device, int page, int page_control, int dbd,
816 int edit, int binary, int retry_count, int timeout)
817{
818 char *pagedb_path; /* Path to modepage database. */
819
820 if (edit && binary)
821 errx(EX_USAGE, "cannot edit in binary mode.");
822
823 if (! binary) {
824 if ((pagedb_path = getenv("SCSI_MODES")) == NULL)
825 pagedb_path = DEFAULT_SCSI_MODE_DB;
826
827 if (load_format(pagedb_path, page) != 0 && (edit || verbose)) {
828 if (errno == ENOENT) {
829 /* Modepage database file not found. */
830 warn("cannot open modepage database \"%s\"",
831 pagedb_path);
832 } else if (errno == ESRCH) {
833 /* Modepage entry not found in database. */
834 warnx("modepage %d not found in database"
835 "\"%s\"", page, pagedb_path);
836 }
837 /* We can recover in display mode, otherwise we exit. */
838 if (!edit) {
839 warnx("reverting to binary display only");
840 binary = 1;
841 } else
842 exit(EX_OSFILE);
843 }
844
845 editlist_populate(device, page, page_control, dbd, retry_count,
846 timeout);
847 }
848
849 if (edit) {
850 if (page_control != SMS_PAGE_CTRL_CURRENT &&
851 page_control != SMS_PAGE_CTRL_SAVED)
852 errx(EX_USAGE, "it only makes sense to edit page 0 "
853 "(current) or page 3 (saved values)");
854 modepage_edit();
855 editlist_save(device, page, page_control, dbd, retry_count,
856 timeout);
857 } else if (binary || STAILQ_EMPTY(&editlist)) {
858 /* Display without formatting information. */
859 modepage_dump(device, page, page_control, dbd, retry_count,
860 timeout);
861 } else {
862 /* Display with format. */
863 modepage_write(stdout, 0);
864 }
865}
866
867void
868mode_list(struct cam_device *device, int page_control, int dbd,
869 int retry_count, int timeout)
870{
871 u_int8_t data[MAX_COMMAND_SIZE];/* Buffer to hold sense data. */
872 u_int8_t *mode_pars; /* Pointer to modepage params. */
873 struct scsi_mode_header_6 *mh; /* Location of mode header. */
874 struct scsi_mode_page_header *mph;
875 struct pagename *nameentry;
876 char *pagedb_path;
877 int len;
878
879 if ((pagedb_path = getenv("SCSI_MODES")) == NULL)
880 pagedb_path = DEFAULT_SCSI_MODE_DB;
881
882 if (load_format(pagedb_path, 0) != 0 && verbose && errno == ENOENT) {
883 /* Modepage database file not found. */
884 warn("cannot open modepage database \"%s\"", pagedb_path);
885 }
886
887 /* Build the list of all mode pages by querying the "all pages" page. */
888 mode_sense(device, SMS_ALL_PAGES_PAGE, page_control, dbd, retry_count,
889 timeout, data, sizeof(data));
890
891 mh = (struct scsi_mode_header_6 *)data;
892 len = mh->blk_desc_len; /* Skip block descriptors. */
893 /* Iterate through the pages in the reply. */
894 while (len < mh->data_length) {
895 /* Locate the next mode page header. */
896 mph = (struct scsi_mode_page_header *)
897 ((intptr_t)mh + sizeof(*mh) + len);
898 mode_pars = MODE_PAGE_DATA(mph);
899
900 mph->page_code &= SMS_PAGE_CODE;
901 nameentry = nameentry_lookup(mph->page_code);
902
903 if (nameentry == NULL || nameentry->name == NULL)
904 printf("0x%02x\n", mph->page_code);
905 else
906 printf("0x%02x\t%s\n", mph->page_code,
907 nameentry->name);
908 len += mph->page_length + sizeof(*mph);
909 }
910}
2 * Copyright (c) 2000 Kelly Yancey <kbyanc@posi.net>
3 * Derived from work done by Julian Elischer <julian@tfs.com,
4 * julian@dialix.oz.au>, 1993, and Peter Dufault <dufault@hda.com>, 1994.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef lint
30static const char rcsid[] =
31 "$FreeBSD: head/sbin/camcontrol/modeedit.c 64382 2000-08-08 06:24:17Z kbyanc $";
32#endif /* not lint */
33
34#include <sys/queue.h>
35#include <sys/types.h>
36
37#include <assert.h>
38#include <ctype.h>
39#include <err.h>
40#include <errno.h>
41#include <stdlib.h>
42#include <string.h>
43#include <stdio.h>
44#include <sysexits.h>
45#include <unistd.h>
46
47#include <cam/scsi/scsi_all.h>
48#include <cam/cam.h>
49#include <cam/cam_ccb.h>
50#include <camlib.h>
51#include "camcontrol.h"
52
53int verbose = 0;
54
55#define DEFAULT_SCSI_MODE_DB "/usr/share/misc/scsi_modes"
56#define DEFAULT_EDITOR "vi"
57#define MAX_FORMAT_SPEC 4096 /* Max CDB format specifier. */
58#define MAX_PAGENUM_LEN 10 /* Max characters in page num. */
59#define MAX_PAGENAME_LEN 64 /* Max characters in page name. */
60#define PAGEDEF_START '{' /* Page definition delimiter. */
61#define PAGEDEF_END '}' /* Page definition delimiter. */
62#define PAGENAME_START '"' /* Page name delimiter. */
63#define PAGENAME_END '"' /* Page name delimiter. */
64#define PAGEENTRY_END ';' /* Page entry terminator (optional). */
65#define MAX_COMMAND_SIZE 255 /* Mode/Log sense data buffer size. */
66
67
68/* Macros for working with mode pages. */
69#define MODE_PAGE_HEADER(mh) \
70 (struct scsi_mode_page_header *)find_mode_page_6(mh)
71
72#define MODE_PAGE_DATA(mph) \
73 (u_int8_t *)(mph) + sizeof(struct scsi_mode_page_header)
74
75
76struct editentry {
77 STAILQ_ENTRY(editentry) link;
78 char *name;
79 char type;
80 int editable;
81 int size;
82 union {
83 int ivalue;
84 char *svalue;
85 } value;
86};
87STAILQ_HEAD(, editentry) editlist; /* List of page entries. */
88int editlist_changed = 0; /* Whether any entries were changed. */
89
90struct pagename {
91 SLIST_ENTRY(pagename) link;
92 int pagenum;
93 char *name;
94};
95SLIST_HEAD(, pagename) namelist; /* Page number to name mappings. */
96
97static char format[MAX_FORMAT_SPEC]; /* Buffer for scsi cdb format def. */
98
99static FILE *edit_file = NULL; /* File handle for edit file. */
100static char edit_path[] = "/tmp/camXXXXXX";
101
102
103/* Function prototypes. */
104static void editentry_create(void *hook, int letter, void *arg,
105 int count, char *name);
106static void editentry_update(void *hook, int letter, void *arg,
107 int count, char *name);
108static int editentry_save(void *hook, char *name);
109static struct editentry *editentry_lookup(char *name);
110static int editentry_set(char *name, char *newvalue,
111 int editonly);
112static void editlist_populate(struct cam_device *device,
113 int modepage, int page_control,
114 int dbd, int retries, int timeout);
115static void editlist_save(struct cam_device *device, int modepage,
116 int page_control, int dbd, int retries,
117 int timeout);
118static void nameentry_create(int pagenum, char *name);
119static struct pagename *nameentry_lookup(int pagenum);
120static int load_format(char *pagedb_path, int page);
121static int modepage_write(FILE *file, int editonly);
122static int modepage_read(FILE *file);
123static void modepage_edit(void);
124static void modepage_dump(struct cam_device *device, int page,
125 int page_control, int dbd, int retries,
126 int timeout);
127static void cleanup_editfile(void);
128void mode_edit(struct cam_device *device, int page,
129 int page_control, int dbd, int edit,
130 int binary, int retry_count, int timeout);
131void mode_list(struct cam_device *device, int page_control,
132 int dbd, int retry_count, int timeout);
133
134
135#define returnerr(code) do { \
136 errno = code; \
137 return (-1); \
138} while (0)
139
140
141#define RTRIM(string) do { \
142 register int _length; \
143 while (isspace(string[_length = strlen(string) - 1])) \
144 string[_length] = '\0'; \
145} while (0)
146
147
148static void
149editentry_create(void *hook, int letter, void *arg, int count, char *name)
150{
151 struct editentry *newentry; /* Buffer to hold new entry. */
152
153 /* Allocate memory for the new entry and a copy of the entry name. */
154 if ((newentry = malloc(sizeof(struct editentry))) == NULL ||
155 (newentry->name = strdup(name)) == NULL)
156 err(EX_OSERR, NULL);
157
158 /* Trim any trailing whitespace for the entry name. */
159 RTRIM(newentry->name);
160
161 newentry->editable = (arg != NULL);
162 newentry->type = letter;
163 newentry->size = count; /* Placeholder; not accurate. */
164 newentry->value.svalue = NULL;
165
166 STAILQ_INSERT_TAIL(&editlist, newentry, link);
167}
168
169static void
170editentry_update(void *hook, int letter, void *arg, int count, char *name)
171{
172 struct editentry *dest; /* Buffer to hold entry to update. */
173
174 dest = editentry_lookup(name);
175 assert(dest != NULL);
176
177 dest->type = letter;
178 dest->size = count; /* We get the real size now. */
179
180 switch (dest->type) {
181 case 'i': /* Byte-sized integral type. */
182 case 'b': /* Bit-sized integral types. */
183 case 't':
184 dest->value.ivalue = (intptr_t)arg;
185 break;
186
187 case 'c': /* Character array. */
188 case 'z': /* Null-padded string. */
189 editentry_set(name, (char *)arg, 0);
190 break;
191 default:
192 /* NOTREACHED */
193 }
194}
195
196static int
197editentry_save(void *hook, char *name)
198{
199 struct editentry *src; /* Entry value to save. */
200
201 src = editentry_lookup(name);
202 assert(src != NULL);
203
204 switch (src->type) {
205 case 'i': /* Byte-sized integral type. */
206 case 'b': /* Bit-sized integral types. */
207 case 't':
208 return (src->value.ivalue);
209 /* NOTREACHED */
210
211 case 'c': /* Character array. */
212 case 'z': /* Null-padded string. */
213 return ((intptr_t)src->value.svalue);
214 /* NOTREACHED */
215
216 default:
217 /* NOTREACHED */
218 }
219
220 return (0); /* This should never happen. */
221}
222
223static struct editentry *
224editentry_lookup(char *name)
225{
226 struct editentry *scan;
227
228 assert(name != NULL);
229
230 STAILQ_FOREACH(scan, &editlist, link) {
231 if (strcasecmp(scan->name, name) == 0)
232 return (scan);
233 }
234
235 /* Not found during list traversal. */
236 return (NULL);
237}
238
239static int
240editentry_set(char *name, char *newvalue, int editonly)
241{
242 struct editentry *dest; /* Modepage entry to update. */
243 char *cval; /* Pointer to new string value. */
244 char *convertend; /* End-of-conversion pointer. */
245 int ival; /* New integral value. */
246 int resolution; /* Resolution in bits for integer conversion. */
247
248/*
249 * Macro to determine the maximum value of the given size for the current
250 * resolution.
251 * XXX Lovely x86's optimize out the case of shifting by 32 and gcc doesn't
252 * currently workaround it (even for int64's), so we have to kludge it.
253 */
254#define RESOLUTION_MAX(size) ((resolution * (size) == 32)? \
255 0xffffffff: 1 << (resolution * (size)) - 1)
256
257 assert(newvalue != NULL);
258 if (*newvalue == '\0')
259 return (0); /* Nothing to do. */
260
261 if ((dest = editentry_lookup(name)) == NULL)
262 returnerr(ENOENT);
263 if (!dest->editable && editonly)
264 returnerr(EPERM);
265
266 switch (dest->type) {
267 case 'i': /* Byte-sized integral type. */
268 case 'b': /* Bit-sized integral types. */
269 case 't':
270 /* Convert the value string to an integer. */
271 resolution = (dest->type == 'i')? 8: 1;
272 ival = (int)strtol(newvalue, &convertend, 0);
273 if (*convertend != '\0')
274 returnerr(EINVAL);
275 if (ival > RESOLUTION_MAX(dest->size) || ival < 0) {
276 int newival = (ival < 0)? 0: RESOLUTION_MAX(dest->size);
277 warnx("value %d is out of range for entry %s; clipping "
278 "to %d", ival, name, newival);
279 ival = newival;
280 }
281 if (dest->value.ivalue != ival)
282 editlist_changed = 1;
283 dest->value.ivalue = ival;
284 break;
285
286 case 'c': /* Character array. */
287 case 'z': /* Null-padded string. */
288 if ((cval = malloc(dest->size + 1)) == NULL)
289 err(EX_OSERR, NULL);
290 bzero(cval, dest->size + 1);
291 strncpy(cval, newvalue, dest->size);
292 if (dest->type == 'z') {
293 /* Convert trailing spaces to nulls. */
294 char *convertend;
295
296 for (convertend = cval + dest->size;
297 convertend >= cval; convertend--) {
298 if (*convertend == ' ')
299 *convertend = '\0';
300 else if (*convertend != '\0')
301 break;
302 }
303 }
304 if (strncmp(dest->value.svalue, cval, dest->size) == 0) {
305 /* Nothing changed, free the newly allocated string. */
306 free(cval);
307 break;
308 }
309 if (dest->value.svalue != NULL) {
310 /* Free the current string buffer. */
311 free(dest->value.svalue);
312 dest->value.svalue = NULL;
313 }
314 dest->value.svalue = cval;
315 editlist_changed = 1;
316 break;
317
318 default:
319 /* NOTREACHED */
320 }
321
322 return (0);
323#undef RESOLUTION_MAX
324}
325
326static void
327nameentry_create(int pagenum, char *name) {
328 struct pagename *newentry;
329
330 if (pagenum < 0 || name == NULL || name[0] == '\0')
331 return;
332
333 /* Allocate memory for the new entry and a copy of the entry name. */
334 if ((newentry = malloc(sizeof(struct pagename))) == NULL ||
335 (newentry->name = strdup(name)) == NULL)
336 err(EX_OSERR, NULL);
337
338 /* Trim any trailing whitespace for the page name. */
339 RTRIM(newentry->name);
340
341 newentry->pagenum = pagenum;
342 SLIST_INSERT_HEAD(&namelist, newentry, link);
343}
344
345static struct pagename *
346nameentry_lookup(int pagenum) {
347 struct pagename *scan;
348
349 SLIST_FOREACH(scan, &namelist, link) {
350 if (pagenum == scan->pagenum)
351 return (scan);
352 }
353
354 /* Not found during list traversal. */
355 return (NULL);
356}
357
358static int
359load_format(char *pagedb_path, int page)
360{
361 FILE *pagedb;
362 char str_pagenum[MAX_PAGENUM_LEN];
363 char str_pagename[MAX_PAGENAME_LEN];
364 int pagenum;
365 int depth; /* Quoting depth. */
366 int found;
367 int lineno;
368 enum { LOCATE, PAGENAME, PAGEDEF } state;
369 char c;
370
371#define SETSTATE_LOCATE do { \
372 str_pagenum[0] = '\0'; \
373 str_pagename[0] = '\0'; \
374 pagenum = -1; \
375 state = LOCATE; \
376} while (0)
377
378#define SETSTATE_PAGENAME do { \
379 str_pagename[0] = '\0'; \
380 state = PAGENAME; \
381} while (0)
382
383#define SETSTATE_PAGEDEF do { \
384 format[0] = '\0'; \
385 state = PAGEDEF; \
386} while (0)
387
388#define UPDATE_LINENO do { \
389 if (c == '\n') \
390 lineno++; \
391} while (0)
392
393#define BUFFERFULL(buffer) (strlen(buffer) + 1 >= sizeof(buffer))
394
395 if ((pagedb = fopen(pagedb_path, "r")) == NULL)
396 returnerr(ENOENT);
397
398 SLIST_INIT(&namelist);
399
400 depth = 0;
401 lineno = 0;
402 found = 0;
403 SETSTATE_LOCATE;
404 while ((c = fgetc(pagedb)) != EOF) {
405
406 /* Keep a line count to make error messages more useful. */
407 UPDATE_LINENO;
408
409 /* Skip over comments anywhere in the mode database. */
410 if (c == '#') {
411 do {
412 c = fgetc(pagedb);
413 } while (c != '\n' && c != EOF);
414 UPDATE_LINENO;
415 continue;
416 }
417
418 /* Strip out newline characters. */
419 if (c == '\n')
420 continue;
421
422 /* Keep track of the nesting depth for braces. */
423 if (c == PAGEDEF_START)
424 depth++;
425 else if (c == PAGEDEF_END) {
426 depth--;
427 if (depth < 0) {
428 errx(EX_OSFILE, "%s:%d: %s", pagedb_path,
429 lineno, "mismatched bracket");
430 }
431 }
432
433 switch (state) {
434 case LOCATE:
435 /*
436 * Locate the page the user is interested in, skipping
437 * all others.
438 */
439 if (isspace(c)) {
440 /* Ignore all whitespace between pages. */
441 break;
442 } else if (depth == 0 && c == PAGEENTRY_END) {
443 /*
444 * A page entry terminator will reset page
445 * scanning (useful for assigning names to
446 * modes without providing a mode definition).
447 */
448 /* Record the name of this page. */
449 pagenum = strtol(str_pagenum, NULL, 0);
450 nameentry_create(pagenum, str_pagename);
451 SETSTATE_LOCATE;
452 } else if (depth == 0 && c == PAGENAME_START) {
453 SETSTATE_PAGENAME;
454 } else if (c == PAGEDEF_START) {
455 pagenum = strtol(str_pagenum, NULL, 0);
456 if (depth == 1) {
457 /* Record the name of this page. */
458 nameentry_create(pagenum, str_pagename);
459 /*
460 * Only record the format if this is
461 * the page we are interested in.
462 */
463 if (page == pagenum && !found)
464 SETSTATE_PAGEDEF;
465 }
466 } else if (c == PAGEDEF_END) {
467 /* Reset the processor state. */
468 SETSTATE_LOCATE;
469 } else if (depth == 0 && ! BUFFERFULL(str_pagenum)) {
470 strncat(str_pagenum, &c, 1);
471 } else if (depth == 0) {
472 errx(EX_OSFILE, "%s:%d: %s %d %s", pagedb_path,
473 lineno, "page identifier exceeds",
474 sizeof(str_pagenum) - 1, "characters");
475 }
476 break;
477
478 case PAGENAME:
479 if (c == PAGENAME_END) {
480 /*
481 * Return to LOCATE state without resetting the
482 * page number buffer.
483 */
484 state = LOCATE;
485 } else if (! BUFFERFULL(str_pagename)) {
486 strncat(str_pagename, &c, 1);
487 } else {
488 errx(EX_OSFILE, "%s:%d: %s %d %s", pagedb_path,
489 lineno, "page name exceeds",
490 sizeof(str_pagenum) - 1, "characters");
491 }
492 break;
493
494 case PAGEDEF:
495 /*
496 * Transfer the page definition into a format buffer
497 * suitable for use with CDB encoding/decoding routines.
498 */
499 if (depth == 0) {
500 found = 1;
501 SETSTATE_LOCATE;
502 } else if (! BUFFERFULL(format)) {
503 strncat(format, &c, 1);
504 } else {
505 errx(EX_OSFILE, "%s:%d: %s %d %s", pagedb_path,
506 lineno, "page definition exceeds",
507 sizeof(format) - 1, "characters");
508 }
509 break;
510
511 default:
512 /* NOTREACHED */
513 }
514
515 /* Repeat processing loop with next character. */
516 }
517
518 if (ferror(pagedb))
519 err(EX_OSFILE, "%s", pagedb_path);
520
521 /* Close the SCSI page database. */
522 fclose(pagedb);
523
524 if (!found) /* Never found a matching page. */
525 returnerr(ESRCH);
526
527 return (0);
528}
529
530static void
531editlist_populate(struct cam_device *device, int modepage, int page_control,
532 int dbd, int retries, int timeout)
533{
534 u_int8_t data[MAX_COMMAND_SIZE];/* Buffer to hold sense data. */
535 u_int8_t *mode_pars; /* Pointer to modepage params. */
536 struct scsi_mode_header_6 *mh; /* Location of mode header. */
537 struct scsi_mode_page_header *mph;
538
539 STAILQ_INIT(&editlist);
540
541 /* Fetch changeable values; use to build initial editlist. */
542 mode_sense(device, modepage, 1, dbd, retries, timeout, data,
543 sizeof(data));
544
545 mh = (struct scsi_mode_header_6 *)data;
546 mph = MODE_PAGE_HEADER(mh);
547 mode_pars = MODE_PAGE_DATA(mph);
548
549 /* Decode the value data, creating edit_entries for each value. */
550 buff_decode_visit(mode_pars, mh->data_length, format,
551 editentry_create, 0);
552
553 /* Fetch the current/saved values; use to set editentry values. */
554 mode_sense(device, modepage, page_control, dbd, retries, timeout, data,
555 sizeof(data));
556 buff_decode_visit(mode_pars, mh->data_length, format,
557 editentry_update, 0);
558}
559
560static void
561editlist_save(struct cam_device *device, int modepage, int page_control,
562 int dbd, int retries, int timeout)
563{
564 u_int8_t data[MAX_COMMAND_SIZE];/* Buffer to hold sense data. */
565 u_int8_t *mode_pars; /* Pointer to modepage params. */
566 struct scsi_mode_header_6 *mh; /* Location of mode header. */
567 struct scsi_mode_page_header *mph;
568
569 /* Make sure that something changed before continuing. */
570 if (! editlist_changed)
571 return;
572
573 /*
574 * Preload the CDB buffer with the current mode page data.
575 * XXX If buff_encode_visit would return the number of bytes encoded
576 * we *should* use that to build a header from scratch. As it is
577 * now, we need mode_sense to find out the page length.
578 */
579 mode_sense(device, modepage, page_control, dbd, retries, timeout, data,
580 sizeof(data));
581
582 /* Initial headers & offsets. */
583 mh = (struct scsi_mode_header_6 *)data;
584 mph = MODE_PAGE_HEADER(mh);
585 mode_pars = MODE_PAGE_DATA(mph);
586
587 /* Encode the value data to be passed back to the device. */
588 buff_encode_visit(mode_pars, mh->data_length, format,
589 editentry_save, 0);
590
591 /* Eliminate block descriptors. */
592 bcopy(mph, ((u_int8_t *)mh) + sizeof(*mh),
593 sizeof(*mph) + mph->page_length);
594
595 /* Recalculate headers & offsets. */
596 mh->blk_desc_len = 0; /* No block descriptors. */
597 mh->dev_spec = 0; /* Clear device-specific parameters. */
598 mph = MODE_PAGE_HEADER(mh);
599 mode_pars = MODE_PAGE_DATA(mph);
600
601 mph->page_code &= SMS_PAGE_CODE;/* Isolate just the page code. */
602 mh->data_length = 0; /* Reserved for MODE SELECT command. */
603
604 /*
605 * Write the changes back to the device. If the user editted control
606 * page 3 (saved values) then request the changes be permanently
607 * recorded.
608 */
609 mode_select(device, (page_control == SMS_PAGE_CTRL_SAVED), retries,
610 timeout, (u_int8_t *)mh, sizeof(*mh) + mh->blk_desc_len +
611 sizeof(*mph) + mph->page_length);
612}
613
614static int
615modepage_write(FILE *file, int editonly)
616{
617 struct editentry *scan;
618 int written = 0;
619
620 STAILQ_FOREACH(scan, &editlist, link) {
621 if (scan->editable || !editonly) {
622 written++;
623 if (scan->type == 'c' || scan->type == 'z') {
624 fprintf(file, "%s: %s\n", scan->name,
625 scan->value.svalue);
626 } else {
627 fprintf(file, "%s: %d\n", scan->name,
628 scan->value.ivalue);
629 }
630 }
631 }
632 return (written);
633}
634
635static int
636modepage_read(FILE *file)
637{
638 char *buffer; /* Pointer to dynamic line buffer. */
639 char *line; /* Pointer to static fgetln buffer. */
640 char *name; /* Name portion of the line buffer. */
641 char *value; /* Value portion of line buffer. */
642 int length; /* Length of static fgetln buffer. */
643
644#define ABORT_READ(message, param) do { \
645 warnx(message, param); \
646 free(buffer); \
647 returnerr(EAGAIN); \
648} while (0)
649
650 while ((line = fgetln(file, &length)) != NULL) {
651 /* Trim trailing whitespace (including optional newline). */
652 while (length > 0 && isspace(line[length - 1]))
653 length--;
654
655 /* Allocate a buffer to hold the line + terminating null. */
656 if ((buffer = malloc(length + 1)) == NULL)
657 err(EX_OSERR, NULL);
658 memcpy(buffer, line, length);
659 buffer[length] = '\0';
660
661 /* Strip out comments. */
662 if ((value = strchr(buffer, '#')) != NULL)
663 *value = '\0';
664
665 /* The name is first in the buffer. Trim whitespace.*/
666 name = buffer;
667 RTRIM(name);
668 while (isspace(*name))
669 name++;
670
671 /* Skip empty lines. */
672 if (strlen(name) == 0)
673 continue;
674
675 /* The name ends at the colon; the value starts there. */
676 if ((value = strrchr(buffer, ':')) == NULL)
677 ABORT_READ("no value associated with %s", name);
678 *value = '\0'; /* Null-terminate name. */
679 value++; /* Value starts afterwards. */
680
681 /* Trim leading and trailing whitespace. */
682 RTRIM(value);
683 while (isspace(*value))
684 value++;
685
686 /* Make sure there is a value left. */
687 if (strlen(value) == 0)
688 ABORT_READ("no value associated with %s", name);
689
690 /* Update our in-memory copy of the modepage entry value. */
691 if (editentry_set(name, value, 1) != 0) {
692 if (errno == ENOENT) {
693 /* No entry by the name. */
694 ABORT_READ("no such modepage entry \"%s\"",
695 name);
696 } else if (errno == EINVAL) {
697 /* Invalid value. */
698 ABORT_READ("Invalid value for entry \"%s\"",
699 name);
700 } else if (errno == ERANGE) {
701 /* Value out of range for entry type. */
702 ABORT_READ("value out of range for %s", name);
703 } else if (errno == EPERM) {
704 /* Entry is not editable; not fatal. */
705 warnx("modepage entry \"%s\" is read-only; "
706 "skipping.", name);
707 }
708 }
709
710 free(buffer);
711 }
712 return (ferror(file)? -1: 0);
713
714#undef ABORT_READ
715}
716
717static void
718modepage_edit(void)
719{
720 char *editor;
721 char *commandline;
722 int fd;
723 int written;
724
725 if (!isatty(fileno(stdin))) {
726 /* Not a tty, read changes from stdin. */
727 modepage_read(stdin);
728 return;
729 }
730
731 /* Lookup editor to invoke. */
732 if ((editor = getenv("EDITOR")) == NULL)
733 editor = DEFAULT_EDITOR;
734
735 /* Create temp file for editor to modify. */
736 if ((fd = mkstemp(edit_path)) == -1)
737 errx(EX_CANTCREAT, "mkstemp failed");
738
739 atexit(cleanup_editfile);
740
741 if ((edit_file = fdopen(fd, "w")) == NULL)
742 err(EX_NOINPUT, "%s", edit_path);
743
744 written = modepage_write(edit_file, 1);
745
746 fclose(edit_file);
747 edit_file = NULL;
748
749 if (written == 0) {
750 warnx("no editable entries");
751 cleanup_editfile();
752 return;
753 }
754
755 /*
756 * Allocate memory to hold the command line (the 2 extra characters
757 * are to hold the argument separator (a space), and the terminating
758 * null character.
759 */
760 commandline = malloc(strlen(editor) + strlen(edit_path) + 2);
761 if (commandline == NULL)
762 err(EX_OSERR, NULL);
763 sprintf(commandline, "%s %s", editor, edit_path);
764
765 /* Invoke the editor on the temp file. */
766 if (system(commandline) == -1)
767 err(EX_UNAVAILABLE, "could not invoke %s", editor);
768 free(commandline);
769
770 if ((edit_file = fopen(edit_path, "r")) == NULL)
771 err(EX_NOINPUT, "%s", edit_path);
772
773 /* Read any changes made to the temp file. */
774 modepage_read(edit_file);
775
776 cleanup_editfile();
777}
778
779static void
780modepage_dump(struct cam_device *device, int page, int page_control, int dbd,
781 int retries, int timeout)
782{
783 u_int8_t data[MAX_COMMAND_SIZE];/* Buffer to hold sense data. */
784 u_int8_t *mode_pars; /* Pointer to modepage params. */
785 struct scsi_mode_header_6 *mh; /* Location of mode header. */
786 struct scsi_mode_page_header *mph;
787 int index; /* Index for scanning mode params. */
788
789 mode_sense(device, page, page_control, dbd, retries, timeout, data,
790 sizeof(data));
791
792 mh = (struct scsi_mode_header_6 *)data;
793 mph = MODE_PAGE_HEADER(mh);
794 mode_pars = MODE_PAGE_DATA(mph);
795
796 /* Print the raw mode page data with newlines each 8 bytes. */
797 for (index = 0; index < mph->page_length; index++) {
798 printf("%02x%c",mode_pars[index],
799 (((index + 1) % 8) == 0) ? '\n' : ' ');
800 }
801 putchar('\n');
802}
803
804static void
805cleanup_editfile(void)
806{
807 if (edit_file == NULL)
808 return;
809 if (fclose(edit_file) != 0 || unlink(edit_path) != 0)
810 warn("%s", edit_path);
811 edit_file = NULL;
812}
813
814void
815mode_edit(struct cam_device *device, int page, int page_control, int dbd,
816 int edit, int binary, int retry_count, int timeout)
817{
818 char *pagedb_path; /* Path to modepage database. */
819
820 if (edit && binary)
821 errx(EX_USAGE, "cannot edit in binary mode.");
822
823 if (! binary) {
824 if ((pagedb_path = getenv("SCSI_MODES")) == NULL)
825 pagedb_path = DEFAULT_SCSI_MODE_DB;
826
827 if (load_format(pagedb_path, page) != 0 && (edit || verbose)) {
828 if (errno == ENOENT) {
829 /* Modepage database file not found. */
830 warn("cannot open modepage database \"%s\"",
831 pagedb_path);
832 } else if (errno == ESRCH) {
833 /* Modepage entry not found in database. */
834 warnx("modepage %d not found in database"
835 "\"%s\"", page, pagedb_path);
836 }
837 /* We can recover in display mode, otherwise we exit. */
838 if (!edit) {
839 warnx("reverting to binary display only");
840 binary = 1;
841 } else
842 exit(EX_OSFILE);
843 }
844
845 editlist_populate(device, page, page_control, dbd, retry_count,
846 timeout);
847 }
848
849 if (edit) {
850 if (page_control != SMS_PAGE_CTRL_CURRENT &&
851 page_control != SMS_PAGE_CTRL_SAVED)
852 errx(EX_USAGE, "it only makes sense to edit page 0 "
853 "(current) or page 3 (saved values)");
854 modepage_edit();
855 editlist_save(device, page, page_control, dbd, retry_count,
856 timeout);
857 } else if (binary || STAILQ_EMPTY(&editlist)) {
858 /* Display without formatting information. */
859 modepage_dump(device, page, page_control, dbd, retry_count,
860 timeout);
861 } else {
862 /* Display with format. */
863 modepage_write(stdout, 0);
864 }
865}
866
867void
868mode_list(struct cam_device *device, int page_control, int dbd,
869 int retry_count, int timeout)
870{
871 u_int8_t data[MAX_COMMAND_SIZE];/* Buffer to hold sense data. */
872 u_int8_t *mode_pars; /* Pointer to modepage params. */
873 struct scsi_mode_header_6 *mh; /* Location of mode header. */
874 struct scsi_mode_page_header *mph;
875 struct pagename *nameentry;
876 char *pagedb_path;
877 int len;
878
879 if ((pagedb_path = getenv("SCSI_MODES")) == NULL)
880 pagedb_path = DEFAULT_SCSI_MODE_DB;
881
882 if (load_format(pagedb_path, 0) != 0 && verbose && errno == ENOENT) {
883 /* Modepage database file not found. */
884 warn("cannot open modepage database \"%s\"", pagedb_path);
885 }
886
887 /* Build the list of all mode pages by querying the "all pages" page. */
888 mode_sense(device, SMS_ALL_PAGES_PAGE, page_control, dbd, retry_count,
889 timeout, data, sizeof(data));
890
891 mh = (struct scsi_mode_header_6 *)data;
892 len = mh->blk_desc_len; /* Skip block descriptors. */
893 /* Iterate through the pages in the reply. */
894 while (len < mh->data_length) {
895 /* Locate the next mode page header. */
896 mph = (struct scsi_mode_page_header *)
897 ((intptr_t)mh + sizeof(*mh) + len);
898 mode_pars = MODE_PAGE_DATA(mph);
899
900 mph->page_code &= SMS_PAGE_CODE;
901 nameentry = nameentry_lookup(mph->page_code);
902
903 if (nameentry == NULL || nameentry->name == NULL)
904 printf("0x%02x\n", mph->page_code);
905 else
906 printf("0x%02x\t%s\n", mph->page_code,
907 nameentry->name);
908 len += mph->page_length + sizeof(*mph);
909 }
910}