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