lustre/obdclass/llog_swab.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) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 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  * lustre/obdclass/llog_swab.c
  37  *
  38  * Swabbing of llog datatypes (from disk or over the wire).
  39  *
  40  * Author: jacob berkman  <jacob@clusterfs.com>
  41  */
  42
  43 #define DEBUG_SUBSYSTEM S_LOG
  44
  45 #ifndef __KERNEL__
  46 #include <liblustre.h>
  47 #endif
  48
  49 #include <lustre_log.h>
  50
  51 static void print_llogd_body(struct llogd_body *d)
  52 {
  53         CDEBUG(D_OTHER, "llogd body: %p\n", d);
  54         CDEBUG(D_OTHER, "\tlgd_logid.lgl_oid: "LPX64"\n", d->lgd_logid.lgl_oid);
  55         CDEBUG(D_OTHER, "\tlgd_logid.lgl_oseq: "LPX64"\n", d->lgd_logid.lgl_oseq);
  56         CDEBUG(D_OTHER, "\tlgd_logid.lgl_ogen: %#x\n", d->lgd_logid.lgl_ogen);
  57         CDEBUG(D_OTHER, "\tlgd_ctxt_idx: %#x\n", d->lgd_ctxt_idx);
  58         CDEBUG(D_OTHER, "\tlgd_llh_flags: %#x\n", d->lgd_llh_flags);
  59         CDEBUG(D_OTHER, "\tlgd_index: %#x\n", d->lgd_index);
  60         CDEBUG(D_OTHER, "\tlgd_saved_index: %#x\n", d->lgd_saved_index);
  61         CDEBUG(D_OTHER, "\tlgd_len: %#x\n", d->lgd_len);
  62         CDEBUG(D_OTHER, "\tlgd_cur_offset: "LPX64"\n", d->lgd_cur_offset);
  63 }
  64
  65 void lustre_swab_llogd_body (struct llogd_body *d)
  66 {
  67         ENTRY;
  68         print_llogd_body(d);
  69         __swab64s (&d->lgd_logid.lgl_oid);
  70         __swab64s (&d->lgd_logid.lgl_oseq);
  71         __swab32s (&d->lgd_logid.lgl_ogen);
  72         __swab32s (&d->lgd_ctxt_idx);
  73         __swab32s (&d->lgd_llh_flags);
  74         __swab32s (&d->lgd_index);
  75         __swab32s (&d->lgd_saved_index);
  76         __swab32s (&d->lgd_len);
  77         __swab64s (&d->lgd_cur_offset);
  78         print_llogd_body(d);
  79         EXIT;
  80 }
  81 EXPORT_SYMBOL(lustre_swab_llogd_body);
  82
  83 void lustre_swab_llogd_conn_body (struct llogd_conn_body *d)
  84 {
  85         __swab64s (&d->lgdc_gen.mnt_cnt);
  86         __swab64s (&d->lgdc_gen.conn_cnt);
  87         __swab64s (&d->lgdc_logid.lgl_oid);
  88         __swab64s (&d->lgdc_logid.lgl_oseq);
  89         __swab32s (&d->lgdc_logid.lgl_ogen);
  90         __swab32s (&d->lgdc_ctxt_idx);
  91 }
  92 EXPORT_SYMBOL(lustre_swab_llogd_conn_body);
  93
  94 void lustre_swab_ll_fid(struct ll_fid *fid)
  95 {
  96         __swab64s (&fid->id);
  97         __swab32s (&fid->generation);
  98         __swab32s (&fid->f_type);
  99 }
 100 EXPORT_SYMBOL(lustre_swab_ll_fid);
 101
 102 void lustre_swab_lu_fid(struct lu_fid *fid)
 103 {
 104         __swab64s (&fid->f_seq);
 105         __swab32s (&fid->f_oid);
 106         __swab32s (&fid->f_ver);
 107 }
 108 EXPORT_SYMBOL(lustre_swab_lu_fid);
 109
 110 void lustre_swab_lu_seq_range(struct lu_seq_range *range)
 111 {
 112         __swab64s (&range->lsr_start);
 113         __swab64s (&range->lsr_end);
 114         __swab32s (&range->lsr_index);
 115         __swab32s (&range->lsr_flags);
 116 }
 117 EXPORT_SYMBOL(lustre_swab_lu_seq_range);
 118
 119 void lustre_swab_llog_rec(struct llog_rec_hdr *rec)
 120 {
 121         struct llog_rec_tail *tail = NULL;
 122
 123         __swab32s(&rec->lrh_len);
 124         __swab32s(&rec->lrh_index);
 125         __swab32s(&rec->lrh_type);
 126         __swab32s(&rec->lrh_id);
 127
 128         switch (rec->lrh_type) {
 129         case OST_SZ_REC:
 130         {
 131                 struct llog_size_change_rec *lsc =
 132                         (struct llog_size_change_rec *)rec;
 133
 134                 lustre_swab_ll_fid(&lsc->lsc_fid);
 135                 __swab32s(&lsc->lsc_ioepoch);
 136                 tail = &lsc->lsc_tail;
 137                 break;
 138         }
 139         case MDS_UNLINK_REC:
 140         {
 141                 struct llog_unlink_rec *lur = (struct llog_unlink_rec *)rec;
 142
 143                 __swab64s(&lur->lur_oid);
 144                 __swab32s(&lur->lur_oseq);
 145                 __swab32s(&lur->lur_count);
 146                 tail = &lur->lur_tail;
 147                 break;
 148         }
 149         case MDS_UNLINK64_REC:
 150         {
 151                 struct llog_unlink64_rec *lur =
 152                         (struct llog_unlink64_rec *)rec;
 153
 154                 lustre_swab_lu_fid(&lur->lur_fid);
 155                 __swab32s(&lur->lur_count);
 156                 tail = &lur->lur_tail;
 157                 break;
 158         }
 159         case CHANGELOG_REC:
 160         {
 161                 struct llog_changelog_rec *cr = (struct llog_changelog_rec*)rec;
 162
 163                 __swab16s(&cr->cr.cr_namelen);
 164                 __swab16s(&cr->cr.cr_flags);
 165                 __swab32s(&cr->cr.cr_type);
 166                 __swab64s(&cr->cr.cr_index);
 167                 __swab64s(&cr->cr.cr_prev);
 168                 __swab64s(&cr->cr.cr_time);
 169                 lustre_swab_lu_fid(&cr->cr.cr_tfid);
 170                 lustre_swab_lu_fid(&cr->cr.cr_pfid);
 171                 if (CHANGELOG_REC_EXTENDED(&cr->cr)) {
 172                         struct llog_changelog_ext_rec *ext =
 173                                 (struct llog_changelog_ext_rec *)rec;
 174
 175                         lustre_swab_lu_fid(&ext->cr.cr_sfid);
 176                         lustre_swab_lu_fid(&ext->cr.cr_spfid);
 177                         tail = &ext->cr_tail;
 178                 } else {
 179                         tail = &cr->cr_tail;
 180                 }
 181                 break;
 182         }
 183         case CHANGELOG_USER_REC:
 184         {
 185                 struct llog_changelog_user_rec *cur =
 186                         (struct llog_changelog_user_rec*)rec;
 187
 188                 __swab32s(&cur->cur_id);
 189                 __swab64s(&cur->cur_endrec);
 190                 tail = &cur->cur_tail;
 191                 break;
 192         }
 193
 194         case MDS_SETATTR64_REC:
 195         {
 196                 struct llog_setattr64_rec *lsr =
 197                         (struct llog_setattr64_rec *)rec;
 198
 199                 __swab64s(&lsr->lsr_oid);
 200                 __swab64s(&lsr->lsr_oseq);
 201                 __swab32s(&lsr->lsr_uid);
 202                 __swab32s(&lsr->lsr_uid_h);
 203                 __swab32s(&lsr->lsr_gid);
 204                 __swab32s(&lsr->lsr_gid_h);
 205                 tail = &lsr->lsr_tail;
 206                 break;
 207         }
 208         case OBD_CFG_REC:
 209                 /* these are swabbed as they are consumed */
 210                 break;
 211         case LLOG_HDR_MAGIC:
 212         {
 213                 struct llog_log_hdr *llh = (struct llog_log_hdr *)rec;
 214
 215                 __swab64s(&llh->llh_timestamp);
 216                 __swab32s(&llh->llh_count);
 217                 __swab32s(&llh->llh_bitmap_offset);
 218                 __swab32s(&llh->llh_flags);
 219                 __swab32s(&llh->llh_size);
 220                 __swab32s(&llh->llh_cat_idx);
 221                 tail = &llh->llh_tail;
 222                 break;
 223         }
 224         case LLOG_LOGID_MAGIC:
 225         {
 226                 struct llog_logid_rec *lid = (struct llog_logid_rec *)rec;
 227
 228                 __swab64s(&lid->lid_id.lgl_oid);
 229                 __swab64s(&lid->lid_id.lgl_oseq);
 230                 __swab32s(&lid->lid_id.lgl_ogen);
 231                 tail = &lid->lid_tail;
 232                 break;
 233         }
 234         case LLOG_GEN_REC:
 235         {
 236                 struct llog_gen_rec *lgr = (struct llog_gen_rec *)rec;
 237
 238                 __swab64s(&lgr->lgr_gen.mnt_cnt);
 239                 __swab64s(&lgr->lgr_gen.conn_cnt);
 240                 tail = &lgr->lgr_tail;
 241                 break;
 242         }
 243         case LLOG_PAD_MAGIC:
 244                 break;
 245         default:
 246                 CERROR("Unknown llog rec type %#x swabbing rec %p\n",
 247                        rec->lrh_type, rec);
 248         }
 249
 250         if (tail) {
 251                 __swab32s(&tail->lrt_len);
 252                 __swab32s(&tail->lrt_index);
 253         }
 254 }
 255 EXPORT_SYMBOL(lustre_swab_llog_rec);
 256
 257 static void print_llog_hdr(struct llog_log_hdr *h)
 258 {
 259         CDEBUG(D_OTHER, "llog header: %p\n", h);
 260         CDEBUG(D_OTHER, "\tllh_hdr.lrh_index: %#x\n", h->llh_hdr.lrh_index);
 261         CDEBUG(D_OTHER, "\tllh_hdr.lrh_len: %#x\n", h->llh_hdr.lrh_len);
 262         CDEBUG(D_OTHER, "\tllh_hdr.lrh_type: %#x\n", h->llh_hdr.lrh_type);
 263         CDEBUG(D_OTHER, "\tllh_timestamp: "LPX64"\n", h->llh_timestamp);
 264         CDEBUG(D_OTHER, "\tllh_count: %#x\n", h->llh_count);
 265         CDEBUG(D_OTHER, "\tllh_bitmap_offset: %#x\n", h->llh_bitmap_offset);
 266         CDEBUG(D_OTHER, "\tllh_flags: %#x\n", h->llh_flags);
 267         CDEBUG(D_OTHER, "\tllh_size: %#x\n", h->llh_size);
 268         CDEBUG(D_OTHER, "\tllh_cat_idx: %#x\n", h->llh_cat_idx);
 269         CDEBUG(D_OTHER, "\tllh_tail.lrt_index: %#x\n", h->llh_tail.lrt_index);
 270         CDEBUG(D_OTHER, "\tllh_tail.lrt_len: %#x\n", h->llh_tail.lrt_len);
 271 }
 272
 273 void lustre_swab_llog_hdr (struct llog_log_hdr *h)
 274 {
 275         ENTRY;
 276         print_llog_hdr(h);
 277
 278         lustre_swab_llog_rec(&h->llh_hdr);
 279
 280         print_llog_hdr(h);
 281         EXIT;
 282 }
 283 EXPORT_SYMBOL(lustre_swab_llog_hdr);
 284
 285 static void print_lustre_cfg(struct lustre_cfg *lcfg)
 286 {
 287         int i;
 288         ENTRY;
 289
 290         if (!(libcfs_debug & D_OTHER)) /* don't loop on nothing */
 291                 return;
 292         CDEBUG(D_OTHER, "lustre_cfg: %p\n", lcfg);
 293         CDEBUG(D_OTHER, "\tlcfg->lcfg_version: %#x\n", lcfg->lcfg_version);
 294
 295         CDEBUG(D_OTHER, "\tlcfg->lcfg_command: %#x\n", lcfg->lcfg_command);
 296         CDEBUG(D_OTHER, "\tlcfg->lcfg_num: %#x\n", lcfg->lcfg_num);
 297         CDEBUG(D_OTHER, "\tlcfg->lcfg_flags: %#x\n", lcfg->lcfg_flags);
 298         CDEBUG(D_OTHER, "\tlcfg->lcfg_nid: %s\n", libcfs_nid2str(lcfg->lcfg_nid));
 299
 300         CDEBUG(D_OTHER, "\tlcfg->lcfg_bufcount: %d\n", lcfg->lcfg_bufcount);
 301         if (lcfg->lcfg_bufcount < LUSTRE_CFG_MAX_BUFCOUNT)
 302                 for (i = 0; i < lcfg->lcfg_bufcount; i++)
 303                         CDEBUG(D_OTHER, "\tlcfg->lcfg_buflens[%d]: %d\n",
 304                                i, lcfg->lcfg_buflens[i]);
 305         EXIT;
 306 }
 307
 308 void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg)
 309 {
 310         int i;
 311         ENTRY;
 312
 313         __swab32s(&lcfg->lcfg_version);
 314
 315         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION) {
 316                 CERROR("not swabbing lustre_cfg version %#x (expecting %#x)\n",
 317                        lcfg->lcfg_version, LUSTRE_CFG_VERSION);
 318                 EXIT;
 319                 return;
 320         }
 321
 322         __swab32s(&lcfg->lcfg_command);
 323         __swab32s(&lcfg->lcfg_num);
 324         __swab32s(&lcfg->lcfg_flags);
 325         __swab64s(&lcfg->lcfg_nid);
 326         __swab32s(&lcfg->lcfg_bufcount);
 327         for (i = 0; i < lcfg->lcfg_bufcount && i < LUSTRE_CFG_MAX_BUFCOUNT; i++)
 328                 __swab32s(&lcfg->lcfg_buflens[i]);
 329
 330         print_lustre_cfg(lcfg);
 331         EXIT;
 332         return;
 333 }
 334 EXPORT_SYMBOL(lustre_swab_lustre_cfg);
 335
 336 /* used only for compatibility with old on-disk cfg_marker data */
 337 struct cfg_marker32 {
 338         __u32   cm_step;
 339         __u32   cm_flags;
 340         __u32   cm_vers;
 341         __u32   padding;
 342         __u32   cm_createtime;
 343         __u32   cm_canceltime;
 344         char    cm_tgtname[MTI_NAME_MAXLEN];
 345         char    cm_comment[MTI_NAME_MAXLEN];
 346 };
 347
 348 #define MTI_NAMELEN32    (MTI_NAME_MAXLEN - \
 349         (sizeof(struct cfg_marker) - sizeof(struct cfg_marker32)))
 350
 351 void lustre_swab_cfg_marker(struct cfg_marker *marker, int swab, int size)
 352 {
 353         struct cfg_marker32 *cm32 = (struct cfg_marker32*)marker;
 354         ENTRY;
 355
 356         if (swab) {
 357                 __swab32s(&marker->cm_step);
 358                 __swab32s(&marker->cm_flags);
 359                 __swab32s(&marker->cm_vers);
 360         }
 361         if (size == sizeof(*cm32)) {
 362                 __u32 createtime, canceltime;
 363                 /* There was a problem with the original declaration of
 364                  * cfg_marker on 32-bit systems because it used time_t as
 365                  * a wire protocol structure, and didn't verify this in
 366                  * wirecheck.  We now have to convert the offsets of the
 367                  * later fields in order to work on 32- and 64-bit systems.
 368                  *
 369                  * Fortunately, the cm_comment field has no functional use
 370                  * so can be sacrificed when converting the timestamp size.
 371                  *
 372                  * Overwrite fields from the end first, so they are not
 373                  * clobbered, and use memmove() instead of memcpy() because
 374                  * the source and target buffers overlap.  bug 16771 */
 375                 createtime = cm32->cm_createtime;
 376                 canceltime = cm32->cm_canceltime;
 377                 memmove(marker->cm_comment, cm32->cm_comment, MTI_NAMELEN32);
 378                 marker->cm_comment[MTI_NAMELEN32 - 1] = '\0';
 379                 memmove(marker->cm_tgtname, cm32->cm_tgtname,
 380                         sizeof(marker->cm_tgtname));
 381                 if (swab) {
 382                         __swab32s(&createtime);
 383                         __swab32s(&canceltime);
 384                 }
 385                 marker->cm_createtime = createtime;
 386                 marker->cm_canceltime = canceltime;
 387                 CDEBUG(D_CONFIG, "Find old cfg_marker(Srv32b,Clt64b) "
 388                        "for target %s, converting\n",
 389                        marker->cm_tgtname);
 390         } else if (swab) {
 391                 __swab64s(&marker->cm_createtime);
 392                 __swab64s(&marker->cm_canceltime);
 393         }
 394
 395         EXIT;
 396         return;
 397 }
 398 EXPORT_SYMBOL(lustre_swab_cfg_marker);