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_llog_rec(struct llog_rec_hdr *rec, struct llog_rec_tail *tail)
 111 {
 112         __swab32s(&rec->lrh_len);
 113         __swab32s(&rec->lrh_index);
 114         __swab32s(&rec->lrh_type);
 115
 116         switch (rec->lrh_type) {
 117         case OST_SZ_REC: {
 118                 struct llog_size_change_rec *lsc =
 119                         (struct llog_size_change_rec *)rec;
 120
 121                 lustre_swab_ll_fid(&lsc->lsc_fid);
 122                 __swab32s(&lsc->lsc_io_epoch);
 123
 124                 break;
 125         }
 126
 127         case OST_RAID1_REC:
 128                 break;
 129
 130         case MDS_UNLINK_REC: {
 131                 struct llog_unlink_rec *lur = (struct llog_unlink_rec *)rec;
 132
 133                 __swab64s(&lur->lur_oid);
 134                 __swab32s(&lur->lur_ogr);
 135                 __swab32s(&lur->lur_count);
 136                 break;
 137         }
 138
 139         case MDS_SETATTR_REC: {
 140                 struct llog_setattr_rec *lsr = (struct llog_setattr_rec *)rec;
 141
 142                 __swab64s(&lsr->lsr_oid);
 143                 __swab32s(&lsr->lsr_ogr);
 144                 __swab32s(&lsr->lsr_uid);
 145                 __swab32s(&lsr->lsr_gid);
 146
 147                 break;
 148         }
 149
 150         case MDS_SETATTR64_REC: {
 151                 struct llog_setattr64_rec *lsr = (struct llog_setattr64_rec *)rec;
 152
 153                 __swab64s(&lsr->lsr_oid);
 154                 __swab32s(&lsr->lsr_ogr);
 155                 __swab32s(&lsr->lsr_uid);
 156                 __swab32s(&lsr->lsr_gid);
 157
 158                 break;
 159         }
 160
 161         case OBD_CFG_REC:
 162         case PTL_CFG_REC:                       /* obsolete */
 163                 /* these are swabbed as they are consumed */
 164                 break;
 165
 166         case LLOG_HDR_MAGIC: {
 167                 struct llog_log_hdr *llh = (struct llog_log_hdr *)rec;
 168
 169                 __swab64s(&llh->llh_timestamp);
 170                 __swab32s(&llh->llh_count);
 171                 __swab32s(&llh->llh_bitmap_offset);
 172                 __swab32s(&llh->llh_flags);
 173                 __swab32s(&llh->llh_size);
 174                 __swab32s(&llh->llh_cat_idx);
 175                 if (tail != &llh->llh_tail) {
 176                         __swab32s(&llh->llh_tail.lrt_index);
 177                         __swab32s(&llh->llh_tail.lrt_len);
 178                 }
 179
 180                 break;
 181         }
 182
 183         case LLOG_LOGID_MAGIC: {
 184                 struct llog_logid_rec *lid = (struct llog_logid_rec *)rec;
 185
 186                 __swab64s(&lid->lid_id.lgl_oid);
 187                 __swab64s(&lid->lid_id.lgl_ogr);
 188                 __swab32s(&lid->lid_id.lgl_ogen);
 189                 break;
 190         }
 191         case LLOG_JOIN_REC:
 192         case LLOG_PAD_MAGIC:
 193         /* ignore old pad records of type 0 */
 194         case 0:
 195                 break;
 196
 197         default:
 198                 CERROR("Unknown llog rec type %#x swabbing rec %p\n",
 199                        rec->lrh_type, rec);
 200         }
 201
 202         if (tail) {
 203                 __swab32s(&tail->lrt_len);
 204                 __swab32s(&tail->lrt_index);
 205         }
 206 }
 207 EXPORT_SYMBOL(lustre_swab_llog_rec);
 208
 209 static void print_llog_hdr(struct llog_log_hdr *h)
 210 {
 211         CDEBUG(D_OTHER, "llog header: %p\n", h);
 212         CDEBUG(D_OTHER, "\tllh_hdr.lrh_index: %#x\n", h->llh_hdr.lrh_index);
 213         CDEBUG(D_OTHER, "\tllh_hdr.lrh_len: %#x\n", h->llh_hdr.lrh_len);
 214         CDEBUG(D_OTHER, "\tllh_hdr.lrh_type: %#x\n", h->llh_hdr.lrh_type);
 215         CDEBUG(D_OTHER, "\tllh_timestamp: "LPX64"\n", h->llh_timestamp);
 216         CDEBUG(D_OTHER, "\tllh_count: %#x\n", h->llh_count);
 217         CDEBUG(D_OTHER, "\tllh_bitmap_offset: %#x\n", h->llh_bitmap_offset);
 218         CDEBUG(D_OTHER, "\tllh_flags: %#x\n", h->llh_flags);
 219         CDEBUG(D_OTHER, "\tllh_size: %#x\n", h->llh_size);
 220         CDEBUG(D_OTHER, "\tllh_cat_idx: %#x\n", h->llh_cat_idx);
 221         CDEBUG(D_OTHER, "\tllh_tail.lrt_index: %#x\n", h->llh_tail.lrt_index);
 222         CDEBUG(D_OTHER, "\tllh_tail.lrt_len: %#x\n", h->llh_tail.lrt_len);
 223 }
 224
 225 void lustre_swab_llog_hdr (struct llog_log_hdr *h)
 226 {
 227         ENTRY;
 228         print_llog_hdr(h);
 229
 230         lustre_swab_llog_rec(&h->llh_hdr, &h->llh_tail);
 231
 232         print_llog_hdr(h);
 233         EXIT;
 234 }
 235 EXPORT_SYMBOL(lustre_swab_llog_hdr);
 236
 237 static void print_lustre_cfg(struct lustre_cfg *lcfg)
 238 {
 239         int i;
 240         ENTRY;
 241
 242         if (!(libcfs_debug & D_OTHER)) /* don't loop on nothing */
 243                 return;
 244         CDEBUG(D_OTHER, "lustre_cfg: %p\n", lcfg);
 245         CDEBUG(D_OTHER, "\tlcfg->lcfg_version: %#x\n", lcfg->lcfg_version);
 246
 247         CDEBUG(D_OTHER, "\tlcfg->lcfg_command: %#x\n", lcfg->lcfg_command);
 248         CDEBUG(D_OTHER, "\tlcfg->lcfg_num: %#x\n", lcfg->lcfg_num);
 249         CDEBUG(D_OTHER, "\tlcfg->lcfg_flags: %#x\n", lcfg->lcfg_flags);
 250         CDEBUG(D_OTHER, "\tlcfg->lcfg_nid: %s\n", libcfs_nid2str(lcfg->lcfg_nid));
 251
 252         CDEBUG(D_OTHER, "\tlcfg->lcfg_bufcount: %d\n", lcfg->lcfg_bufcount);
 253         if (lcfg->lcfg_bufcount < LUSTRE_CFG_MAX_BUFCOUNT)
 254                 for (i = 0; i < lcfg->lcfg_bufcount; i++)
 255                         CDEBUG(D_OTHER, "\tlcfg->lcfg_buflens[%d]: %d\n",
 256                                i, lcfg->lcfg_buflens[i]);
 257         EXIT;
 258 }
 259
 260 void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg)
 261 {
 262         int i;
 263         ENTRY;
 264
 265         __swab32s(&lcfg->lcfg_version);
 266
 267         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION) {
 268                 CERROR("not swabbing lustre_cfg version %#x (expecting %#x)\n",
 269                        lcfg->lcfg_version, LUSTRE_CFG_VERSION);
 270                 EXIT;
 271                 return;
 272         }
 273
 274         __swab32s(&lcfg->lcfg_command);
 275         __swab32s(&lcfg->lcfg_num);
 276         __swab32s(&lcfg->lcfg_flags);
 277         __swab64s(&lcfg->lcfg_nid);
 278         __swab32s(&lcfg->lcfg_bufcount);
 279         for (i = 0; i < lcfg->lcfg_bufcount && i < LUSTRE_CFG_MAX_BUFCOUNT; i++)
 280                 __swab32s(&lcfg->lcfg_buflens[i]);
 281
 282         print_lustre_cfg(lcfg);
 283         EXIT;
 284         return;
 285 }
 286 EXPORT_SYMBOL(lustre_swab_lustre_cfg);
 287
 288 /* used only for compatibility with old on-disk cfg_marker data */
 289 struct cfg_marker32 {
 290         __u32   cm_step;
 291         __u32   cm_flags;
 292         __u32   cm_vers;
 293         __u32   padding;
 294         __u32   cm_createtime;
 295         __u32   cm_canceltime;
 296         char    cm_tgtname[MTI_NAME_MAXLEN];
 297         char    cm_comment[MTI_NAME_MAXLEN];
 298 };
 299
 300 #define MTI_NAMELEN32    (MTI_NAME_MAXLEN - \
 301         (sizeof(struct cfg_marker) - sizeof(struct cfg_marker32)))
 302
 303 void lustre_swab_cfg_marker(struct cfg_marker *marker, int swab, int size)
 304 {
 305         struct cfg_marker32 *cm32 = (struct cfg_marker32*)marker;
 306         ENTRY;
 307
 308         if (swab) {
 309                 __swab32s(&marker->cm_step);
 310                 __swab32s(&marker->cm_flags);
 311                 __swab32s(&marker->cm_vers);
 312         }
 313         if (size == sizeof(*cm32)) {
 314                 __u32 createtime, canceltime;
 315                 /* There was a problem with the original declaration of
 316                  * cfg_marker on 32-bit systems because it used time_t as
 317                  * a wire protocol structure, and didn't verify this in
 318                  * wirecheck.  We now have to convert the offsets of the
 319                  * later fields in order to work on 32- and 64-bit systems.
 320                  *
 321                  * Fortunately, the cm_comment field has no functional use
 322                  * so can be sacrificed when converting the timestamp size.
 323                  *
 324                  * Overwrite fields from the end first, so they are not
 325                  * clobbered, and use memmove() instead of memcpy() because
 326                  * the source and target buffers overlap.  bug 16771 */
 327                 createtime = cm32->cm_createtime;
 328                 canceltime = cm32->cm_canceltime;
 329                 memmove(marker->cm_comment, cm32->cm_comment, MTI_NAMELEN32);
 330                 marker->cm_comment[MTI_NAMELEN32 - 1] = '\0';
 331                 memmove(marker->cm_tgtname, cm32->cm_tgtname,
 332                         sizeof(marker->cm_tgtname));
 333                 if (swab) {
 334                         __swab32s(&createtime);
 335                         __swab32s(&canceltime);
 336                 }
 337                 marker->cm_createtime = createtime;
 338                 marker->cm_canceltime = canceltime;
 339                 CDEBUG(D_CONFIG, "Find old cfg_marker(Srv32b,Clt64b) "
 340                        "for target %s, converting\n",
 341                        marker->cm_tgtname);
 342         } else if (swab) {
 343                 __swab64s(&marker->cm_createtime);
 344                 __swab64s(&marker->cm_canceltime);
 345         }
 346
 347         EXIT;
 348         return;
 349 }
 350 EXPORT_SYMBOL(lustre_swab_cfg_marker);