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