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