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