xref: /freebsd/sys/cam/cam.c (revision cdadbf097128130443a6dc84e756ffcbe925d3d9)
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 = UCHAR_MAX;
239 			uint8_t sc;
240 
241 			ok = 0;
242 			sc = *str++;
243 			str_len--;
244 			pattern++;
245 			if ((negate_range = (*pattern == '^')) != 0)
246 				pattern++;
247 			while ((*pattern != ']') && *pattern != '\0') {
248 				if (*pattern == '-') {
249 					if (pattern[1] == '\0') /* Bad pattern */
250 						return (1);
251 					if (sc >= pc && sc <= pattern[1])
252 						ok = 1;
253 					pattern++;
254 				} else if (*pattern == sc)
255 					ok = 1;
256 				pc = *pattern;
257 				pattern++;
258 			}
259 			if (ok == negate_range)
260 				return (1);
261 			pattern++;
262 		} else if (*pattern == '?') {
263 			/*
264 			 * NB: || *str == ' ' of the old code is a bug and was
265 			 * removed.  If you add it back, keep this the last if
266 			 * before the naked else */
267 			pattern++;
268 			str++;
269 			str_len--;
270 		} else {
271 			if (*str != *pattern)
272 				return (1);
273 			pattern++;
274 			str++;
275 			str_len--;
276 		}
277 	}
278 
279 	/* '*' is allowed to match nothing, so gobble it */
280 	while (*pattern == '*')
281 		pattern++;
282 
283 	if ( *pattern != '\0') {
284 		/* Pattern not fully consumed.  Not a match */
285 		return (1);
286 	}
287 
288 	/* Eat trailing spaces, which get added by SAT */
289 	while (str_len > 0 && *str == ' ') {
290 		str++;
291 		str_len--;
292 	}
293 
294 	return (str_len);
295 }
296 
297 caddr_t
298 cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
299 	       int entry_size, cam_quirkmatch_t *comp_func)
300 {
301 	for (; num_entries > 0; num_entries--, quirk_table += entry_size) {
302 		if ((*comp_func)(target, quirk_table) == 0)
303 			return (quirk_table);
304 	}
305 	return (NULL);
306 }
307 
308 const struct cam_status_entry*
309 cam_fetch_status_entry(cam_status status)
310 {
311 	status &= CAM_STATUS_MASK;
312 	return (bsearch(&status, &cam_status_table,
313 			nitems(cam_status_table),
314 			sizeof(*cam_status_table),
315 			camstatusentrycomp));
316 }
317 
318 static int
319 camstatusentrycomp(const void *key, const void *member)
320 {
321 	cam_status status;
322 	const struct cam_status_entry *table_entry;
323 
324 	status = *(const cam_status *)key;
325 	table_entry = (const struct cam_status_entry *)member;
326 
327 	return (status - table_entry->status_code);
328 }
329 
330 
331 #ifdef _KERNEL
332 char *
333 cam_error_string(union ccb *ccb, char *str, int str_len,
334 		 cam_error_string_flags flags,
335 		 cam_error_proto_flags proto_flags)
336 #else /* !_KERNEL */
337 char *
338 cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
339 		 int str_len, cam_error_string_flags flags,
340 		 cam_error_proto_flags proto_flags)
341 #endif /* _KERNEL/!_KERNEL */
342 {
343 	char path_str[64];
344 	struct sbuf sb;
345 
346 	if ((ccb == NULL)
347 	 || (str == NULL)
348 	 || (str_len <= 0))
349 		return(NULL);
350 
351 	if (flags == CAM_ESF_NONE)
352 		return(NULL);
353 
354 	switch (ccb->ccb_h.func_code) {
355 		case XPT_ATA_IO:
356 			switch (proto_flags & CAM_EPF_LEVEL_MASK) {
357 			case CAM_EPF_NONE:
358 				break;
359 			case CAM_EPF_ALL:
360 			case CAM_EPF_NORMAL:
361 				proto_flags |= CAM_EAF_PRINT_RESULT;
362 				/* FALLTHROUGH */
363 			case CAM_EPF_MINIMAL:
364 				proto_flags |= CAM_EAF_PRINT_STATUS;
365 				/* FALLTHROUGH */
366 			default:
367 				break;
368 			}
369 			break;
370 		case XPT_SCSI_IO:
371 			switch (proto_flags & CAM_EPF_LEVEL_MASK) {
372 			case CAM_EPF_NONE:
373 				break;
374 			case CAM_EPF_ALL:
375 			case CAM_EPF_NORMAL:
376 				proto_flags |= CAM_ESF_PRINT_SENSE;
377 				/* FALLTHROUGH */
378 			case CAM_EPF_MINIMAL:
379 				proto_flags |= CAM_ESF_PRINT_STATUS;
380 				/* FALLTHROUGH */
381 			default:
382 				break;
383 			}
384 			break;
385 		case XPT_SMP_IO:
386 			switch (proto_flags & CAM_EPF_LEVEL_MASK) {
387 			case CAM_EPF_NONE:
388 				break;
389 			case CAM_EPF_ALL:
390 				proto_flags |= CAM_ESMF_PRINT_FULL_CMD;
391 				/* FALLTHROUGH */
392 			case CAM_EPF_NORMAL:
393 			case CAM_EPF_MINIMAL:
394 				proto_flags |= CAM_ESMF_PRINT_STATUS;
395 				/* FALLTHROUGH */
396 			default:
397 				break;
398 			}
399 			break;
400 		default:
401 			break;
402 	}
403 #ifdef _KERNEL
404 	xpt_path_string(ccb->csio.ccb_h.path, path_str, sizeof(path_str));
405 #else /* !_KERNEL */
406 	cam_path_string(device, path_str, sizeof(path_str));
407 #endif /* _KERNEL/!_KERNEL */
408 
409 	sbuf_new(&sb, str, str_len, 0);
410 
411 	if (flags & CAM_ESF_COMMAND) {
412 		sbuf_cat(&sb, path_str);
413 		switch (ccb->ccb_h.func_code) {
414 		case XPT_ATA_IO:
415 			ata_command_sbuf(&ccb->ataio, &sb);
416 			sbuf_printf(&sb, "\n");
417 			break;
418 		case XPT_SCSI_IO:
419 #ifdef _KERNEL
420 			scsi_command_string(&ccb->csio, &sb);
421 #else /* !_KERNEL */
422 			scsi_command_string(device, &ccb->csio, &sb);
423 #endif /* _KERNEL/!_KERNEL */
424 			sbuf_printf(&sb, "\n");
425 			break;
426 		case XPT_SMP_IO:
427 			smp_command_sbuf(&ccb->smpio, &sb, path_str, 79 -
428 					 strlen(path_str), (proto_flags &
429 					 CAM_ESMF_PRINT_FULL_CMD) ? 79 : 0);
430 			sbuf_printf(&sb, "\n");
431 			break;
432 		default:
433 			break;
434 		}
435 	}
436 
437 	if (flags & CAM_ESF_CAM_STATUS) {
438 		cam_status status;
439 		const struct cam_status_entry *entry;
440 
441 		sbuf_cat(&sb, path_str);
442 
443 		status = ccb->ccb_h.status & CAM_STATUS_MASK;
444 
445 		entry = cam_fetch_status_entry(status);
446 
447 		if (entry == NULL)
448 			sbuf_printf(&sb, "CAM status: Unknown (%#x)\n",
449 				    ccb->ccb_h.status);
450 		else
451 			sbuf_printf(&sb, "CAM status: %s\n",
452 				    entry->status_text);
453 	}
454 
455 	if (flags & CAM_ESF_PROTO_STATUS) {
456 
457 		switch (ccb->ccb_h.func_code) {
458 		case XPT_ATA_IO:
459 			if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
460 			     CAM_ATA_STATUS_ERROR)
461 				break;
462 			if (proto_flags & CAM_EAF_PRINT_STATUS) {
463 				sbuf_cat(&sb, path_str);
464 				ata_status_sbuf(&ccb->ataio, &sb);
465 				sbuf_printf(&sb, "\n");
466 			}
467 			if (proto_flags & CAM_EAF_PRINT_RESULT) {
468 				sbuf_cat(&sb, path_str);
469 				sbuf_printf(&sb, "RES: ");
470 				ata_res_sbuf(&ccb->ataio.res, &sb);
471 				sbuf_printf(&sb, "\n");
472 			}
473 
474 			break;
475 		case XPT_SCSI_IO:
476 			if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
477 			     CAM_SCSI_STATUS_ERROR)
478 				break;
479 
480 			if (proto_flags & CAM_ESF_PRINT_STATUS) {
481 				sbuf_cat(&sb, path_str);
482 				sbuf_printf(&sb, "SCSI status: %s\n",
483 					    scsi_status_string(&ccb->csio));
484 			}
485 
486 			if ((proto_flags & CAM_ESF_PRINT_SENSE)
487 			 && (ccb->csio.scsi_status == SCSI_STATUS_CHECK_COND)
488 			 && (ccb->ccb_h.status & CAM_AUTOSNS_VALID)) {
489 
490 #ifdef _KERNEL
491 				scsi_sense_sbuf(&ccb->csio, &sb,
492 						SSS_FLAG_NONE);
493 #else /* !_KERNEL */
494 				scsi_sense_sbuf(device, &ccb->csio, &sb,
495 						SSS_FLAG_NONE);
496 #endif /* _KERNEL/!_KERNEL */
497 			}
498 			break;
499 		case XPT_SMP_IO:
500 			if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
501 			     CAM_SMP_STATUS_ERROR)
502 				break;
503 
504 			if (proto_flags & CAM_ESF_PRINT_STATUS) {
505 				sbuf_cat(&sb, path_str);
506 				sbuf_printf(&sb, "SMP status: %s (%#x)\n",
507 				    smp_error_desc(ccb->smpio.smp_response[2]),
508 						   ccb->smpio.smp_response[2]);
509 			}
510 			/* There is no SMP equivalent to SCSI sense. */
511 			break;
512 		default:
513 			break;
514 		}
515 	}
516 
517 	sbuf_finish(&sb);
518 
519 	return(sbuf_data(&sb));
520 }
521 
522 #ifdef _KERNEL
523 
524 void
525 cam_error_print(union ccb *ccb, cam_error_string_flags flags,
526 		cam_error_proto_flags proto_flags)
527 {
528 	char str[512];
529 
530 	printf("%s", cam_error_string(ccb, str, sizeof(str), flags,
531 	       proto_flags));
532 }
533 
534 #else /* !_KERNEL */
535 
536 void
537 cam_error_print(struct cam_device *device, union ccb *ccb,
538 		cam_error_string_flags flags, cam_error_proto_flags proto_flags,
539 		FILE *ofile)
540 {
541 	char str[512];
542 
543 	if ((device == NULL) || (ccb == NULL) || (ofile == NULL))
544 		return;
545 
546 	fprintf(ofile, "%s", cam_error_string(device, ccb, str, sizeof(str),
547 		flags, proto_flags));
548 }
549 
550 #endif /* _KERNEL/!_KERNEL */
551 
552 /*
553  * Common calculate geometry fuction
554  *
555  * Caller should set ccg->volume_size and block_size.
556  * The extended parameter should be zero if extended translation
557  * should not be used.
558  */
559 void
560 cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended)
561 {
562 	uint32_t size_mb, secs_per_cylinder;
563 
564 	if (ccg->block_size == 0) {
565 		ccg->ccb_h.status = CAM_REQ_CMP_ERR;
566 		return;
567 	}
568 	size_mb = (1024L * 1024L) / ccg->block_size;
569 	if (size_mb == 0) {
570 		ccg->ccb_h.status = CAM_REQ_CMP_ERR;
571 		return;
572 	}
573 	size_mb = ccg->volume_size / size_mb;
574 	if (size_mb > 1024 && extended) {
575 		ccg->heads = 255;
576 		ccg->secs_per_track = 63;
577 	} else {
578 		ccg->heads = 64;
579 		ccg->secs_per_track = 32;
580 	}
581 	secs_per_cylinder = ccg->heads * ccg->secs_per_track;
582 	if (secs_per_cylinder == 0) {
583 		ccg->ccb_h.status = CAM_REQ_CMP_ERR;
584 		return;
585 	}
586 	ccg->cylinders = ccg->volume_size / secs_per_cylinder;
587 	ccg->ccb_h.status = CAM_REQ_CMP;
588 }
589