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