xref: /freebsd/sys/cam/cam.c (revision 396c556d77189a5c474d35cec6f44a762e310b7d)
1 /*-
2  * Generic utility routines for the Common Access Method layer.
3  *
4  * Copyright (c) 1997 Justin T. Gibbs.
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. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #ifdef _KERNEL
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/sysctl.h>
37 #else /* _KERNEL */
38 #include <stdlib.h>
39 #include <stdio.h>
40 #include <string.h>
41 #include <camlib.h>
42 #endif /* _KERNEL */
43 
44 #include <cam/cam.h>
45 #include <cam/cam_ccb.h>
46 #include <cam/scsi/scsi_all.h>
47 #include <cam/scsi/smp_all.h>
48 #include <sys/sbuf.h>
49 
50 #ifdef _KERNEL
51 #include <sys/libkern.h>
52 #include <cam/cam_queue.h>
53 #include <cam/cam_xpt.h>
54 
55 FEATURE(scbus, "SCSI devices support");
56 
57 #endif
58 
59 static int	camstatusentrycomp(const void *key, const void *member);
60 
61 const struct cam_status_entry cam_status_table[] = {
62 	{ CAM_REQ_INPROG,	 "CCB request is in progress"		     },
63 	{ CAM_REQ_CMP,		 "CCB request completed without error"	     },
64 	{ CAM_REQ_ABORTED,	 "CCB request aborted by the host"	     },
65 	{ CAM_UA_ABORT,		 "Unable to abort CCB request"		     },
66 	{ CAM_REQ_CMP_ERR,	 "CCB request completed with an error"	     },
67 	{ CAM_BUSY,		 "CAM subsystem is busy"		     },
68 	{ CAM_REQ_INVALID,	 "CCB request was invalid"		     },
69 	{ CAM_PATH_INVALID,	 "Supplied Path ID is invalid"		     },
70 	{ CAM_DEV_NOT_THERE,	 "Device Not Present"			     },
71 	{ CAM_UA_TERMIO,	 "Unable to terminate I/O CCB request"	     },
72 	{ CAM_SEL_TIMEOUT,	 "Selection Timeout"			     },
73 	{ CAM_CMD_TIMEOUT,	 "Command timeout"			     },
74 	{ CAM_SCSI_STATUS_ERROR, "SCSI Status Error"			     },
75 	{ CAM_MSG_REJECT_REC,	 "Message Reject Reveived"		     },
76 	{ CAM_SCSI_BUS_RESET,	 "SCSI Bus Reset Sent/Received"		     },
77 	{ CAM_UNCOR_PARITY,	 "Uncorrectable parity/CRC error"	     },
78 	{ CAM_AUTOSENSE_FAIL,	 "Auto-Sense Retrieval Failed"		     },
79 	{ CAM_NO_HBA,		 "No HBA Detected"			     },
80 	{ CAM_DATA_RUN_ERR,	 "Data Overrun error"			     },
81 	{ CAM_UNEXP_BUSFREE,	 "Unexpected Bus Free"			     },
82 	{ CAM_SEQUENCE_FAIL,	 "Target Bus Phase Sequence Failure"	     },
83 	{ CAM_CCB_LEN_ERR,	 "CCB length supplied is inadequate"	     },
84 	{ CAM_PROVIDE_FAIL,	 "Unable to provide requested capability"    },
85 	{ CAM_BDR_SENT,		 "SCSI BDR Message Sent"		     },
86 	{ CAM_REQ_TERMIO,	 "CCB request terminated by the host"	     },
87 	{ CAM_UNREC_HBA_ERROR,	 "Unrecoverable Host Bus Adapter Error"	     },
88 	{ CAM_REQ_TOO_BIG,	 "The request was too large for this host"   },
89 	{ CAM_REQUEUE_REQ,	 "Unconditionally Re-queue Request",	     },
90 	{ CAM_ATA_STATUS_ERROR,	 "ATA Status Error"			     },
91 	{ CAM_SCSI_IT_NEXUS_LOST,"Initiator/Target Nexus Lost"               },
92 	{ CAM_SMP_STATUS_ERROR,	 "SMP Status Error"                          },
93 	{ CAM_IDE,		 "Initiator Detected Error Message Received" },
94 	{ CAM_RESRC_UNAVAIL,	 "Resource Unavailable"			     },
95 	{ CAM_UNACKED_EVENT,	 "Unacknowledged Event by Host"		     },
96 	{ CAM_MESSAGE_RECV,	 "Message Received in Host Target Mode"	     },
97 	{ CAM_INVALID_CDB,	 "Invalid CDB received in Host Target Mode"  },
98 	{ CAM_LUN_INVALID,	 "Invalid Lun"				     },
99 	{ CAM_TID_INVALID,	 "Invalid Target ID"			     },
100 	{ CAM_FUNC_NOTAVAIL,	 "Function Not Available"		     },
101 	{ CAM_NO_NEXUS,		 "Nexus Not Established"		     },
102 	{ CAM_IID_INVALID,	 "Invalid Initiator ID"			     },
103 	{ CAM_CDB_RECVD,	 "CDB Received"				     },
104 	{ CAM_LUN_ALRDY_ENA,	 "LUN Already Enabled for Target Mode"	     },
105 	{ CAM_SCSI_BUSY,	 "SCSI Bus Busy"			     },
106 };
107 
108 #ifdef _KERNEL
109 SYSCTL_NODE(_kern, OID_AUTO, cam, CTLFLAG_RD, 0, "CAM Subsystem");
110 
111 #ifndef CAM_DEFAULT_SORT_IO_QUEUES
112 #define CAM_DEFAULT_SORT_IO_QUEUES 1
113 #endif
114 
115 int cam_sort_io_queues = CAM_DEFAULT_SORT_IO_QUEUES;
116 SYSCTL_INT(_kern_cam, OID_AUTO, sort_io_queues, CTLFLAG_RWTUN,
117     &cam_sort_io_queues, 0, "Sort IO queues to try and optimise disk access patterns");
118 #endif
119 
120 void
121 cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen)
122 {
123 
124 	/* Trim leading/trailing spaces, nulls. */
125 	while (srclen > 0 && src[0] == ' ')
126 		src++, srclen--;
127 	while (srclen > 0
128 	    && (src[srclen-1] == ' ' || src[srclen-1] == '\0'))
129 		srclen--;
130 
131 	while (srclen > 0 && dstlen > 1) {
132 		u_int8_t *cur_pos = dst;
133 
134 		if (*src < 0x20 || *src >= 0x80) {
135 			/* SCSI-II Specifies that these should never occur. */
136 			/* non-printable character */
137 			if (dstlen > 4) {
138 				*cur_pos++ = '\\';
139 				*cur_pos++ = ((*src & 0300) >> 6) + '0';
140 				*cur_pos++ = ((*src & 0070) >> 3) + '0';
141 				*cur_pos++ = ((*src & 0007) >> 0) + '0';
142 			} else {
143 				*cur_pos++ = '?';
144 			}
145 		} else {
146 			/* normal character */
147 			*cur_pos++ = *src;
148 		}
149 		src++;
150 		srclen--;
151 		dstlen -= cur_pos - dst;
152 		dst = cur_pos;
153 	}
154 	*dst = '\0';
155 }
156 
157 void
158 cam_strvis_sbuf(struct sbuf *sb, const u_int8_t *src, int srclen,
159 		uint32_t flags)
160 {
161 
162 	/* Trim leading/trailing spaces, nulls. */
163 	while (srclen > 0 && src[0] == ' ')
164 		src++, srclen--;
165 	while (srclen > 0
166 	    && (src[srclen-1] == ' ' || src[srclen-1] == '\0'))
167 		srclen--;
168 
169 	while (srclen > 0) {
170 		if (*src < 0x20 || *src >= 0x80) {
171 			/* SCSI-II Specifies that these should never occur. */
172 			/* non-printable character */
173 			switch (flags & CAM_STRVIS_FLAG_NONASCII_MASK) {
174 			case CAM_STRVIS_FLAG_NONASCII_ESC:
175 				sbuf_printf(sb, "\\%c%c%c",
176 				    ((*src & 0300) >> 6) + '0',
177 				    ((*src & 0070) >> 3) + '0',
178 				    ((*src & 0007) >> 0) + '0');
179 				break;
180 			case CAM_STRVIS_FLAG_NONASCII_RAW:
181 				/*
182 				 * If we run into a NUL, just transform it
183 				 * into a space.
184 				 */
185 				if (*src != 0x00)
186 					sbuf_putc(sb, *src);
187 				else
188 					sbuf_putc(sb, ' ');
189 				break;
190 			case CAM_STRVIS_FLAG_NONASCII_SPC:
191 				sbuf_putc(sb, ' ');
192 				break;
193 			case CAM_STRVIS_FLAG_NONASCII_TRIM:
194 			default:
195 				break;
196 			}
197 		} else {
198 			/* normal character */
199 			sbuf_putc(sb, *src);
200 		}
201 		src++;
202 		srclen--;
203 	}
204 }
205 
206 
207 /*
208  * Compare string with pattern, returning 0 on match.
209  * Short pattern matches trailing blanks in name,
210  * Shell globbing rules apply: * matches 0 or more characters,
211  * ? matchces one character, [...] denotes a set to match one char,
212  * [^...] denotes a complimented set to match one character.
213  * Spaces in str used to match anything in the pattern string
214  * but was removed because it's a bug. No current patterns require
215  * it, as far as I know, but it's impossible to know what drives
216  * returned.
217  *
218  * Each '*' generates recursion, so keep the number of * in check.
219  */
220 int
221 cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len)
222 {
223 
224 	while (*pattern != '\0' && str_len > 0) {
225 		if (*pattern == '*') {
226 			pattern++;
227 			if (*pattern == '\0')
228 				return (0);
229 			do {
230 				if (cam_strmatch(str, pattern, str_len) == 0)
231 					return (0);
232 				str++;
233 				str_len--;
234 			} while (str_len > 0);
235 			return (1);
236 		} else if (*pattern == '[') {
237 			int negate_range, ok;
238 			uint8_t pc, sc;
239 
240 			ok = 0;
241 			sc = *str++;
242 			str_len--;
243 			pattern++;
244 			if ((negate_range = (*pattern == '^')) != 0)
245 				pattern++;
246 			while ((*pattern != ']') && *pattern != '\0') {
247 				if (*pattern == '-') {
248 					if (pattern[1] == '\0') /* Bad pattern */
249 						return (1);
250 					if (sc >= pc && sc <= pattern[1])
251 						ok = 1;
252 					pattern++;
253 				} else if (*pattern == sc)
254 					ok = 1;
255 				pc = *pattern;
256 				pattern++;
257 			}
258 			if (ok == negate_range)
259 				return (1);
260 			pattern++;
261 		} else if (*pattern == '?') {
262 			/*
263 			 * NB: || *str == ' ' of the old code is a bug and was
264 			 * removed.  If you add it back, keep this the last if
265 			 * before the naked else */
266 			pattern++;
267 			str++;
268 			str_len--;
269 		} else {
270 			if (*str != *pattern)
271 				return (1);
272 			pattern++;
273 			str++;
274 			str_len--;
275 		}
276 	}
277 
278 	/* '*' is allowed to match nothing, so gobble it */
279 	while (*pattern == '*')
280 		pattern++;
281 
282 	if ( *pattern != '\0') {
283 		/* Pattern not fully consumed.  Not a match */
284 		return (1);
285 	}
286 
287 	/* Eat trailing spaces, which get added by SAT */
288 	while (str_len > 0 && *str == ' ') {
289 		str++;
290 		str_len--;
291 	}
292 
293 	return (str_len);
294 }
295 
296 caddr_t
297 cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
298 	       int entry_size, cam_quirkmatch_t *comp_func)
299 {
300 	for (; num_entries > 0; num_entries--, quirk_table += entry_size) {
301 		if ((*comp_func)(target, quirk_table) == 0)
302 			return (quirk_table);
303 	}
304 	return (NULL);
305 }
306 
307 const struct cam_status_entry*
308 cam_fetch_status_entry(cam_status status)
309 {
310 	status &= CAM_STATUS_MASK;
311 	return (bsearch(&status, &cam_status_table,
312 			nitems(cam_status_table),
313 			sizeof(*cam_status_table),
314 			camstatusentrycomp));
315 }
316 
317 static int
318 camstatusentrycomp(const void *key, const void *member)
319 {
320 	cam_status status;
321 	const struct cam_status_entry *table_entry;
322 
323 	status = *(const cam_status *)key;
324 	table_entry = (const struct cam_status_entry *)member;
325 
326 	return (status - table_entry->status_code);
327 }
328 
329 
330 #ifdef _KERNEL
331 char *
332 cam_error_string(union ccb *ccb, char *str, int str_len,
333 		 cam_error_string_flags flags,
334 		 cam_error_proto_flags proto_flags)
335 #else /* !_KERNEL */
336 char *
337 cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
338 		 int str_len, cam_error_string_flags flags,
339 		 cam_error_proto_flags proto_flags)
340 #endif /* _KERNEL/!_KERNEL */
341 {
342 	char path_str[64];
343 	struct sbuf sb;
344 
345 	if ((ccb == NULL)
346 	 || (str == NULL)
347 	 || (str_len <= 0))
348 		return(NULL);
349 
350 	if (flags == CAM_ESF_NONE)
351 		return(NULL);
352 
353 	switch (ccb->ccb_h.func_code) {
354 		case XPT_ATA_IO:
355 			switch (proto_flags & CAM_EPF_LEVEL_MASK) {
356 			case CAM_EPF_NONE:
357 				break;
358 			case CAM_EPF_ALL:
359 			case CAM_EPF_NORMAL:
360 				proto_flags |= CAM_EAF_PRINT_RESULT;
361 				/* FALLTHROUGH */
362 			case CAM_EPF_MINIMAL:
363 				proto_flags |= CAM_EAF_PRINT_STATUS;
364 				/* FALLTHROUGH */
365 			default:
366 				break;
367 			}
368 			break;
369 		case XPT_SCSI_IO:
370 			switch (proto_flags & CAM_EPF_LEVEL_MASK) {
371 			case CAM_EPF_NONE:
372 				break;
373 			case CAM_EPF_ALL:
374 			case CAM_EPF_NORMAL:
375 				proto_flags |= CAM_ESF_PRINT_SENSE;
376 				/* FALLTHROUGH */
377 			case CAM_EPF_MINIMAL:
378 				proto_flags |= CAM_ESF_PRINT_STATUS;
379 				/* FALLTHROUGH */
380 			default:
381 				break;
382 			}
383 			break;
384 		case XPT_SMP_IO:
385 			switch (proto_flags & CAM_EPF_LEVEL_MASK) {
386 			case CAM_EPF_NONE:
387 				break;
388 			case CAM_EPF_ALL:
389 				proto_flags |= CAM_ESMF_PRINT_FULL_CMD;
390 				/* FALLTHROUGH */
391 			case CAM_EPF_NORMAL:
392 			case CAM_EPF_MINIMAL:
393 				proto_flags |= CAM_ESMF_PRINT_STATUS;
394 				/* FALLTHROUGH */
395 			default:
396 				break;
397 			}
398 			break;
399 		default:
400 			break;
401 	}
402 #ifdef _KERNEL
403 	xpt_path_string(ccb->csio.ccb_h.path, path_str, sizeof(path_str));
404 #else /* !_KERNEL */
405 	cam_path_string(device, path_str, sizeof(path_str));
406 #endif /* _KERNEL/!_KERNEL */
407 
408 	sbuf_new(&sb, str, str_len, 0);
409 
410 	if (flags & CAM_ESF_COMMAND) {
411 		sbuf_cat(&sb, path_str);
412 		switch (ccb->ccb_h.func_code) {
413 		case XPT_ATA_IO:
414 			ata_command_sbuf(&ccb->ataio, &sb);
415 			sbuf_printf(&sb, "\n");
416 			break;
417 		case XPT_SCSI_IO:
418 #ifdef _KERNEL
419 			scsi_command_string(&ccb->csio, &sb);
420 #else /* !_KERNEL */
421 			scsi_command_string(device, &ccb->csio, &sb);
422 #endif /* _KERNEL/!_KERNEL */
423 			sbuf_printf(&sb, "\n");
424 			break;
425 		case XPT_SMP_IO:
426 			smp_command_sbuf(&ccb->smpio, &sb, path_str, 79 -
427 					 strlen(path_str), (proto_flags &
428 					 CAM_ESMF_PRINT_FULL_CMD) ? 79 : 0);
429 			sbuf_printf(&sb, "\n");
430 			break;
431 		default:
432 			break;
433 		}
434 	}
435 
436 	if (flags & CAM_ESF_CAM_STATUS) {
437 		cam_status status;
438 		const struct cam_status_entry *entry;
439 
440 		sbuf_cat(&sb, path_str);
441 
442 		status = ccb->ccb_h.status & CAM_STATUS_MASK;
443 
444 		entry = cam_fetch_status_entry(status);
445 
446 		if (entry == NULL)
447 			sbuf_printf(&sb, "CAM status: Unknown (%#x)\n",
448 				    ccb->ccb_h.status);
449 		else
450 			sbuf_printf(&sb, "CAM status: %s\n",
451 				    entry->status_text);
452 	}
453 
454 	if (flags & CAM_ESF_PROTO_STATUS) {
455 
456 		switch (ccb->ccb_h.func_code) {
457 		case XPT_ATA_IO:
458 			if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
459 			     CAM_ATA_STATUS_ERROR)
460 				break;
461 			if (proto_flags & CAM_EAF_PRINT_STATUS) {
462 				sbuf_cat(&sb, path_str);
463 				ata_status_sbuf(&ccb->ataio, &sb);
464 				sbuf_printf(&sb, "\n");
465 			}
466 			if (proto_flags & CAM_EAF_PRINT_RESULT) {
467 				sbuf_cat(&sb, path_str);
468 				sbuf_printf(&sb, "RES: ");
469 				ata_res_sbuf(&ccb->ataio.res, &sb);
470 				sbuf_printf(&sb, "\n");
471 			}
472 
473 			break;
474 		case XPT_SCSI_IO:
475 			if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
476 			     CAM_SCSI_STATUS_ERROR)
477 				break;
478 
479 			if (proto_flags & CAM_ESF_PRINT_STATUS) {
480 				sbuf_cat(&sb, path_str);
481 				sbuf_printf(&sb, "SCSI status: %s\n",
482 					    scsi_status_string(&ccb->csio));
483 			}
484 
485 			if ((proto_flags & CAM_ESF_PRINT_SENSE)
486 			 && (ccb->csio.scsi_status == SCSI_STATUS_CHECK_COND)
487 			 && (ccb->ccb_h.status & CAM_AUTOSNS_VALID)) {
488 
489 #ifdef _KERNEL
490 				scsi_sense_sbuf(&ccb->csio, &sb,
491 						SSS_FLAG_NONE);
492 #else /* !_KERNEL */
493 				scsi_sense_sbuf(device, &ccb->csio, &sb,
494 						SSS_FLAG_NONE);
495 #endif /* _KERNEL/!_KERNEL */
496 			}
497 			break;
498 		case XPT_SMP_IO:
499 			if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
500 			     CAM_SMP_STATUS_ERROR)
501 				break;
502 
503 			if (proto_flags & CAM_ESF_PRINT_STATUS) {
504 				sbuf_cat(&sb, path_str);
505 				sbuf_printf(&sb, "SMP status: %s (%#x)\n",
506 				    smp_error_desc(ccb->smpio.smp_response[2]),
507 						   ccb->smpio.smp_response[2]);
508 			}
509 			/* There is no SMP equivalent to SCSI sense. */
510 			break;
511 		default:
512 			break;
513 		}
514 	}
515 
516 	sbuf_finish(&sb);
517 
518 	return(sbuf_data(&sb));
519 }
520 
521 #ifdef _KERNEL
522 
523 void
524 cam_error_print(union ccb *ccb, cam_error_string_flags flags,
525 		cam_error_proto_flags proto_flags)
526 {
527 	char str[512];
528 
529 	printf("%s", cam_error_string(ccb, str, sizeof(str), flags,
530 	       proto_flags));
531 }
532 
533 #else /* !_KERNEL */
534 
535 void
536 cam_error_print(struct cam_device *device, union ccb *ccb,
537 		cam_error_string_flags flags, cam_error_proto_flags proto_flags,
538 		FILE *ofile)
539 {
540 	char str[512];
541 
542 	if ((device == NULL) || (ccb == NULL) || (ofile == NULL))
543 		return;
544 
545 	fprintf(ofile, "%s", cam_error_string(device, ccb, str, sizeof(str),
546 		flags, proto_flags));
547 }
548 
549 #endif /* _KERNEL/!_KERNEL */
550 
551 /*
552  * Common calculate geometry fuction
553  *
554  * Caller should set ccg->volume_size and block_size.
555  * The extended parameter should be zero if extended translation
556  * should not be used.
557  */
558 void
559 cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended)
560 {
561 	uint32_t size_mb, secs_per_cylinder;
562 
563 	if (ccg->block_size == 0) {
564 		ccg->ccb_h.status = CAM_REQ_CMP_ERR;
565 		return;
566 	}
567 	size_mb = (1024L * 1024L) / ccg->block_size;
568 	if (size_mb == 0) {
569 		ccg->ccb_h.status = CAM_REQ_CMP_ERR;
570 		return;
571 	}
572 	size_mb = ccg->volume_size / size_mb;
573 	if (size_mb > 1024 && extended) {
574 		ccg->heads = 255;
575 		ccg->secs_per_track = 63;
576 	} else {
577 		ccg->heads = 64;
578 		ccg->secs_per_track = 32;
579 	}
580 	secs_per_cylinder = ccg->heads * ccg->secs_per_track;
581 	if (secs_per_cylinder == 0) {
582 		ccg->ccb_h.status = CAM_REQ_CMP_ERR;
583 		return;
584 	}
585 	ccg->cylinders = ccg->volume_size / secs_per_cylinder;
586 	ccg->ccb_h.status = CAM_REQ_CMP;
587 }
588