1fd501800SSascha Wildner /*-
2fd501800SSascha Wildner * Copyright (c) 2018 Netflix, Inc.
3fd501800SSascha Wildner * All rights reserved.
4fd501800SSascha Wildner * Written by: Scott Long <scottl@freebsd.org>
5fd501800SSascha Wildner *
6fd501800SSascha Wildner * Redistribution and use in source and binary forms, with or without
7fd501800SSascha Wildner * modification, are permitted provided that the following conditions
8fd501800SSascha Wildner * are met:
9fd501800SSascha Wildner * 1. Redistributions of source code must retain the above copyright
10fd501800SSascha Wildner * notice, this list of conditions and the following disclaimer.
11fd501800SSascha Wildner * 2. Redistributions in binary form must reproduce the above copyright
12fd501800SSascha Wildner * notice, this list of conditions and the following disclaimer in the
13fd501800SSascha Wildner * documentation and/or other materials provided with the distribution.
14fd501800SSascha Wildner * 3. Neither the name of the author nor the names of any co-contributors
15fd501800SSascha Wildner * may be used to endorse or promote products derived from this software
16fd501800SSascha Wildner * without specific prior written permission.
17fd501800SSascha Wildner *
18fd501800SSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19fd501800SSascha Wildner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20fd501800SSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21fd501800SSascha Wildner * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22fd501800SSascha Wildner * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23fd501800SSascha Wildner * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24fd501800SSascha Wildner * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25fd501800SSascha Wildner * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26fd501800SSascha Wildner * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27fd501800SSascha Wildner * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28fd501800SSascha Wildner * SUCH DAMAGE.
29fd501800SSascha Wildner */
30fd501800SSascha Wildner
31fd501800SSascha Wildner #include <sys/cdefs.h>
32fd501800SSascha Wildner __RCSID("$FreeBSD: head/usr.sbin/mpsutil/mps_debug.c 330790 2018-03-12 05:03:32Z scottl $");
33fd501800SSascha Wildner
34fd501800SSascha Wildner #include <sys/param.h>
35fd501800SSascha Wildner #include <sys/errno.h>
36fd501800SSascha Wildner #include <sys/types.h>
37fd501800SSascha Wildner #include <sys/sysctl.h>
38fd501800SSascha Wildner #include <err.h>
39fd501800SSascha Wildner #include <libutil.h>
40fd501800SSascha Wildner #include <stdio.h>
41fd501800SSascha Wildner #include <stdlib.h>
42fd501800SSascha Wildner #include <string.h>
43fd501800SSascha Wildner #include <unistd.h>
44fd501800SSascha Wildner #include "mpsutil.h"
45fd501800SSascha Wildner
46fd501800SSascha Wildner MPS_TABLE(top, debug);
47fd501800SSascha Wildner
48fd501800SSascha Wildner struct mps_dumpreq_hdr {
49fd501800SSascha Wildner uint32_t smid;
50fd501800SSascha Wildner uint32_t state;
51fd501800SSascha Wildner uint32_t numframes;
52fd501800SSascha Wildner uint32_t deschi;
53fd501800SSascha Wildner uint32_t desclo;
54fd501800SSascha Wildner };
55fd501800SSascha Wildner
56fd501800SSascha Wildner static int find_sgl(char *);
57fd501800SSascha Wildner static void print_sgl(char *, int, int);
58fd501800SSascha Wildner
59fd501800SSascha Wildner #define MPS_FRAME_LEN 128
60fd501800SSascha Wildner
61fd501800SSascha Wildner static int
debug_dumpreqs(int ac,char ** av)62fd501800SSascha Wildner debug_dumpreqs(int ac, char **av)
63fd501800SSascha Wildner {
64fd501800SSascha Wildner struct mps_dumpreq_hdr *hdr;
65fd501800SSascha Wildner char *buf, sysctlbuf[128];
66fd501800SSascha Wildner size_t len;
67fd501800SSascha Wildner int numframes, error, offset;
68fd501800SSascha Wildner
69fd501800SSascha Wildner len = 0;
70fd501800SSascha Wildner buf = NULL;
71fd501800SSascha Wildner snprintf(sysctlbuf, sizeof(sysctlbuf), "dev.%s.%d.dump_reqs",
72fd501800SSascha Wildner is_mps ? "mps" : "mpr", mps_unit);
73fd501800SSascha Wildner
74fd501800SSascha Wildner error = sysctlbyname(sysctlbuf, NULL, &len, NULL, 0);
75fd501800SSascha Wildner if (error)
76fd501800SSascha Wildner return (error);
77fd501800SSascha Wildner
78fd501800SSascha Wildner if (len == 0)
79fd501800SSascha Wildner return (0);
80fd501800SSascha Wildner
81fd501800SSascha Wildner buf = malloc(len);
82fd501800SSascha Wildner if (buf == NULL)
83fd501800SSascha Wildner return (ENOMEM);
84fd501800SSascha Wildner
85fd501800SSascha Wildner error = sysctlbyname(sysctlbuf, buf, &len, NULL, 0);
86fd501800SSascha Wildner if (error) {
87*9317c2d0SSascha Wildner printf("len= %zu, error= %d errno= %d\n", len, error, errno);
88fd501800SSascha Wildner return (error);
89fd501800SSascha Wildner }
90fd501800SSascha Wildner
91fd501800SSascha Wildner while (len >= MPS_FRAME_LEN) {
92fd501800SSascha Wildner hdr = (struct mps_dumpreq_hdr *)buf;
93fd501800SSascha Wildner numframes = hdr->numframes;
94fd501800SSascha Wildner
95fd501800SSascha Wildner printf("SMID= %d state= %#x numframes= %d desc.hi= %#08x "
96fd501800SSascha Wildner "desc.lo= %#08x\n", hdr->smid, hdr->state,
97fd501800SSascha Wildner hdr->numframes, hdr->deschi, hdr->desclo);
98fd501800SSascha Wildner
99fd501800SSascha Wildner buf += sizeof(struct mps_dumpreq_hdr);
100fd501800SSascha Wildner len -= sizeof(struct mps_dumpreq_hdr);
101fd501800SSascha Wildner
102fd501800SSascha Wildner if ((offset = find_sgl(buf)) != -1)
103fd501800SSascha Wildner print_sgl(buf, offset, numframes);
104fd501800SSascha Wildner
105fd501800SSascha Wildner buf += MPS_FRAME_LEN * numframes;
106fd501800SSascha Wildner len -= MPS_FRAME_LEN * numframes;
107fd501800SSascha Wildner }
108fd501800SSascha Wildner
109fd501800SSascha Wildner return (error);
110fd501800SSascha Wildner }
111fd501800SSascha Wildner
112fd501800SSascha Wildner static int
find_sgl(char * buf)113fd501800SSascha Wildner find_sgl(char *buf)
114fd501800SSascha Wildner {
115fd501800SSascha Wildner MPI2_REQUEST_HEADER *req;
116fd501800SSascha Wildner MPI2_SCSI_IO_REQUEST *scsi;
117fd501800SSascha Wildner int offset = 0;
118fd501800SSascha Wildner
119fd501800SSascha Wildner req = (MPI2_REQUEST_HEADER *)buf;
120fd501800SSascha Wildner
121fd501800SSascha Wildner switch (req->Function) {
122fd501800SSascha Wildner case MPI2_FUNCTION_SCSI_IO_REQUEST:
123fd501800SSascha Wildner scsi = (MPI2_SCSI_IO_REQUEST *)buf;
124fd501800SSascha Wildner offset = scsi->SGLOffset0;
125fd501800SSascha Wildner break;
126fd501800SSascha Wildner default:
127fd501800SSascha Wildner offset = -1;
128fd501800SSascha Wildner }
129fd501800SSascha Wildner
130fd501800SSascha Wildner return (offset);
131fd501800SSascha Wildner }
132fd501800SSascha Wildner
133fd501800SSascha Wildner #define SGL_FLAGS "\10LastElement\7EndOfBuffer\4Local\3Host2IOC\2Addr64\1EndOfList"
134fd501800SSascha Wildner
135fd501800SSascha Wildner static void
print_sgl(char * buf,int offset,int numframes)136fd501800SSascha Wildner print_sgl(char *buf, int offset, int numframes)
137fd501800SSascha Wildner {
138fd501800SSascha Wildner MPI2_SGE_SIMPLE64 *sge;
139fd501800SSascha Wildner MPI2_SGE_CHAIN_UNION *sgc;
140fd501800SSascha Wildner MPI2_REQUEST_HEADER *req;
141fd501800SSascha Wildner u_int i = 0, flags;
142fd501800SSascha Wildner char *frame, tmpbuf[128];
143fd501800SSascha Wildner
144fd501800SSascha Wildner req = (MPI2_REQUEST_HEADER *)buf;
145fd501800SSascha Wildner frame = (char *)buf;
146fd501800SSascha Wildner sge = (MPI2_SGE_SIMPLE64 *)&frame[offset * 4];
147fd501800SSascha Wildner printf("SGL for command\n");
148fd501800SSascha Wildner
149fd501800SSascha Wildner hexdump(frame, MPS_FRAME_LEN, NULL, 0);
150fd501800SSascha Wildner while (frame != NULL) {
151fd501800SSascha Wildner flags = sge->FlagsLength >> MPI2_SGE_FLAGS_SHIFT;
152fd501800SSascha Wildner bzero(tmpbuf, sizeof(tmpbuf));
153fd501800SSascha Wildner mps_parse_flags(flags, SGL_FLAGS, tmpbuf, sizeof(tmpbuf));
154fd501800SSascha Wildner printf("seg%d flags=%x %s len= 0x%06x addr=0x%016jx\n", i,
155fd501800SSascha Wildner flags, tmpbuf, sge->FlagsLength & 0xffffff,
156fd501800SSascha Wildner mps_to_u64(&sge->Address));
157fd501800SSascha Wildner if (flags & (MPI2_SGE_FLAGS_END_OF_LIST |
158fd501800SSascha Wildner MPI2_SGE_FLAGS_END_OF_BUFFER))
159fd501800SSascha Wildner break;
160fd501800SSascha Wildner sge++;
161fd501800SSascha Wildner i++;
162fd501800SSascha Wildner if (flags & MPI2_SGE_FLAGS_LAST_ELEMENT) {
163fd501800SSascha Wildner sgc = (MPI2_SGE_CHAIN_UNION *)sge;
164fd501800SSascha Wildner if ((sgc->Flags & MPI2_SGE_FLAGS_CHAIN_ELEMENT) == 0) {
165fd501800SSascha Wildner printf("Invalid chain element\n");
166fd501800SSascha Wildner break;
167fd501800SSascha Wildner }
168fd501800SSascha Wildner bzero(tmpbuf, sizeof(tmpbuf));
169fd501800SSascha Wildner mps_parse_flags(sgc->Flags, SGL_FLAGS, tmpbuf,
170fd501800SSascha Wildner sizeof(tmpbuf));
171fd501800SSascha Wildner if (sgc->Flags & MPI2_SGE_FLAGS_64_BIT_ADDRESSING)
172fd501800SSascha Wildner printf("chain64 flags=0x%x %s len=0x%x "
173fd501800SSascha Wildner "Offset=0x%x addr=0x%016jx\n", sgc->Flags,
174fd501800SSascha Wildner tmpbuf, sgc->Length, sgc->NextChainOffset,
175fd501800SSascha Wildner mps_to_u64(&sgc->u.Address64));
176fd501800SSascha Wildner else
177fd501800SSascha Wildner printf("chain32 flags=0x%x %s len=0x%x "
178fd501800SSascha Wildner "Offset=0x%x addr=0x%08x\n", sgc->Flags,
179fd501800SSascha Wildner tmpbuf, sgc->Length, sgc->NextChainOffset,
180fd501800SSascha Wildner sgc->u.Address32);
181fd501800SSascha Wildner if (--numframes <= 0)
182fd501800SSascha Wildner break;
183fd501800SSascha Wildner frame += MPS_FRAME_LEN;
184fd501800SSascha Wildner sge = (MPI2_SGE_SIMPLE64 *)frame;
185fd501800SSascha Wildner hexdump(frame, MPS_FRAME_LEN, NULL, 0);
186fd501800SSascha Wildner }
187fd501800SSascha Wildner }
188fd501800SSascha Wildner }
189fd501800SSascha Wildner
190fd501800SSascha Wildner MPS_COMMAND(debug, dumpreqs, debug_dumpreqs, "", "Dump the active request queue")
191