lustre/obdclass/llog_swab.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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_ogr: "LPX64"\n", d->lgd_logid.lgl_ogr);
  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_ogr);
  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_ogr);
  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_mdt);
 115 }
 116 EXPORT_SYMBOL(lustre_swab_lu_seq_range);
 117
 118 void lustre_swab_llog_rec(struct llog_rec_hdr *rec, struct llog_rec_tail *tail)
 119 {
 120         __swab32s(&rec->lrh_len);
 121         __swab32s(&rec->lrh_index);
 122         __swab32s(&rec->lrh_type);
 123
 124         switch (rec->lrh_type) {
 125         case OST_SZ_REC: {
 126                 struct llog_size_change_rec *lsc =
 127                         (struct llog_size_change_rec *)rec;
 128
 129                 lustre_swab_ll_fid(&lsc->lsc_fid);
 130                 __swab32s(&lsc->lsc_ioepoch);
 131                 break;
 132         }
 133
 134         case OST_RAID1_REC:
 135                 break;
 136
 137         case MDS_UNLINK_REC: {
 138                 struct llog_unlink_rec *lur = (struct llog_unlink_rec *)rec;
 139
 140                 __swab64s(&lur->lur_oid);
 141                 __swab32s(&lur->lur_ogr);
 142                 __swab32s(&lur->lur_count);
 143                 break;
 144         }
 145
 146         case MDS_SETATTR_REC: {
 147                 struct llog_setattr_rec *lsr = (struct llog_setattr_rec *)rec;
 148
 149                 __swab64s(&lsr->lsr_oid);
 150                 __swab32s(&lsr->lsr_ogr);
 151                 __swab32s(&lsr->lsr_uid);
 152                 __swab32s(&lsr->lsr_gid);
 153                 break;
 154         }
 155
 156         case CHANGELOG_REC: {
 157                 struct llog_changelog_rec *cr = (struct llog_changelog_rec*)rec;
 158
 159                 __swab16s(&cr->cr.cr_namelen);
 160                 __swab16s(&cr->cr.cr_flags);
 161                 __swab32s(&cr->cr.cr_type);
 162                 __swab64s(&cr->cr.cr_index);
 163                 __swab64s(&cr->cr.cr_prev);
 164                 __swab64s(&cr->cr.cr_time);
 165                 lustre_swab_lu_fid(&cr->cr.cr_tfid);
 166                 lustre_swab_lu_fid(&cr->cr.cr_pfid);
 167                 break;
 168         }
 169
 170         case CHANGELOG_USER_REC: {
 171                 struct llog_changelog_user_rec *cur =
 172                         (struct llog_changelog_user_rec*)rec;
 173
 174                 __swab32s(&cur->cur_id);
 175                 __swab64s(&cur->cur_endrec);
 176                 break;
 177         }
 178
 179         case MDS_SETATTR64_REC: {
 180                 struct llog_setattr64_rec *lsr = (struct llog_setattr64_rec *)rec;
 181
 182                 __swab64s(&lsr->lsr_oid);
 183                 __swab32s(&lsr->lsr_ogr);
 184                 __swab32s(&lsr->lsr_uid);
 185                 __swab32s(&lsr->lsr_gid);
 186
 187                 break;
 188         }
 189
 190         case OBD_CFG_REC:
 191                 /* these are swabbed as they are consumed */
 192                 break;
 193
 194         case LLOG_HDR_MAGIC: {
 195                 struct llog_log_hdr *llh = (struct llog_log_hdr *)rec;
 196
 197                 __swab64s(&llh->llh_timestamp);
 198                 __swab32s(&llh->llh_count);
 199                 __swab32s(&llh->llh_bitmap_offset);
 200                 __swab32s(&llh->llh_flags);
 201                 __swab32s(&llh->llh_size);
 202                 __swab32s(&llh->llh_cat_idx);
 203                 if (tail != &llh->llh_tail) {
 204                         __swab32s(&llh->llh_tail.lrt_index);
 205                         __swab32s(&llh->llh_tail.lrt_len);
 206                 }
 207                 break;
 208         }
 209
 210         case LLOG_LOGID_MAGIC: {
 211                 struct llog_logid_rec *lid = (struct llog_logid_rec *)rec;
 212
 213                 __swab64s(&lid->lid_id.lgl_oid);
 214                 __swab64s(&lid->lid_id.lgl_ogr);
 215                 __swab32s(&lid->lid_id.lgl_ogen);
 216                 break;
 217         }
 218         case LLOG_PAD_MAGIC:
 219                 break;
 220
 221         default:
 222                 CERROR("Unknown llog rec type %#x swabbing rec %p\n",
 223                        rec->lrh_type, rec);
 224         }
 225
 226         if (tail) {
 227                 __swab32s(&tail->lrt_len);
 228                 __swab32s(&tail->lrt_index);
 229         }
 230 }
 231 EXPORT_SYMBOL(lustre_swab_llog_rec);
 232
 233 static void print_llog_hdr(struct llog_log_hdr *h)
 234 {
 235         CDEBUG(D_OTHER, "llog header: %p\n", h);
 236         CDEBUG(D_OTHER, "\tllh_hdr.lrh_index: %#x\n", h->llh_hdr.lrh_index);
 237         CDEBUG(D_OTHER, "\tllh_hdr.lrh_len: %#x\n", h->llh_hdr.lrh_len);
 238         CDEBUG(D_OTHER, "\tllh_hdr.lrh_type: %#x\n", h->llh_hdr.lrh_type);
 239         CDEBUG(D_OTHER, "\tllh_timestamp: "LPX64"\n", h->llh_timestamp);
 240         CDEBUG(D_OTHER, "\tllh_count: %#x\n", h->llh_count);
 241         CDEBUG(D_OTHER, "\tllh_bitmap_offset: %#x\n", h->llh_bitmap_offset);
 242         CDEBUG(D_OTHER, "\tllh_flags: %#x\n", h->llh_flags);
 243         CDEBUG(D_OTHER, "\tllh_size: %#x\n", h->llh_size);
 244         CDEBUG(D_OTHER, "\tllh_cat_idx: %#x\n", h->llh_cat_idx);
 245         CDEBUG(D_OTHER, "\tllh_tail.lrt_index: %#x\n", h->llh_tail.lrt_index);
 246         CDEBUG(D_OTHER, "\tllh_tail.lrt_len: %#x\n", h->llh_tail.lrt_len);
 247 }
 248
 249 void lustre_swab_llog_hdr (struct llog_log_hdr *h)
 250 {
 251         ENTRY;
 252         print_llog_hdr(h);
 253
 254         lustre_swab_llog_rec(&h->llh_hdr, &h->llh_tail);
 255
 256         print_llog_hdr(h);
 257         EXIT;
 258 }
 259 EXPORT_SYMBOL(lustre_swab_llog_hdr);
 260
 261 static void print_lustre_cfg(struct lustre_cfg *lcfg)
 262 {
 263         int i;
 264         ENTRY;
 265
 266         if (!(libcfs_debug & D_OTHER)) /* don't loop on nothing */
 267                 return;
 268         CDEBUG(D_OTHER, "lustre_cfg: %p\n", lcfg);
 269         CDEBUG(D_OTHER, "\tlcfg->lcfg_version: %#x\n", lcfg->lcfg_version);
 270
 271         CDEBUG(D_OTHER, "\tlcfg->lcfg_command: %#x\n", lcfg->lcfg_command);
 272         CDEBUG(D_OTHER, "\tlcfg->lcfg_num: %#x\n", lcfg->lcfg_num);
 273         CDEBUG(D_OTHER, "\tlcfg->lcfg_flags: %#x\n", lcfg->lcfg_flags);
 274         CDEBUG(D_OTHER, "\tlcfg->lcfg_nid: %s\n", libcfs_nid2str(lcfg->lcfg_nid));
 275
 276         CDEBUG(D_OTHER, "\tlcfg->lcfg_bufcount: %d\n", lcfg->lcfg_bufcount);
 277         if (lcfg->lcfg_bufcount < LUSTRE_CFG_MAX_BUFCOUNT)
 278                 for (i = 0; i < lcfg->lcfg_bufcount; i++)
 279                         CDEBUG(D_OTHER, "\tlcfg->lcfg_buflens[%d]: %d\n",
 280                                i, lcfg->lcfg_buflens[i]);
 281         EXIT;
 282 }
 283
 284 void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg)
 285 {
 286         int i;
 287         ENTRY;
 288
 289         __swab32s(&lcfg->lcfg_version);
 290
 291         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION) {
 292                 CERROR("not swabbing lustre_cfg version %#x (expecting %#x)\n",
 293                        lcfg->lcfg_version, LUSTRE_CFG_VERSION);
 294                 EXIT;
 295                 return;
 296         }
 297
 298         __swab32s(&lcfg->lcfg_command);
 299         __swab32s(&lcfg->lcfg_num);
 300         __swab32s(&lcfg->lcfg_flags);
 301         __swab64s(&lcfg->lcfg_nid);
 302         __swab32s(&lcfg->lcfg_bufcount);
 303         for (i = 0; i < lcfg->lcfg_bufcount && i < LUSTRE_CFG_MAX_BUFCOUNT; i++)
 304                 __swab32s(&lcfg->lcfg_buflens[i]);
 305
 306         print_lustre_cfg(lcfg);
 307         EXIT;
 308         return;
 309 }
 310 EXPORT_SYMBOL(lustre_swab_lustre_cfg);
 311
 312 /* used only for compatibility with old on-disk cfg_marker data */
 313 struct cfg_marker32 {
 314         __u32   cm_step;
 315         __u32   cm_flags;
 316         __u32   cm_vers;
 317         __u32   padding;
 318         __u32   cm_createtime;
 319         __u32   cm_canceltime;
 320         char    cm_tgtname[MTI_NAME_MAXLEN];
 321         char    cm_comment[MTI_NAME_MAXLEN];
 322 };
 323
 324 #define MTI_NAMELEN32    (MTI_NAME_MAXLEN - \
 325         (sizeof(struct cfg_marker) - sizeof(struct cfg_marker32)))
 326
 327 void lustre_swab_cfg_marker(struct cfg_marker *marker, int swab, int size)
 328 {
 329         struct cfg_marker32 *cm32 = (struct cfg_marker32*)marker;
 330         ENTRY;
 331
 332         if (swab) {
 333                 __swab32s(&marker->cm_step);
 334                 __swab32s(&marker->cm_flags);
 335                 __swab32s(&marker->cm_vers);
 336         }
 337         if (size == sizeof(*cm32)) {
 338                 __u32 createtime, canceltime;
 339                 /* There was a problem with the original declaration of
 340                  * cfg_marker on 32-bit systems because it used time_t as
 341                  * a wire protocol structure, and didn't verify this in
 342                  * wirecheck.  We now have to convert the offsets of the
 343                  * later fields in order to work on 32- and 64-bit systems.
 344                  *
 345                  * Fortunately, the cm_comment field has no functional use
 346                  * so can be sacrificed when converting the timestamp size.
 347                  *
 348                  * Overwrite fields from the end first, so they are not
 349                  * clobbered, and use memmove() instead of memcpy() because
 350                  * the source and target buffers overlap.  bug 16771 */
 351                 createtime = cm32->cm_createtime;
 352                 canceltime = cm32->cm_canceltime;
 353                 memmove(marker->cm_comment, cm32->cm_comment, MTI_NAMELEN32);
 354                 marker->cm_comment[MTI_NAMELEN32 - 1] = '\0';
 355                 memmove(marker->cm_tgtname, cm32->cm_tgtname,
 356                         sizeof(marker->cm_tgtname));
 357                 if (swab) {
 358                         __swab32s(&createtime);
 359                         __swab32s(&canceltime);
 360                 }
 361                 marker->cm_createtime = createtime;
 362                 marker->cm_canceltime = canceltime;
 363                 CDEBUG(D_CONFIG, "Find old cfg_marker(Srv32b,Clt64b) "
 364                        "for target %s, converting\n",
 365                        marker->cm_tgtname);
 366         } else if (swab) {
 367                 __swab64s(&marker->cm_createtime);
 368                 __swab64s(&marker->cm_canceltime);
 369         }
 370
 371         EXIT;
 372         return;
 373 }
 374 EXPORT_SYMBOL(lustre_swab_cfg_marker);