Whamcloud - gitweb
LU-6612 utils: strengthen llog_reader vs wrong format/header
[fs/lustre-release.git] / lustre / utils / llog_reader.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  */
31 /** \defgroup llog_reader Lustre Log Reader
32  *
33  * Interpret llogs used for storing configuration and changelog data
34  *
35  * @{
36  */
37
38 #include <errno.h>
39 #include <limits.h>
40 #include <stdbool.h>
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <string.h>
44 #include <sys/types.h>
45 #include <sys/stat.h>
46 #include <sys/param.h>
47 #ifdef HAVE_ENDIAN_H
48 # include <endian.h>
49 #endif
50 #include <unistd.h>
51 #include <fcntl.h>
52 #include <sys/vfs.h>
53 #include <linux/magic.h>
54 #include <errno.h>
55 #include <time.h>
56 #include <linux/lnet/nidstr.h>
57 #include <linux/lustre/lustre_cfg.h>
58 #include <linux/lustre/lustre_fid.h>
59 #include <linux/lustre/lustre_ostid.h>
60 #include <linux/lustre/lustre_log_user.h>
61 #include <lustre/lustreapi.h>
62
63 static inline int ext2_test_bit(int nr, const void *addr)
64 {
65 #if __BYTE_ORDER == __BIG_ENDIAN
66         const unsigned char *tmp = addr;
67
68         return (tmp[nr >> 3] >> (nr & 7)) & 1;
69 #else
70         const unsigned long *tmp = addr;
71
72         return ((1UL << (nr & (__WORDSIZE - 1))) &
73                 ((tmp)[nr / __WORDSIZE])) != 0;
74 #endif
75 }
76
77 int llog_pack_buffer(int fd, struct llog_log_hdr **llog_buf,
78                      struct llog_rec_hdr ***recs, int *recs_number);
79
80 void print_llog_header(struct llog_log_hdr *llog_buf);
81 static void print_records(struct llog_rec_hdr **recs_buf,
82                           int rec_number, int is_ext);
83 void llog_unpack_buffer(int fd, struct llog_log_hdr *llog_buf,
84                         struct llog_rec_hdr **recs_buf);
85
86 #define CANCELLED 0x678
87
88 #define PTL_CMD_BASE 100
89 char *portals_command[17] = {
90         "REGISTER_PEER_FD",
91         "CLOSE_CONNECTION",
92         "REGISTER_MYNID",
93         "PUSH_CONNECTION",
94         "GET_CONN",
95         "DEL_PEER",
96         "ADD_PEER",
97         "GET_PEER",
98         "GET_TXDESC",
99         "ADD_ROUTE",
100         "DEL_ROUTE",
101         "GET_ROUTE",
102         "NOTIFY_ROUTER",
103         "ADD_INTERFACE",
104         "DEL_INTERFACE",
105         "GET_INTERFACE",
106         ""
107 };
108
109 int is_fstype_ext(int fd)
110 {
111         struct statfs st;
112         int rc;
113
114         rc = fstatfs(fd, &st);
115         if (rc < 0) {
116                 llapi_error(LLAPI_MSG_ERROR, rc, "Got statfs error.");
117                 return -errno;
118         }
119
120         return (st.f_type == EXT4_SUPER_MAGIC);
121 }
122
123 /**
124  * Attempt to display a path to the object (file) containing changelog entries,
125  * referred to by this changelog_catalog record.
126  *
127  * This path depends on the implementation of the OSD device; zfs-osd and
128  * ldiskfs-osd are different.
129  *
130  * Assumes that if the file system containing the changelog_catalog is
131  * ext{2,3,4}, the backend is ldiskfs-osd; otherwise it is either zfs-osd or at
132  * least names objects based on FID and the zfs-osd path (which includes the
133  * FID) will be sufficient.
134  *
135  * The Object ID stored in the record is also displayed untranslated.
136  */
137 #define OSD_OI_FID_NR         (1UL << 7)
138 static void print_log_path(struct llog_logid_rec *lid, int is_ext)
139 {
140         char object_path[255];
141         struct lu_fid fid_from_logid;
142
143         logid_to_fid(&lid->lid_id, &fid_from_logid);
144
145         if (is_ext)
146                 snprintf(object_path, sizeof(object_path),
147                          "O/%ju/d%u/%u", (uintmax_t)fid_from_logid.f_seq,
148                          fid_from_logid.f_oid % 32,
149                          fid_from_logid.f_oid);
150         else
151                 snprintf(object_path, sizeof(object_path),
152                          "oi.%ju/"DFID_NOBRACE,
153                          (uintmax_t)(fid_from_logid.f_seq &
154                                      (OSD_OI_FID_NR - 1)),
155                          PFID(&fid_from_logid));
156
157         printf("id="DFID":%x path=%s\n",
158                PFID(&lid->lid_id.lgl_oi.oi_fid), lid->lid_id.lgl_ogen,
159                object_path);
160 }
161
162 int main(int argc, char **argv)
163 {
164         int rc = 0;
165         int is_ext;
166         int fd, rec_number;
167         struct llog_log_hdr *llog_buf = NULL;
168         struct llog_rec_hdr **recs_buf = NULL;
169
170         setlinebuf(stdout);
171
172         if (argc != 2) {
173                 printf("Usage: llog_reader filename\n");
174                 return -1;
175         }
176
177         fd = open(argv[1], O_RDONLY);
178         if (fd < 0) {
179                 rc = -errno;
180                 llapi_error(LLAPI_MSG_ERROR, rc, "Could not open the file %s.",
181                             argv[1]);
182                 goto out;
183         }
184
185         is_ext = is_fstype_ext(fd);
186         if (is_ext < 0) {
187                 rc = is_ext;
188                 llapi_error(LLAPI_MSG_ERROR, -rc,
189                             "Unable to determine filesystem type for %s",
190                        argv[1]);
191                 goto out_fd;
192         }
193
194         rc = llog_pack_buffer(fd, &llog_buf, &recs_buf, &rec_number);
195         if (rc < 0) {
196                 llapi_error(LLAPI_MSG_ERROR, rc, "Could not pack buffer.");
197                 goto out_fd;
198         }
199
200         if (llog_buf)
201                 print_llog_header(llog_buf);
202         if (recs_buf)
203                 print_records(recs_buf, rec_number, is_ext);
204         llog_unpack_buffer(fd, llog_buf, recs_buf);
205
206 out_fd:
207         close(fd);
208 out:
209         return rc;
210 }
211
212 int llog_pack_buffer(int fd, struct llog_log_hdr **llog,
213                      struct llog_rec_hdr ***recs,
214                      int *recs_number)
215 {
216         int rc = 0, recs_num, rd = 0;
217         long long file_size;
218         struct stat st;
219         char *file_buf = NULL, *recs_buf = NULL;
220         struct llog_rec_hdr **recs_pr = NULL;
221         char *ptr = NULL;
222         int count;
223         int i, last_idx;
224
225         *recs = NULL;
226         *recs_number = 0;
227
228         rc = fstat(fd, &st);
229         if (rc < 0) {
230                 rc = -errno;
231                 llapi_error(LLAPI_MSG_ERROR, rc, "Got file stat error.");
232                 goto out;
233         }
234
235         file_size = st.st_size;
236         if (file_size < sizeof(**llog)) {
237                 llapi_error(LLAPI_MSG_ERROR, rc,
238                             "File too small for llog header: want=%zd got=%lld",
239                             sizeof(**llog), file_size);
240                 rc = -EIO;
241                 goto out;
242         }
243
244         file_buf = malloc(file_size);
245         if (!file_buf) {
246                 rc = -ENOMEM;
247                 llapi_error(LLAPI_MSG_ERROR, rc, "Memory Alloc for file_buf.");
248                 goto out;
249         }
250         *llog = (struct llog_log_hdr *)file_buf;
251
252         do {
253                 rc = read(fd, file_buf + rd, file_size - rd);
254                 if (rc > 0)
255                         rd += rc;
256         } while (rc > 0 && rd < file_size);
257
258         if (rd < file_size) {
259                 rc = rc < 0 ? -errno : -EIO;
260                 llapi_error(LLAPI_MSG_ERROR, rc,
261                             "Error reading llog header: need %zd, got %d",
262                             sizeof(**llog), rd);
263                 goto clear_file_buf;
264         }
265
266         count = __le32_to_cpu((*llog)->llh_count);
267         if (count < 0) {
268                 rc = -EINVAL;
269                 llapi_error(LLAPI_MSG_ERROR, rc,
270                             "corrupted llog: negative record number %d",
271                             count);
272                 goto clear_file_buf;
273         } else if (count == 0) {
274                 llapi_printf(LLAPI_MSG_NORMAL,
275                              "uninitialized llog: zero record number\n");
276                 goto clear_file_buf;
277         }
278
279         /* the llog header not countable here.*/
280         recs_num = count - 1;
281         if (recs_num == 0)
282                 goto clear_file_buf;
283
284         recs_buf = calloc(recs_num, sizeof(**recs_pr));
285         if (!recs_buf) {
286                 rc = -ENOMEM;
287                 llapi_error(LLAPI_MSG_ERROR, rc,
288                             "Error allocating %zd bytes for recs_buf",
289                             recs_num * sizeof(**recs_pr));
290                 goto clear_file_buf;
291         }
292         recs_pr = (struct llog_rec_hdr **)recs_buf;
293
294         ptr = file_buf + __le32_to_cpu((*llog)->llh_hdr.lrh_len);
295         i = 0;
296
297         last_idx = 0;
298         while (ptr < (file_buf + file_size)) {
299                 struct llog_rec_hdr *cur_rec;
300                 int idx;
301                 unsigned long offset;
302
303                 if (ptr + sizeof(**recs_pr) > file_buf + file_size) {
304                         rc = -EINVAL;
305                         llapi_error(LLAPI_MSG_ERROR, rc,
306                                     "The log is corrupt (too big at %d)", i);
307                         goto clear_recs_buf;
308                 }
309
310                 cur_rec = (struct llog_rec_hdr *)ptr;
311                 idx = __le32_to_cpu(cur_rec->lrh_index);
312                 recs_pr[i] = cur_rec;
313                 offset = (unsigned long)ptr - (unsigned long)file_buf;
314                 if (cur_rec->lrh_len == 0 ||
315                     cur_rec->lrh_len > (*llog)->llh_hdr.lrh_len) {
316                         cur_rec->lrh_len = (*llog)->llh_hdr.lrh_len -
317                                 offset % (*llog)->llh_hdr.lrh_len;
318                         printf("off %lu skip %u to next chunk.\n", offset,
319                                cur_rec->lrh_len);
320                         i--;
321                 } else if (ext2_test_bit(idx, LLOG_HDR_BITMAP(*llog))) {
322                         printf("rec #%d type=%x len=%u offset %lu\n", idx,
323                                cur_rec->lrh_type, cur_rec->lrh_len, offset);
324                 } else {
325                         cur_rec->lrh_id = CANCELLED;
326                         if (cur_rec->lrh_type == LLOG_PAD_MAGIC &&
327                            ((offset + cur_rec->lrh_len) & 0x7) != 0)
328                                 printf("rec #%d wrong padding len=%u offset %lu to 0x%lx\n",
329                                        idx, cur_rec->lrh_len, offset,
330                                        offset + cur_rec->lrh_len);
331                         /* The header counts only set records */
332                         i--;
333                 }
334                 if (last_idx + 1 != idx) {
335                         printf("Previous index is %d, current %d, offset %lu\n",
336                                last_idx, idx, offset);
337                 }
338                 last_idx = idx;
339
340                 ptr += __le32_to_cpu(cur_rec->lrh_len);
341                 if ((ptr - file_buf) > file_size) {
342                         printf("The log is corrupt (too big at %d)\n", i);
343                         rc = -EINVAL;
344                         goto clear_recs_buf;
345                 }
346                 i++;
347         }
348
349         *recs = recs_pr;
350         *recs_number = recs_num;
351 out:
352         return rc;
353
354 clear_recs_buf:
355         free(recs_buf);
356
357 clear_file_buf:
358         free(file_buf);
359
360         *llog = NULL;
361         goto out;
362 }
363
364 void llog_unpack_buffer(int fd, struct llog_log_hdr *llog_buf,
365                         struct llog_rec_hdr **recs_buf)
366 {
367         if (llog_buf)
368                 free(llog_buf);
369         if (recs_buf)
370                 free(recs_buf);
371 }
372
373 void print_llog_header(struct llog_log_hdr *llog_buf)
374 {
375         time_t t;
376         unsigned int lrh_len = __le32_to_cpu(llog_buf->llh_hdr.lrh_len);
377         struct llog_rec_tail *tail = ((struct llog_rec_tail *)((char *)llog_buf+
378                                  lrh_len - sizeof(llog_buf->llh_tail)));
379
380         printf("Header size : %u\t llh_size : %u\n", lrh_len,
381                __le32_to_cpu(llog_buf->llh_size));
382
383         t = __le64_to_cpu(llog_buf->llh_timestamp);
384         printf("Time : %s", ctime(&t));
385
386         printf("Number of records: %u\tcat_idx: %u\tlast_idx: %u\n",
387                __le32_to_cpu(llog_buf->llh_count)-1,
388                __le32_to_cpu(llog_buf->llh_cat_idx),
389                __le32_to_cpu(tail->lrt_index));
390
391         printf("Target uuid : %s\n",
392                (char *)(&llog_buf->llh_tgtuuid));
393
394         /* Add the other info you want to view here */
395
396         printf("-----------------------\n");
397 }
398
399 static void print_1_cfg(struct lustre_cfg *lcfg)
400 {
401         int i;
402
403         if (lcfg->lcfg_nid)
404                 printf("nid=%s(%#jx)  ", libcfs_nid2str(lcfg->lcfg_nid),
405                        (uintmax_t)lcfg->lcfg_nid);
406         if (lcfg->lcfg_nal)
407                 printf("nal=%d ", lcfg->lcfg_nal);
408         for (i = 0; i <  lcfg->lcfg_bufcount; i++)
409                 printf("%d:%.*s  ", i, lcfg->lcfg_buflens[i],
410                        (char *)lustre_cfg_buf(lcfg, i));
411 }
412
413 static char *lustre_cfg_string(struct lustre_cfg *lcfg, __u32 index)
414 {
415         char *s;
416
417         if (lcfg->lcfg_buflens[index] == 0)
418                 return NULL;
419
420         s = lustre_cfg_buf(lcfg, index);
421         if (!s)
422                 return NULL;
423
424         /*
425          * make sure it's NULL terminated, even if this kills a char
426          * of data. Try to use the padding first though.
427          */
428         if (s[lcfg->lcfg_buflens[index] - 1] != '\0') {
429                 size_t last = __ALIGN_KERNEL(lcfg->lcfg_buflens[index], 8) - 1;
430                 char lost;
431
432                 /* Use the smaller value */
433                 if (last > lcfg->lcfg_buflens[index])
434                         last = lcfg->lcfg_buflens[index];
435
436                 lost = s[last];
437                 s[last] = '\0';
438                 if (lost != '\0') {
439                         fprintf(stderr,
440                                 "Truncated buf %d to '%s' (lost '%c'...)\n",
441                                 index, s, lost);
442                 }
443         }
444         return s;
445 }
446
447 static void print_setup_cfg(struct lustre_cfg *lcfg)
448 {
449         struct lov_desc *desc;
450
451         if ((lcfg->lcfg_bufcount == 2) &&
452             (lcfg->lcfg_buflens[1] == sizeof(*desc))) {
453                 printf("lov_setup ");
454                 printf("0:%s  ", lustre_cfg_string(lcfg, 0));
455                 printf("1:(struct lov_desc)\n");
456                 desc = (struct lov_desc *)(lustre_cfg_string(lcfg, 1));
457                 printf("\t\tuuid=%s  ", (char *)desc->ld_uuid.uuid);
458                 printf("stripe:cnt=%u ", desc->ld_default_stripe_count);
459                 printf("size=%ju ", (uintmax_t)desc->ld_default_stripe_size);
460                 printf("offset=%ju ",
461                        (uintmax_t)desc->ld_default_stripe_offset);
462                 printf("pattern=%#x", desc->ld_pattern);
463         } else {
464                 printf("setup     ");
465                 print_1_cfg(lcfg);
466         }
467 }
468
469 void print_lustre_cfg(struct lustre_cfg *lcfg, int *skip)
470 {
471         enum lcfg_command_type cmd = __le32_to_cpu(lcfg->lcfg_command);
472
473         if (*skip > 0)
474                 printf("SKIP ");
475
476         switch (cmd) {
477         case(LCFG_ATTACH):{
478                 printf("attach    ");
479                 print_1_cfg(lcfg);
480                 break;
481         }
482         case(LCFG_SETUP):{
483                 print_setup_cfg(lcfg);
484                 break;
485         }
486         case(LCFG_DETACH):{
487                 printf("detach    ");
488                 print_1_cfg(lcfg);
489                 break;
490         }
491         case(LCFG_CLEANUP):{
492                 printf("cleanup   ");
493                 print_1_cfg(lcfg);
494                 break;
495         }
496         case(LCFG_ADD_UUID):{
497                 printf("add_uuid  ");
498                 print_1_cfg(lcfg);
499                 break;
500         }
501         case(LCFG_DEL_UUID):{
502                 printf("del_uuid  ");
503                 print_1_cfg(lcfg);
504                 break;
505         }
506         case(LCFG_ADD_CONN):{
507                 printf("add_conn  ");
508                 print_1_cfg(lcfg);
509                 break;
510         }
511         case(LCFG_DEL_CONN):{
512                 printf("del_conn  ");
513                 print_1_cfg(lcfg);
514                 break;
515         }
516         case(LCFG_LOV_ADD_OBD):{
517                 printf("lov_modify_tgts add ");
518                 print_1_cfg(lcfg);
519                 break;
520         }
521         case(LCFG_LOV_DEL_OBD):{
522                 printf("lov_modify_tgts del ");
523                 print_1_cfg(lcfg);
524                 break;
525         }
526         case(LCFG_ADD_MDC):{
527                 printf("modify_mdc_tgts add ");
528                 print_1_cfg(lcfg);
529                 break;
530         }
531         case(LCFG_DEL_MDC):{
532                 printf("modify_mdc_tgts del ");
533                 print_1_cfg(lcfg);
534                 break;
535         }
536         case(LCFG_MOUNTOPT):{
537                 printf("mount_option ");
538                 print_1_cfg(lcfg);
539                 break;
540         }
541         case(LCFG_DEL_MOUNTOPT):{
542                 printf("del_mount_option ");
543                 print_1_cfg(lcfg);
544                 break;
545         }
546         case(LCFG_SET_TIMEOUT):{
547                 printf("set_timeout=%d ", lcfg->lcfg_num);
548                 break;
549         }
550         case(LCFG_SET_LDLM_TIMEOUT):{
551                 printf("set_ldlm_timeout=%d ", lcfg->lcfg_num);
552                 break;
553         }
554         case(LCFG_SET_UPCALL):{
555                 printf("set_lustre_upcall ");
556                 print_1_cfg(lcfg);
557                 break;
558         }
559         case(LCFG_PARAM):{
560                 printf("param ");
561                 print_1_cfg(lcfg);
562                 break;
563         }
564         case(LCFG_SET_PARAM):{
565                 printf("set_param ");
566                 print_1_cfg(lcfg);
567                 break;
568         }
569         case(LCFG_SPTLRPC_CONF):{
570                 printf("sptlrpc_conf ");
571                 print_1_cfg(lcfg);
572                 break;
573         }
574         case(LCFG_MARKER):{
575                 struct cfg_marker *marker = lustre_cfg_buf(lcfg, 1);
576                 char createtime[26], canceltime[26] = "";
577                 time_t time_tmp;
578
579                 if (marker->cm_flags & CM_START &&
580                     marker->cm_flags & CM_SKIP) {
581                         printf("SKIP START ");
582                         (*skip)++;
583                 } else if (marker->cm_flags & CM_END) {
584                         printf("END   ");
585                         *skip = 0;
586                 }
587
588                 if (marker->cm_flags & CM_EXCLUDE) {
589                         if (marker->cm_flags & CM_START)
590                                 printf("EXCLUDE START ");
591                         else
592                                 printf("EXCLUDE END   ");
593                 }
594
595                 /*
596                  * Handle overflow of 32-bit time_t gracefully.
597                  * The copy to time_tmp is needed in any case to
598                  * keep the pointer happy, even on 64-bit systems.
599                  */
600                 time_tmp = marker->cm_createtime;
601                 if (time_tmp == marker->cm_createtime) {
602                         ctime_r(&time_tmp, createtime);
603                         createtime[strlen(createtime) - 1] = 0;
604                 } else {
605                         strcpy(createtime, "in the distant future");
606                 }
607
608                 if (marker->cm_canceltime) {
609                         /*
610                          * Like cm_createtime, we try to handle overflow of
611                          * 32-bit time_t gracefully. The copy to time_tmp
612                          * is also needed on 64-bit systems to keep the
613                          * pointer happy, see bug 16771
614                          */
615                         time_tmp = marker->cm_canceltime;
616                         if (time_tmp == marker->cm_canceltime) {
617                                 ctime_r(&time_tmp, canceltime);
618                                 canceltime[strlen(canceltime) - 1] = 0;
619                         } else {
620                                 strcpy(canceltime, "in the distant future");
621                         }
622                 }
623
624                 printf("marker %3d (flags=%#04x, v%d.%d.%d.%d) %-15s '%s' %s-%s",
625                        marker->cm_step, marker->cm_flags,
626                        OBD_OCD_VERSION_MAJOR(marker->cm_vers),
627                        OBD_OCD_VERSION_MINOR(marker->cm_vers),
628                        OBD_OCD_VERSION_PATCH(marker->cm_vers),
629                        OBD_OCD_VERSION_FIX(marker->cm_vers),
630                        marker->cm_tgtname, marker->cm_comment,
631                        createtime, canceltime);
632                 break;
633         }
634         case(LCFG_POOL_NEW):{
635                 printf("pool new ");
636                 print_1_cfg(lcfg);
637                 break;
638         }
639         case(LCFG_POOL_ADD):{
640                 printf("pool add ");
641                 print_1_cfg(lcfg);
642                 break;
643         }
644         case(LCFG_POOL_REM):{
645                 printf("pool remove ");
646                 print_1_cfg(lcfg);
647                 break;
648         }
649         case(LCFG_POOL_DEL):{
650                 printf("pool destroy ");
651                 print_1_cfg(lcfg);
652                 break;
653         }
654         default:
655                 printf("unsupported cmd_code = %x\n", cmd);
656         }
657         printf("\n");
658 }
659
660 static void print_hsm_action(struct llog_agent_req_rec *larr)
661 {
662         char buf[12];
663         int sz;
664
665         sz = larr->arr_hai.hai_len - sizeof(larr->arr_hai);
666         printf("lrh=[type=%X len=%d idx=%d] fid="DFID" compound/cookie=%#llx/%#llx status=%s action=%s archive#=%d flags=%#llx create=%llu change=%llu extent=%#llx-%#llx gid=%#llx datalen=%d data=[%s]\n",
667                larr->arr_hdr.lrh_type,
668                larr->arr_hdr.lrh_len, larr->arr_hdr.lrh_index,
669                PFID(&larr->arr_hai.hai_fid),
670                (unsigned long long)larr->arr_compound_id,
671                (unsigned long long)larr->arr_hai.hai_cookie,
672                agent_req_status2name(larr->arr_status),
673                hsm_copytool_action2name(larr->arr_hai.hai_action),
674                larr->arr_archive_id,
675                (unsigned long long)larr->arr_flags,
676                (unsigned long long)larr->arr_req_create,
677                (unsigned long long)larr->arr_req_change,
678                (unsigned long long)larr->arr_hai.hai_extent.offset,
679                (unsigned long long)larr->arr_hai.hai_extent.length,
680                (unsigned long long)larr->arr_hai.hai_gid, sz,
681                hai_dump_data_field(&larr->arr_hai, buf, sizeof(buf)));
682 }
683
684 void print_changelog_rec(struct llog_changelog_rec *rec)
685 {
686         time_t secs;
687         struct tm ts;
688
689         secs = __le64_to_cpu(rec->cr.cr_time) >> 30;
690         gmtime_r(&secs, &ts);
691         printf("changelog record id:0x%x index:%llu cr_flags:0x%x cr_type:%s(0x%x) date:'%02d:%02d:%02d.%09d %04d.%02d.%02d' target:"DFID,
692                __le32_to_cpu(rec->cr_hdr.lrh_id),
693                (unsigned long long)__le64_to_cpu(rec->cr.cr_index),
694                __le32_to_cpu(rec->cr.cr_flags),
695                changelog_type2str(__le32_to_cpu(rec->cr.cr_type)),
696                __le32_to_cpu(rec->cr.cr_type),
697                ts.tm_hour, ts.tm_min, ts.tm_sec,
698                (int)(__le64_to_cpu(rec->cr.cr_time) & ((1 << 30) - 1)),
699                ts.tm_year + 1900, ts.tm_mon + 1, ts.tm_mday,
700                PFID(&rec->cr.cr_tfid));
701
702         if (rec->cr.cr_flags & CLF_JOBID) {
703                 struct changelog_ext_jobid *jid =
704                         changelog_rec_jobid(&rec->cr);
705
706                 if (jid->cr_jobid[0] != '\0')
707                         printf(" jobid:%s", jid->cr_jobid);
708         }
709
710         if (rec->cr.cr_flags & CLF_EXTRA_FLAGS) {
711                 struct changelog_ext_extra_flags *ef =
712                         changelog_rec_extra_flags(&rec->cr);
713
714                 printf(" cr_extra_flags:0x%llx",
715                        (unsigned long long)__le64_to_cpu(ef->cr_extra_flags));
716
717                 if (ef->cr_extra_flags & CLFE_UIDGID) {
718                         struct changelog_ext_uidgid *uidgid =
719                                 changelog_rec_uidgid(&rec->cr);
720
721                         printf(" user:%u:%u",
722                                __le32_to_cpu(uidgid->cr_uid),
723                                __le32_to_cpu(uidgid->cr_gid));
724                 }
725                 if (ef->cr_extra_flags & CLFE_NID) {
726                         struct changelog_ext_nid *nid =
727                                 changelog_rec_nid(&rec->cr);
728
729                         printf(" nid:%s",
730                                libcfs_nid2str(nid->cr_nid));
731                 }
732
733                 if (ef->cr_extra_flags & CLFE_OPEN) {
734                         struct changelog_ext_openmode *omd =
735                                 changelog_rec_openmode(&rec->cr);
736                         char mode[] = "---";
737
738                         /* exec mode must be exclusive */
739                         if (__le32_to_cpu(omd->cr_openflags) & MDS_FMODE_EXEC) {
740                                 mode[2] = 'x';
741                         } else {
742                                 if (__le32_to_cpu(omd->cr_openflags) &
743                                     MDS_FMODE_READ)
744                                         mode[0] = 'r';
745                                 if (__le32_to_cpu(omd->cr_openflags) &
746                            (MDS_FMODE_WRITE | MDS_OPEN_TRUNC | MDS_OPEN_APPEND))
747                                         mode[1] = 'w';
748                         }
749
750                         if (strcmp(mode, "---") != 0)
751                                 printf(" mode:%s", mode);
752                 }
753
754                 if (ef->cr_extra_flags & CLFE_XATTR) {
755                         struct changelog_ext_xattr *xattr =
756                                 changelog_rec_xattr(&rec->cr);
757
758                         if (xattr->cr_xattr[0] != '\0')
759                                 printf(" xattr:%s", xattr->cr_xattr);
760                 }
761         }
762
763         if (rec->cr.cr_namelen)
764                 printf(" parent:"DFID" name:%.*s", PFID(&rec->cr.cr_pfid),
765                        __le32_to_cpu(rec->cr.cr_namelen),
766                        changelog_rec_name(&rec->cr));
767
768         if (rec->cr.cr_flags & CLF_RENAME) {
769                 struct changelog_ext_rename *rnm =
770                         changelog_rec_rename(&rec->cr);
771
772                 if (!fid_is_zero(&rnm->cr_sfid))
773                         printf(" source_fid:"DFID" source_parent_fid:"DFID
774                                " %.*s",
775                                PFID(&rnm->cr_sfid),
776                                PFID(&rnm->cr_spfid),
777                                (int)__le32_to_cpu(
778                                        changelog_rec_snamelen(&rec->cr)),
779                                changelog_rec_sname(&rec->cr));
780         }
781         printf("\n");
782 }
783
784 static void lustre_swab_lu_fid(struct lu_fid *fid)
785 {
786         fid->f_seq = __swab64(fid->f_seq);
787         fid->f_oid = __swab32(fid->f_oid);
788         fid->f_ver = __swab32(fid->f_ver);
789 }
790
791 static inline size_t
792 update_op_size(unsigned int param_count)
793 {
794         return offsetof(struct update_op, uop_params_off[param_count]);
795 }
796
797
798 static inline struct update_op *
799 update_op_next_op(const struct update_op *uop)
800 {
801         return (struct update_op *)((char *)uop +
802                                 update_op_size(uop->uop_param_count));
803 }
804
805 static void lustre_swab_update_ops(struct update_ops *uops,
806                                    unsigned int op_count)
807 {
808         unsigned int i;
809         unsigned int j;
810
811         struct update_op *op =
812                (struct update_op *)((char *)&uops->uops_op[0]);
813
814         for (i = 0; i < op_count; i++, op = update_op_next_op(op)) {
815                 lustre_swab_lu_fid(&op->uop_fid);
816                 op->uop_type = __swab16(op->uop_type);
817                 op->uop_param_count = __swab16(op->uop_param_count);
818                 for (j = 0; j < op->uop_param_count; j++)
819                         op->uop_params_off[j] = __swab16(op->uop_params_off[j]);
820         }
821 }
822 static const char *update_op_str(__u16 opc)
823 {
824         static const char *opc_str[] = {
825                 [OUT_START] = "start",
826                 [OUT_CREATE] = "create",
827                 [OUT_DESTROY] = "destroy",
828                 [OUT_REF_ADD] = "ref_add",
829                 [OUT_REF_DEL] = "ref_del",
830                 [OUT_ATTR_SET] = "attr_set",
831                 [OUT_ATTR_GET] = "attr_get",
832                 [OUT_XATTR_SET] = "xattr_set",
833                 [OUT_XATTR_GET] = "xattr_get",
834                 [OUT_XATTR_LIST] = "xattr_list",
835                 [OUT_INDEX_LOOKUP] = "lookup",
836                 [OUT_INDEX_INSERT] = "insert",
837                 [OUT_INDEX_DELETE] = "delete",
838                 [OUT_WRITE] = "write",
839                 [OUT_XATTR_DEL] = "xattr_del",
840                 [OUT_PUNCH] = "punch",
841                 [OUT_READ] = "read",
842                 [OUT_NOOP] = "noop",
843         };
844
845         if (opc < (sizeof(opc_str) / sizeof((opc_str)[0])) &&
846             opc_str[opc] != NULL)
847                 return opc_str[opc];
848         else
849                 return "unknown";
850 }
851
852 char *buf2str(void *buf, unsigned int size)
853 {
854         const char *hex = "0123456789ABCDEF";
855         char *buf_c = buf;
856         static char string[128];
857         int i, j = 0;
858         bool format_hex = false;
859
860         if (size > 0 && buf_c[size - 1] == 0)
861                 size--;
862         for (i = 0; i < size; i++) {
863                 if (buf_c[i] >= 0x20 && buf_c[i] <= 0x7E) {
864                         string[j++] = buf_c[i];
865                         format_hex = false;
866                 } else if (j < sizeof(string) - 6) {
867                         if (!format_hex) {
868                                 string[j++] = '\\';
869                                 string[j++] = 'x';
870                                 format_hex = true;
871                         }
872                         string[j++] = hex[(buf_c[i] >> 4) & 0xF];
873                         string[j++] = hex[buf_c[i] & 0xF];
874                 } else {
875                         break;
876                 }
877                 if (j == sizeof(string) - 2)
878                         break;
879         }
880         string[j] = 0;
881         return string;
882 }
883
884 static inline size_t
885 object_update_param_size(const struct object_update_param *param)
886 {
887         return roundup(sizeof(*param) + param->oup_len, sizeof(__u64));
888 }
889
890 void print_update_rec(struct llog_update_record *lur)
891 {
892         struct update_records *rec = &lur->lur_update_rec;
893         unsigned int i, j, up_count, pm_count;
894         struct update_op *op;
895         struct object_update_param *pm;
896
897         up_count = __le32_to_cpu(rec->ur_update_count);
898         pm_count = __le32_to_cpu(rec->ur_param_count);
899         printf("updatelog record master_transno:%llu batchid:%llu flags:0x%x u_index:%d u_count:%d p_count:%d\n",
900                (unsigned long long)__le64_to_cpu(rec->ur_master_transno),
901                (unsigned long long)__le64_to_cpu(rec->ur_batchid),
902                __le32_to_cpu(rec->ur_flags),
903                __le32_to_cpu(rec->ur_index),
904                up_count,
905                pm_count);
906
907         op = (struct update_op *)((char *)&rec->ur_ops.uops_op[0] + 0);
908         if (op->uop_type != __le16_to_cpu(op->uop_type))
909                 lustre_swab_update_ops(&rec->ur_ops, up_count);
910
911         for (i = 0; i < up_count; i++, op = update_op_next_op(op)) {
912                 printf("\t"DFID" type:%s/%d params:%d ",
913                        PFID(&op->uop_fid), update_op_str(op->uop_type),
914                        op->uop_type, op->uop_param_count);
915                 for (j = 0; j < op->uop_param_count; j++)
916                         printf("p_%d:%d ", j, op->uop_params_off[j]);
917                 printf("\n");
918         }
919         pm = (struct object_update_param *) op;
920         for (i = 0; i < pm_count; i++) {
921                 printf("\tp_%d - %d/%s\n", i, pm->oup_len,
922                        buf2str(pm->oup_buf, pm->oup_len));
923                 pm = (struct object_update_param *)((char *)pm +
924                      object_update_param_size(pm));
925         }
926         printf("\n");
927
928 }
929
930 static void print_unlink_rec(struct llog_unlink_rec *lur)
931 {
932         printf("unlink record id:0x%x target %llx:%x:%x\n",
933                 __le32_to_cpu(lur->lur_hdr.lrh_id),
934                 (unsigned long long)__le64_to_cpu(lur->lur_oid),
935                 __le32_to_cpu(lur->lur_oseq),
936                 __le32_to_cpu(lur->lur_count));
937 }
938
939 static void print_unlink64_rec(struct llog_unlink64_rec *lur)
940 {
941         printf("unlink64 record id:0x%x target "DFID"\n",
942                 __le32_to_cpu(lur->lur_hdr.lrh_id),
943                 PFID(&lur->lur_fid));
944 }
945
946 static void print_setattr64_rec(struct llog_setattr64_rec *lsr)
947 {
948         printf("setattr64 record id:0x%x target "DFID" valid %llx uid %u:%u gid %u:%u\n",
949                 __le32_to_cpu(lsr->lsr_hdr.lrh_id),
950                 PFID(&lsr->lsr_oi.oi_fid),
951                 (unsigned long long)__le64_to_cpu(lsr->lsr_valid),
952                 __le32_to_cpu(lsr->lsr_uid_h),
953                 __le32_to_cpu(lsr->lsr_uid),
954                 __le32_to_cpu(lsr->lsr_gid_h),
955                 __le32_to_cpu(lsr->lsr_gid));
956 }
957
958 static void print_setattr64_rec_v2(struct llog_setattr64_rec_v2 *lsr)
959 {
960         printf("setattr64 v2 record id:0x%x target "DFID" valid %llx uid %u:%u gid %u:%u prj %u\n",
961                 __le32_to_cpu(lsr->lsr_hdr.lrh_id),
962                 PFID(&lsr->lsr_oi.oi_fid),
963                 (unsigned long long)__le64_to_cpu(lsr->lsr_valid),
964                 __le32_to_cpu(lsr->lsr_uid_h),
965                 __le32_to_cpu(lsr->lsr_uid),
966                 __le32_to_cpu(lsr->lsr_gid_h),
967                 __le32_to_cpu(lsr->lsr_gid),
968                 __le32_to_cpu(lsr->lsr_projid));
969 }
970
971
972 static void print_records(struct llog_rec_hdr **recs,
973                           int rec_number, int is_ext)
974 {
975         __u32 lopt;
976         int i, skip = 0;
977
978         for (i = 0; i < rec_number; i++) {
979                 if (!recs[i]) {
980                         llapi_printf(LLAPI_MSG_NORMAL,
981                                      "uninitialized llog record at index %d\n",
982                                      i);
983                         break;
984                 }
985                 printf("#%.2d (%.3d)", __le32_to_cpu(recs[i]->lrh_index),
986                        __le32_to_cpu(recs[i]->lrh_len));
987
988                 lopt = __le32_to_cpu(recs[i]->lrh_type);
989
990                 if (recs[i]->lrh_id == CANCELLED)
991                         printf("NOT SET ");
992
993                 switch (lopt) {
994                 case OBD_CFG_REC:
995                         print_lustre_cfg(
996                                 (struct lustre_cfg *)((char *)(recs[i]) +
997                                 sizeof(struct llog_rec_hdr)), &skip);
998                         break;
999                 case LLOG_PAD_MAGIC:
1000                         printf("padding\n");
1001                         break;
1002                 case LLOG_LOGID_MAGIC:
1003                         print_log_path((struct llog_logid_rec *)recs[i],
1004                                        is_ext);
1005                         break;
1006                 case HSM_AGENT_REC:
1007                         print_hsm_action((struct llog_agent_req_rec *)recs[i]);
1008                         break;
1009                 case CHANGELOG_REC:
1010                         print_changelog_rec((struct llog_changelog_rec *)
1011                                             recs[i]);
1012                         break;
1013                 case CHANGELOG_USER_REC:
1014                 case CHANGELOG_USER_REC2:
1015                         printf("changelog_user record id:0x%x\n",
1016                                __le32_to_cpu(recs[i]->lrh_id));
1017                         break;
1018                 case UPDATE_REC:
1019                         print_update_rec((struct llog_update_record *)recs[i]);
1020                         break;
1021                 case MDS_UNLINK_REC:
1022                         print_unlink_rec((struct llog_unlink_rec *)recs[i]);
1023                         break;
1024                 case MDS_UNLINK64_REC:
1025                         print_unlink64_rec((struct llog_unlink64_rec *)recs[i]);
1026                         break;
1027                 case MDS_SETATTR64_REC:
1028                         if (__le32_to_cpu(recs[i]->lrh_len) >
1029                                 sizeof(struct llog_setattr64_rec)) {
1030                                 print_setattr64_rec_v2(
1031                                   (struct llog_setattr64_rec_v2 *)recs[i]);
1032                         } else {
1033                                 print_setattr64_rec(
1034                                         (struct llog_setattr64_rec *)recs[i]);
1035                         }
1036                         break;
1037                 default:
1038                         printf("unknown type %x\n", lopt);
1039                         break;
1040                 }
1041         }
1042 }
1043
1044 /** @} llog_reader */