4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2015, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 /** \defgroup llog_reader Lustre Log Reader
38 * Interpret llogs used for storing configuration and changelog data
44 #include <sys/types.h>
52 #include <linux/magic.h>
55 #include <lnet/nidstr.h>
56 #include <lustre/lustre_idl.h>
57 #include <lustre/lustreapi.h>
58 #include <lustre_log_user.h>
59 #include <lustre_cfg.h>
61 static inline int ext2_test_bit(int nr, const void *addr)
63 #if __BYTE_ORDER == __BIG_ENDIAN
64 const unsigned char *tmp = addr;
65 return (tmp[nr >> 3] >> (nr & 7)) & 1;
67 const unsigned long *tmp = addr;
68 return ((1UL << (nr & (BITS_PER_LONG - 1))) &
69 ((tmp)[nr / BITS_PER_LONG])) != 0;
73 int llog_pack_buffer(int fd, struct llog_log_hdr **llog_buf,
74 struct llog_rec_hdr ***recs, int *recs_number);
76 void print_llog_header(struct llog_log_hdr *llog_buf);
77 static void print_records(struct llog_rec_hdr **recs_buf,
78 int rec_number, int is_ext);
79 void llog_unpack_buffer(int fd, struct llog_log_hdr *llog_buf,
80 struct llog_rec_hdr **recs_buf);
82 #define CANCELLED 0x678
84 #define PTL_CMD_BASE 100
85 char* portals_command[17]=
106 int is_fstype_ext(int fd)
111 rc = fstatfs(fd, &st);
113 llapi_error(LLAPI_MSG_ERROR, rc, "Got statfs error.");
117 return (st.f_type == EXT4_SUPER_MAGIC);
122 * Attempt to display a path to the object (file) containing changelog entries,
123 * referred to by this changelog_catalog record.
125 * This path depends on the implementation of the OSD device; zfs-osd and
126 * ldiskfs-osd are different.
128 * Assumes that if the file system containing the changelog_catalog is
129 * ext{2,3,4}, the backend is ldiskfs-osd; otherwise it is either zfs-osd or at
130 * least names objects based on FID and the zfs-osd path (which includes the
131 * FID) will be sufficient.
133 * The Object ID stored in the record is also displayed untranslated.
135 #define OSD_OI_FID_NR (1UL << 7)
136 static void print_log_path(struct llog_logid_rec *lid, int is_ext)
139 char object_path[255];
140 struct lu_fid fid_from_logid;
142 logid_to_fid(&lid->lid_id, &fid_from_logid);
145 snprintf(object_path, sizeof(object_path),
146 "O/"LPU64"/d%u/%u", fid_from_logid.f_seq,
147 fid_from_logid.f_oid % 32, fid_from_logid.f_oid);
149 snprintf(object_path, sizeof(object_path),
150 "oi."LPU64"/"DFID_NOBRACE,
151 fid_from_logid.f_seq & (OSD_OI_FID_NR - 1) ,
152 PFID(&fid_from_logid));
154 printf("ogen=%X id="DOSTID" path=%s\n",
155 lid->lid_id.lgl_ogen, POSTID(&lid->lid_id.lgl_oi),
159 int main(int argc, char **argv)
164 struct llog_log_hdr *llog_buf = NULL;
165 struct llog_rec_hdr **recs_buf = NULL;
170 printf("Usage: llog_reader filename\n");
174 fd = open(argv[1], O_RDONLY);
177 llapi_error(LLAPI_MSG_ERROR, rc, "Could not open the file %s.",
182 is_ext = is_fstype_ext(fd);
184 printf("Unable to determine type of filesystem containing %s\n",
189 rc = llog_pack_buffer(fd, &llog_buf, &recs_buf, &rec_number);
191 llapi_error(LLAPI_MSG_ERROR, rc, "Could not pack buffer.");
195 print_llog_header(llog_buf);
196 print_records(recs_buf, rec_number, is_ext);
197 llog_unpack_buffer(fd, llog_buf, recs_buf);
207 int llog_pack_buffer(int fd, struct llog_log_hdr **llog,
208 struct llog_rec_hdr ***recs,
211 int rc = 0, recs_num, rd = 0;
214 char *file_buf = NULL, *recs_buf = NULL;
215 struct llog_rec_hdr **recs_pr = NULL;
222 llapi_error(LLAPI_MSG_ERROR, rc, "Got file stat error.");
226 file_size = st.st_size;
227 if (file_size < sizeof(**llog)) {
228 llapi_error(LLAPI_MSG_ERROR, rc,
229 "File too small for llog header: "
230 "need %zd, size %lld\n",
231 sizeof(**llog), file_size);
236 file_buf = malloc(file_size);
237 if (file_buf == NULL) {
239 llapi_error(LLAPI_MSG_ERROR, rc, "Memory Alloc for file_buf.");
242 *llog = (struct llog_log_hdr *)file_buf;
245 rc = read(fd, file_buf + rd, file_size - rd);
248 } while (rc > 0 && rd < file_size);
250 if (rd < file_size) {
251 rc = rc < 0 ? -errno : -EIO;
252 llapi_error(LLAPI_MSG_ERROR, rc,
253 "Error reading llog header: need %zd, got %d",
258 /* the llog header not countable here.*/
259 recs_num = le32_to_cpu((*llog)->llh_count) - 1;
261 recs_buf = malloc(recs_num * sizeof(**recs_pr));
262 if (recs_buf == NULL) {
264 llapi_error(LLAPI_MSG_ERROR, rc,
265 "Error allocating %zd bytes for recs_buf",
266 recs_num * sizeof(**recs_pr));
269 recs_pr = (struct llog_rec_hdr **)recs_buf;
271 ptr = file_buf + le32_to_cpu((*llog)->llh_hdr.lrh_len);
274 while (ptr < (file_buf + file_size)) {
275 struct llog_rec_hdr *cur_rec;
277 unsigned long offset;
279 if (ptr + sizeof(**recs_pr) > file_buf + file_size) {
281 llapi_error(LLAPI_MSG_ERROR, rc,
282 "The log is corrupt (too big at %d)", i);
286 cur_rec = (struct llog_rec_hdr *)ptr;
287 idx = le32_to_cpu(cur_rec->lrh_index);
288 recs_pr[i] = cur_rec;
289 offset = (unsigned long)ptr - (unsigned long)file_buf;
290 if (cur_rec->lrh_len == 0 ||
291 cur_rec->lrh_len > (*llog)->llh_hdr.lrh_len) {
292 cur_rec->lrh_len = (*llog)->llh_hdr.lrh_len -
293 offset % (*llog)->llh_hdr.lrh_len;
294 printf("off %lu skip %u to next chunk.\n", offset,
297 } else if (ext2_test_bit(idx, LLOG_HDR_BITMAP(*llog))) {
298 printf("rec #%d type=%x len=%u offset %lu\n", idx,
299 cur_rec->lrh_type, cur_rec->lrh_len, offset);
301 printf("Bit %d of %d not set\n", idx, recs_num);
302 cur_rec->lrh_id = CANCELLED;
303 /* The header counts only set records */
307 ptr += le32_to_cpu(cur_rec->lrh_len);
308 if ((ptr - file_buf) > file_size) {
309 printf("The log is corrupt (too big at %d)\n", i);
317 *recs_number = recs_num;
332 void llog_unpack_buffer(int fd, struct llog_log_hdr *llog_buf,
333 struct llog_rec_hdr **recs_buf)
340 void print_llog_header(struct llog_log_hdr *llog_buf)
344 printf("Header size : %u\n",
345 le32_to_cpu(llog_buf->llh_hdr.lrh_len));
347 t = le64_to_cpu(llog_buf->llh_timestamp);
348 printf("Time : %s", ctime(&t));
350 printf("Number of records: %u\n",
351 le32_to_cpu(llog_buf->llh_count)-1);
353 printf("Target uuid : %s \n",
354 (char *)(&llog_buf->llh_tgtuuid));
356 /* Add the other info you want to view here */
358 printf("-----------------------\n");
362 static void print_1_cfg(struct lustre_cfg *lcfg)
367 printf("nid=%s("LPX64") ", libcfs_nid2str(lcfg->lcfg_nid),
370 printf("nal=%d ", lcfg->lcfg_nal);
371 for (i = 0; i < lcfg->lcfg_bufcount; i++)
372 printf("%d:%.*s ", i, lcfg->lcfg_buflens[i],
373 (char*)lustre_cfg_buf(lcfg, i));
378 static void print_setup_cfg(struct lustre_cfg *lcfg)
380 struct lov_desc *desc;
382 if ((lcfg->lcfg_bufcount == 2) &&
383 (lcfg->lcfg_buflens[1] == sizeof(*desc))) {
384 printf("lov_setup ");
385 printf("0:%s ", lustre_cfg_string(lcfg, 0));
386 printf("1:(struct lov_desc)\n");
387 desc = (struct lov_desc*)(lustre_cfg_string(lcfg, 1));
388 printf("\t\tuuid=%s ", (char*)desc->ld_uuid.uuid);
389 printf("stripe:cnt=%u ", desc->ld_default_stripe_count);
390 printf("size="LPU64" ", desc->ld_default_stripe_size);
391 printf("offset="LPU64" ", desc->ld_default_stripe_offset);
392 printf("pattern=%#x", desc->ld_pattern);
401 void print_lustre_cfg(struct lustre_cfg *lcfg, int *skip)
403 enum lcfg_command_type cmd = le32_to_cpu(lcfg->lcfg_command);
415 print_setup_cfg(lcfg);
428 case(LCFG_ADD_UUID):{
433 case(LCFG_DEL_UUID):{
438 case(LCFG_ADD_CONN):{
443 case(LCFG_DEL_CONN):{
448 case(LCFG_LOV_ADD_OBD):{
449 printf("lov_modify_tgts add ");
453 case(LCFG_LOV_DEL_OBD):{
454 printf("lov_modify_tgts del ");
459 printf("modify_mdc_tgts add ");
464 printf("modify_mdc_tgts del ");
468 case(LCFG_MOUNTOPT):{
469 printf("mount_option ");
473 case(LCFG_DEL_MOUNTOPT):{
474 printf("del_mount_option ");
478 case(LCFG_SET_TIMEOUT):{
479 printf("set_timeout=%d ", lcfg->lcfg_num);
482 case(LCFG_SET_LDLM_TIMEOUT):{
483 printf("set_ldlm_timeout=%d ", lcfg->lcfg_num);
486 case(LCFG_SET_UPCALL):{
487 printf("set_lustre_upcall ");
496 case(LCFG_SET_PARAM):{
497 printf("set_param ");
501 case(LCFG_SPTLRPC_CONF):{
502 printf("sptlrpc_conf ");
507 struct cfg_marker *marker = lustre_cfg_buf(lcfg, 1);
508 char createtime[26], canceltime[26] = "";
511 if (marker->cm_flags & CM_START &&
512 marker->cm_flags & CM_SKIP) {
513 printf("SKIP START ");
515 } else if (marker->cm_flags & CM_END) {
520 if (marker->cm_flags & CM_EXCLUDE) {
521 if (marker->cm_flags & CM_START)
522 printf("EXCLUDE START ");
524 printf("EXCLUDE END ");
527 /* Handle overflow of 32-bit time_t gracefully.
528 * The copy to time_tmp is needed in any case to
529 * keep the pointer happy, even on 64-bit systems. */
530 time_tmp = marker->cm_createtime;
531 if (time_tmp == marker->cm_createtime) {
532 ctime_r(&time_tmp, createtime);
533 createtime[strlen(createtime) - 1] = 0;
535 strcpy(createtime, "in the distant future");
538 if (marker->cm_canceltime) {
539 /* Like cm_createtime, we try to handle overflow of
540 * 32-bit time_t gracefully. The copy to time_tmp
541 * is also needed on 64-bit systems to keep the
542 * pointer happy, see bug 16771 */
543 time_tmp = marker->cm_canceltime;
544 if (time_tmp == marker->cm_canceltime) {
545 ctime_r(&time_tmp, canceltime);
546 canceltime[strlen(canceltime) - 1] = 0;
548 strcpy(canceltime, "in the distant future");
552 printf("marker %3d (flags=%#04x, v%d.%d.%d.%d) %-15s '%s' %s-%s",
553 marker->cm_step, marker->cm_flags,
554 OBD_OCD_VERSION_MAJOR(marker->cm_vers),
555 OBD_OCD_VERSION_MINOR(marker->cm_vers),
556 OBD_OCD_VERSION_PATCH(marker->cm_vers),
557 OBD_OCD_VERSION_FIX(marker->cm_vers),
558 marker->cm_tgtname, marker->cm_comment,
559 createtime, canceltime);
562 case(LCFG_POOL_NEW):{
567 case(LCFG_POOL_ADD):{
572 case(LCFG_POOL_REM):{
573 printf("pool remove ");
577 case(LCFG_POOL_DEL):{
578 printf("pool destroy ");
583 printf("unsupported cmd_code = %x\n",cmd);
589 static void print_hsm_action(struct llog_agent_req_rec *larr)
594 sz = larr->arr_hai.hai_len - sizeof(larr->arr_hai);
595 printf("lrh=[type=%X len=%d idx=%d] fid="DFID
596 " compound/cookie="LPX64"/"LPX64
597 " status=%s action=%s archive#=%d flags="LPX64
598 " create="LPU64" change="LPU64
599 " extent="LPX64"-"LPX64" gid="LPX64" datalen=%d"
601 larr->arr_hdr.lrh_type,
602 larr->arr_hdr.lrh_len, larr->arr_hdr.lrh_index,
603 PFID(&larr->arr_hai.hai_fid),
604 larr->arr_compound_id, larr->arr_hai.hai_cookie,
605 agent_req_status2name(larr->arr_status),
606 hsm_copytool_action2name(larr->arr_hai.hai_action),
607 larr->arr_archive_id,
609 larr->arr_req_create, larr->arr_req_change,
610 larr->arr_hai.hai_extent.offset,
611 larr->arr_hai.hai_extent.length,
612 larr->arr_hai.hai_gid, sz,
613 hai_dump_data_field(&larr->arr_hai, buf, sizeof(buf)));
616 void print_changelog_rec(struct llog_changelog_rec *rec)
618 printf("changelog record id:0x%x cr_flags:0x%x cr_type:%s(0x%x)\n",
619 le32_to_cpu(rec->cr_hdr.lrh_id),
620 le32_to_cpu(rec->cr.cr_flags),
621 changelog_type2str(le32_to_cpu(rec->cr.cr_type)),
622 le32_to_cpu(rec->cr.cr_type));
625 static void print_records(struct llog_rec_hdr **recs,
626 int rec_number, int is_ext)
631 for (i = 0; i < rec_number; i++) {
632 printf("#%.2d (%.3d)", le32_to_cpu(recs[i]->lrh_index),
633 le32_to_cpu(recs[i]->lrh_len));
635 lopt = le32_to_cpu(recs[i]->lrh_type);
637 if (recs[i]->lrh_id == CANCELLED)
643 (struct lustre_cfg *)((char *)(recs[i]) +
644 sizeof(struct llog_rec_hdr)), &skip);
649 case LLOG_LOGID_MAGIC:
650 print_log_path((struct llog_logid_rec *)recs[i],
654 print_hsm_action((struct llog_agent_req_rec *)recs[i]);
657 print_changelog_rec((struct llog_changelog_rec *)
660 case CHANGELOG_USER_REC:
661 printf("changelog_user record id:0x%x\n",
662 le32_to_cpu(recs[i]->lrh_id));
665 printf("unknown type %x\n", lopt);
671 /** @} llog_reader */