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