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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  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
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36 /** \defgroup llog_reader Lustre Log Reader
  37  *
  38  * Interpret llogs used for storing configuration and changelog data
  39  *
  40  * @{
  41  */
  42
  43 #include <stdio.h>
  44 #include <sys/types.h>
  45 #include <sys/stat.h>
  46 #ifdef HAVE_ENDIAN_H
  47 # include <endian.h>
  48 #endif
  49 #include <unistd.h>
  50 #include <fcntl.h>
  51 #include <sys/vfs.h>
  52 #include <linux/magic.h>
  53
  54 #include <time.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>
  60
  61 static inline int ext2_test_bit(int nr, const void *addr)
  62 {
  63 #if __BYTE_ORDER == __BIG_ENDIAN
  64         const unsigned char *tmp = addr;
  65         return (tmp[nr >> 3] >> (nr & 7)) & 1;
  66 #else
  67         const unsigned long *tmp = addr;
  68         return ((1UL << (nr & (BITS_PER_LONG - 1))) &
  69                 ((tmp)[nr / BITS_PER_LONG])) != 0;
  70 #endif
  71 }
  72
  73 int llog_pack_buffer(int fd, struct llog_log_hdr **llog_buf,
  74                      struct llog_rec_hdr ***recs, int *recs_number);
  75
  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);
  81
  82 #define CANCELLED 0x678
  83
  84 #define PTL_CMD_BASE 100
  85 char* portals_command[17]=
  86 {
  87         "REGISTER_PEER_FD",
  88         "CLOSE_CONNECTION",
  89         "REGISTER_MYNID",
  90         "PUSH_CONNECTION",
  91         "GET_CONN",
  92         "DEL_PEER",
  93         "ADD_PEER",
  94         "GET_PEER",
  95         "GET_TXDESC",
  96         "ADD_ROUTE",
  97         "DEL_ROUTE",
  98         "GET_ROUTE",
  99         "NOTIFY_ROUTER",
 100         "ADD_INTERFACE",
 101         "DEL_INTERFACE",
 102         "GET_INTERFACE",
 103         ""
 104 };
 105
 106 int is_fstype_ext(int fd)
 107 {
 108         struct statfs           st;
 109         int                     rc;
 110
 111         rc = fstatfs(fd, &st);
 112         if (rc < 0) {
 113                 llapi_error(LLAPI_MSG_ERROR, rc, "Got statfs error.");
 114                 return -errno;
 115         }
 116
 117         return (st.f_type == EXT4_SUPER_MAGIC);
 118 }
 119
 120
 121 /**
 122  * Attempt to display a path to the object (file) containing changelog entries,
 123  * referred to by this changelog_catalog record.
 124  *
 125  * This path depends on the implementation of the OSD device; zfs-osd and
 126  * ldiskfs-osd are different.
 127  *
 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.
 132  *
 133  * The Object ID stored in the record is also displayed untranslated.
 134  */
 135 #define OSD_OI_FID_NR         (1UL << 7)
 136 static void print_log_path(struct llog_logid_rec *lid, int is_ext)
 137 {
 138
 139         char                    object_path[255];
 140         struct lu_fid           fid_from_logid;
 141
 142         logid_to_fid(&lid->lid_id, &fid_from_logid);
 143
 144         if (is_ext)
 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);
 148         else
 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));
 153
 154         printf("ogen=%X id="DOSTID" path=%s\n",
 155                 lid->lid_id.lgl_ogen, POSTID(&lid->lid_id.lgl_oi),
 156                 object_path);
 157 }
 158
 159 int main(int argc, char **argv)
 160 {
 161         int rc = 0;
 162         int is_ext;
 163         int fd, rec_number;
 164         struct llog_log_hdr *llog_buf = NULL;
 165         struct llog_rec_hdr **recs_buf = NULL;
 166
 167         setlinebuf(stdout);
 168
 169         if (argc != 2) {
 170                 printf("Usage: llog_reader filename\n");
 171                 return -1;
 172         }
 173
 174         fd = open(argv[1], O_RDONLY);
 175         if (fd < 0) {
 176                 rc = -errno;
 177                 llapi_error(LLAPI_MSG_ERROR, rc, "Could not open the file %s.",
 178                             argv[1]);
 179                 goto out;
 180         }
 181
 182         is_ext = is_fstype_ext(fd);
 183         if (is_ext < 0) {
 184                 printf("Unable to determine type of filesystem containing %s\n",
 185                        argv[1]);
 186                 goto out;
 187         }
 188
 189         rc = llog_pack_buffer(fd, &llog_buf, &recs_buf, &rec_number);
 190         if (rc < 0) {
 191                 llapi_error(LLAPI_MSG_ERROR, rc, "Could not pack buffer.");
 192                 goto out_fd;
 193         }
 194
 195         print_llog_header(llog_buf);
 196         print_records(recs_buf, rec_number, is_ext);
 197         llog_unpack_buffer(fd, llog_buf, recs_buf);
 198
 199 out_fd:
 200         close(fd);
 201 out:
 202         return rc;
 203 }
 204
 205
 206
 207 int llog_pack_buffer(int fd, struct llog_log_hdr **llog,
 208                      struct llog_rec_hdr ***recs,
 209                      int *recs_number)
 210 {
 211         int rc = 0, recs_num, rd;
 212         off_t file_size;
 213         struct stat st;
 214         char *file_buf = NULL, *recs_buf = NULL;
 215         struct llog_rec_hdr **recs_pr = NULL;
 216         char *ptr = NULL;
 217         int i;
 218
 219         rc = fstat(fd, &st);
 220         if (rc < 0) {
 221                 rc = -errno;
 222                 llapi_error(LLAPI_MSG_ERROR, rc, "Got file stat error.");
 223                 goto out;
 224         }
 225         file_size = st.st_size;
 226         if (file_size == 0) {
 227                 rc = -1;
 228                 llapi_error(LLAPI_MSG_ERROR, rc, "File is empty.");
 229                 goto out;
 230         }
 231
 232         file_buf = malloc(file_size);
 233         if (file_buf == NULL) {
 234                 rc = -ENOMEM;
 235                 llapi_error(LLAPI_MSG_ERROR, rc, "Memory Alloc for file_buf.");
 236                 goto out;
 237         }
 238         *llog = (struct llog_log_hdr *)file_buf;
 239
 240         rd = read(fd, file_buf, file_size);
 241         if (rd < file_size) {
 242                 rc = -EIO; /*FIXME*/
 243                 llapi_error(LLAPI_MSG_ERROR, rc, "Read file error.");
 244                 goto clear_file_buf;
 245         }
 246
 247         /* the llog header not countable here.*/
 248         recs_num = le32_to_cpu((*llog)->llh_count) - 1;
 249
 250         recs_buf = malloc(recs_num * sizeof(struct llog_rec_hdr *));
 251         if (recs_buf == NULL) {
 252                 rc = -ENOMEM;
 253                 llapi_error(LLAPI_MSG_ERROR, rc, "Memory Alloc for recs_buf.");
 254                 goto clear_file_buf;
 255         }
 256         recs_pr = (struct llog_rec_hdr **)recs_buf;
 257
 258         ptr = file_buf + le32_to_cpu((*llog)->llh_hdr.lrh_len);
 259         i = 0;
 260
 261         while (i < recs_num) {
 262                 struct llog_rec_hdr *cur_rec;
 263                 int idx;
 264
 265                 if (ptr + sizeof(struct llog_rec_hdr) >
 266                     file_buf + file_size) {
 267                         rc = -EINVAL;
 268                         llapi_error(LLAPI_MSG_ERROR, rc,
 269                                     "The log is corrupt (too big at %d)", i);
 270                         goto clear_recs_buf;
 271                 }
 272
 273                 cur_rec = (struct llog_rec_hdr *)ptr;
 274                 idx = le32_to_cpu(cur_rec->lrh_index);
 275                 recs_pr[i] = cur_rec;
 276
 277                 if (ext2_test_bit(idx, LLOG_HDR_BITMAP(*llog))) {
 278                         printf("rec #%d type=%x len=%u\n", idx,
 279                                cur_rec->lrh_type, cur_rec->lrh_len);
 280                 } else {
 281                         printf("Bit %d of %d not set\n", idx, recs_num);
 282                         cur_rec->lrh_id = CANCELLED;
 283                         /* The header counts only set records */
 284                         i--;
 285                 }
 286
 287                 ptr += le32_to_cpu(cur_rec->lrh_len);
 288                 if ((ptr - file_buf) > file_size) {
 289                         printf("The log is corrupt (too big at %d)\n", i);
 290                         rc = -EINVAL;
 291                         goto clear_recs_buf;
 292                 }
 293                 i++;
 294         }
 295
 296         *recs = recs_pr;
 297         *recs_number = recs_num;
 298
 299 out:
 300         return rc;
 301
 302 clear_recs_buf:
 303         free(recs_buf);
 304
 305 clear_file_buf:
 306         free(file_buf);
 307
 308         *llog = NULL;
 309         goto out;
 310 }
 311
 312 void llog_unpack_buffer(int fd, struct llog_log_hdr *llog_buf,
 313                         struct llog_rec_hdr **recs_buf)
 314 {
 315         free(llog_buf);
 316         free(recs_buf);
 317         return;
 318 }
 319
 320 void print_llog_header(struct llog_log_hdr *llog_buf)
 321 {
 322         time_t t;
 323
 324         printf("Header size : %u\n",
 325                le32_to_cpu(llog_buf->llh_hdr.lrh_len));
 326
 327         t = le64_to_cpu(llog_buf->llh_timestamp);
 328         printf("Time : %s", ctime(&t));
 329
 330         printf("Number of records: %u\n",
 331                le32_to_cpu(llog_buf->llh_count)-1);
 332
 333         printf("Target uuid : %s \n",
 334                (char *)(&llog_buf->llh_tgtuuid));
 335
 336         /* Add the other info you want to view here */
 337
 338         printf("-----------------------\n");
 339         return;
 340 }
 341
 342 static void print_1_cfg(struct lustre_cfg *lcfg)
 343 {
 344         int i;
 345
 346         if (lcfg->lcfg_nid)
 347                 printf("nid=%s("LPX64")  ", libcfs_nid2str(lcfg->lcfg_nid),
 348                        lcfg->lcfg_nid);
 349         if (lcfg->lcfg_nal)
 350                 printf("nal=%d ", lcfg->lcfg_nal);
 351         for (i = 0; i <  lcfg->lcfg_bufcount; i++)
 352                 printf("%d:%.*s  ", i, lcfg->lcfg_buflens[i],
 353                        (char*)lustre_cfg_buf(lcfg, i));
 354         return;
 355 }
 356
 357
 358 static void print_setup_cfg(struct lustre_cfg *lcfg)
 359 {
 360         struct lov_desc *desc;
 361
 362         if ((lcfg->lcfg_bufcount == 2) &&
 363             (lcfg->lcfg_buflens[1] == sizeof(*desc))) {
 364                 printf("lov_setup ");
 365                 printf("0:%s  ", lustre_cfg_string(lcfg, 0));
 366                 printf("1:(struct lov_desc)\n");
 367                 desc = (struct lov_desc*)(lustre_cfg_string(lcfg, 1));
 368                 printf("\t\tuuid=%s  ", (char*)desc->ld_uuid.uuid);
 369                 printf("stripe:cnt=%u ", desc->ld_default_stripe_count);
 370                 printf("size="LPU64" ", desc->ld_default_stripe_size);
 371                 printf("offset="LPU64" ", desc->ld_default_stripe_offset);
 372                 printf("pattern=%#x", desc->ld_pattern);
 373         } else {
 374                 printf("setup     ");
 375                 print_1_cfg(lcfg);
 376         }
 377
 378         return;
 379 }
 380
 381 void print_lustre_cfg(struct lustre_cfg *lcfg, int *skip)
 382 {
 383         enum lcfg_command_type cmd = le32_to_cpu(lcfg->lcfg_command);
 384
 385         if (*skip > 0)
 386                 printf("SKIP ");
 387
 388         switch(cmd){
 389         case(LCFG_ATTACH):{
 390                 printf("attach    ");
 391                 print_1_cfg(lcfg);
 392                 break;
 393         }
 394         case(LCFG_SETUP):{
 395                 print_setup_cfg(lcfg);
 396                 break;
 397         }
 398         case(LCFG_DETACH):{
 399                 printf("detach    ");
 400                 print_1_cfg(lcfg);
 401                 break;
 402         }
 403         case(LCFG_CLEANUP):{
 404                 printf("cleanup   ");
 405                 print_1_cfg(lcfg);
 406                 break;
 407         }
 408         case(LCFG_ADD_UUID):{
 409                 printf("add_uuid  ");
 410                 print_1_cfg(lcfg);
 411                 break;
 412         }
 413         case(LCFG_DEL_UUID):{
 414                 printf("del_uuid  ");
 415                 print_1_cfg(lcfg);
 416                 break;
 417         }
 418         case(LCFG_ADD_CONN):{
 419                 printf("add_conn  ");
 420                 print_1_cfg(lcfg);
 421                 break;
 422         }
 423         case(LCFG_DEL_CONN):{
 424                 printf("del_conn  ");
 425                 print_1_cfg(lcfg);
 426                 break;
 427         }
 428         case(LCFG_LOV_ADD_OBD):{
 429                 printf("lov_modify_tgts add ");
 430                 print_1_cfg(lcfg);
 431                 break;
 432         }
 433         case(LCFG_LOV_DEL_OBD):{
 434                 printf("lov_modify_tgts del ");
 435                 print_1_cfg(lcfg);
 436                 break;
 437         }
 438         case(LCFG_ADD_MDC):{
 439                 printf("modify_mdc_tgts add ");
 440                 print_1_cfg(lcfg);
 441                 break;
 442         }
 443         case(LCFG_DEL_MDC):{
 444                 printf("modify_mdc_tgts del ");
 445                 print_1_cfg(lcfg);
 446                 break;
 447         }
 448         case(LCFG_MOUNTOPT):{
 449                 printf("mount_option ");
 450                 print_1_cfg(lcfg);
 451                 break;
 452         }
 453         case(LCFG_DEL_MOUNTOPT):{
 454                 printf("del_mount_option ");
 455                 print_1_cfg(lcfg);
 456                 break;
 457         }
 458         case(LCFG_SET_TIMEOUT):{
 459                 printf("set_timeout=%d ", lcfg->lcfg_num);
 460                 break;
 461         }
 462         case(LCFG_SET_LDLM_TIMEOUT):{
 463                 printf("set_ldlm_timeout=%d ", lcfg->lcfg_num);
 464                 break;
 465         }
 466         case(LCFG_SET_UPCALL):{
 467                 printf("set_lustre_upcall ");
 468                 print_1_cfg(lcfg);
 469                 break;
 470         }
 471         case(LCFG_PARAM):{
 472                 printf("param ");
 473                 print_1_cfg(lcfg);
 474                 break;
 475         }
 476         case(LCFG_SET_PARAM):{
 477                 printf("set_param ");
 478                 print_1_cfg(lcfg);
 479                 break;
 480         }
 481         case(LCFG_SPTLRPC_CONF):{
 482                 printf("sptlrpc_conf ");
 483                 print_1_cfg(lcfg);
 484                 break;
 485         }
 486         case(LCFG_MARKER):{
 487                 struct cfg_marker *marker = lustre_cfg_buf(lcfg, 1);
 488                 char createtime[26], canceltime[26] = "";
 489                 time_t time_tmp;
 490
 491                 if (marker->cm_flags & CM_SKIP) {
 492                         if (marker->cm_flags & CM_START) {
 493                                 printf("SKIP START ");
 494                                 (*skip)++;
 495                         } else {
 496                                 printf(     "END   ");
 497                                 *skip = 0;
 498                         }
 499                 }
 500
 501                 if (marker->cm_flags & CM_EXCLUDE) {
 502                         if (marker->cm_flags & CM_START)
 503                                 printf("EXCLUDE START ");
 504                         else
 505                                 printf("EXCLUDE END   ");
 506                 }
 507
 508                 /* Handle overflow of 32-bit time_t gracefully.
 509                  * The copy to time_tmp is needed in any case to
 510                  * keep the pointer happy, even on 64-bit systems. */
 511                 time_tmp = marker->cm_createtime;
 512                 if (time_tmp == marker->cm_createtime) {
 513                         ctime_r(&time_tmp, createtime);
 514                         createtime[strlen(createtime) - 1] = 0;
 515                 } else {
 516                         strcpy(createtime, "in the distant future");
 517                 }
 518
 519                 if (marker->cm_canceltime) {
 520                         /* Like cm_createtime, we try to handle overflow of
 521                          * 32-bit time_t gracefully. The copy to time_tmp
 522                          * is also needed on 64-bit systems to keep the
 523                          * pointer happy, see bug 16771 */
 524                         time_tmp = marker->cm_canceltime;
 525                         if (time_tmp == marker->cm_canceltime) {
 526                                 ctime_r(&time_tmp, canceltime);
 527                                 canceltime[strlen(canceltime) - 1] = 0;
 528                         } else {
 529                                 strcpy(canceltime, "in the distant future");
 530                         }
 531                 }
 532
 533                 printf("marker %3d (flags=%#04x, v%d.%d.%d.%d) %-15s '%s' %s-%s",
 534                        marker->cm_step, marker->cm_flags,
 535                        OBD_OCD_VERSION_MAJOR(marker->cm_vers),
 536                        OBD_OCD_VERSION_MINOR(marker->cm_vers),
 537                        OBD_OCD_VERSION_PATCH(marker->cm_vers),
 538                        OBD_OCD_VERSION_FIX(marker->cm_vers),
 539                        marker->cm_tgtname, marker->cm_comment,
 540                        createtime, canceltime);
 541                 break;
 542         }
 543         case(LCFG_POOL_NEW):{
 544                 printf("pool new ");
 545                 print_1_cfg(lcfg);
 546                 break;
 547         }
 548         case(LCFG_POOL_ADD):{
 549                 printf("pool add ");
 550                 print_1_cfg(lcfg);
 551                 break;
 552         }
 553         case(LCFG_POOL_REM):{
 554                 printf("pool remove ");
 555                 print_1_cfg(lcfg);
 556                 break;
 557         }
 558         case(LCFG_POOL_DEL):{
 559                 printf("pool destroy ");
 560                 print_1_cfg(lcfg);
 561                 break;
 562         }
 563         default:
 564                 printf("unsupported cmd_code = %x\n",cmd);
 565         }
 566         printf("\n");
 567         return;
 568 }
 569
 570 static void print_hsm_action(struct llog_agent_req_rec *larr)
 571 {
 572         char    buf[12];
 573         int     sz;
 574
 575         sz = larr->arr_hai.hai_len - sizeof(larr->arr_hai);
 576         printf("lrh=[type=%X len=%d idx=%d] fid="DFID
 577                " compound/cookie="LPX64"/"LPX64
 578                " status=%s action=%s archive#=%d flags="LPX64
 579                " create="LPU64" change="LPU64
 580                " extent="LPX64"-"LPX64" gid="LPX64" datalen=%d"
 581                " data=[%s]\n",
 582                larr->arr_hdr.lrh_type,
 583                larr->arr_hdr.lrh_len, larr->arr_hdr.lrh_index,
 584                PFID(&larr->arr_hai.hai_fid),
 585                larr->arr_compound_id, larr->arr_hai.hai_cookie,
 586                agent_req_status2name(larr->arr_status),
 587                hsm_copytool_action2name(larr->arr_hai.hai_action),
 588                larr->arr_archive_id,
 589                larr->arr_flags,
 590                larr->arr_req_create, larr->arr_req_change,
 591                larr->arr_hai.hai_extent.offset,
 592                larr->arr_hai.hai_extent.length,
 593                larr->arr_hai.hai_gid, sz,
 594                hai_dump_data_field(&larr->arr_hai, buf, sizeof(buf)));
 595 }
 596
 597 void print_changelog_rec(struct llog_changelog_rec *rec)
 598 {
 599         printf("changelog record id:0x%x cr_flags:0x%x cr_type:%s(0x%x)\n",
 600                le32_to_cpu(rec->cr_hdr.lrh_id),
 601                le32_to_cpu(rec->cr.cr_flags),
 602                changelog_type2str(le32_to_cpu(rec->cr.cr_type)),
 603                le32_to_cpu(rec->cr.cr_type));
 604 }
 605
 606 static void print_records(struct llog_rec_hdr **recs,
 607                           int rec_number, int is_ext)
 608 {
 609         __u32 lopt;
 610         int i, skip = 0;
 611
 612         for (i = 0; i < rec_number; i++) {
 613                 printf("#%.2d (%.3d)", le32_to_cpu(recs[i]->lrh_index),
 614                        le32_to_cpu(recs[i]->lrh_len));
 615
 616                 lopt = le32_to_cpu(recs[i]->lrh_type);
 617
 618                 if (recs[i]->lrh_id == CANCELLED)
 619                         printf("NOT SET ");
 620
 621                 switch (lopt) {
 622                 case OBD_CFG_REC:
 623                         print_lustre_cfg(
 624                                 (struct lustre_cfg *)((char *)(recs[i]) +
 625                                 sizeof(struct llog_rec_hdr)), &skip);
 626                         break;
 627                 case LLOG_PAD_MAGIC:
 628                         printf("padding\n");
 629                         break;
 630                 case LLOG_LOGID_MAGIC:
 631                         print_log_path((struct llog_logid_rec *)recs[i],
 632                                        is_ext);
 633                         break;
 634                 case HSM_AGENT_REC:
 635                         print_hsm_action((struct llog_agent_req_rec *)recs[i]);
 636                         break;
 637                 case CHANGELOG_REC:
 638                         print_changelog_rec((struct llog_changelog_rec *)
 639                                             recs[i]);
 640                         break;
 641                 case CHANGELOG_USER_REC:
 642                         printf("changelog_user record id:0x%x\n",
 643                                le32_to_cpu(recs[i]->lrh_id));
 644                         break;
 645                 default:
 646                         printf("unknown type %x\n", lopt);
 647                         break;
 648                 }
 649         }
 650 }
 651
 652 /** @} llog_reader */