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