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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2015, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/obdclass/llog_swab.c
  33  *
  34  * Swabbing of llog datatypes (from disk or over the wire).
  35  *
  36  * Author: jacob berkman  <jacob@clusterfs.com>
  37  */
  38
  39 #define DEBUG_SUBSYSTEM S_LOG
  40
  41 #include "../include/lustre_log.h"
  42
  43 static void print_llogd_body(struct llogd_body *d)
  44 {
  45         CDEBUG(D_OTHER, "llogd body: %p\n", d);
  46         CDEBUG(D_OTHER, "\tlgd_logid.lgl_oi: "DOSTID"\n",
  47                POSTID(&d->lgd_logid.lgl_oi));
  48         CDEBUG(D_OTHER, "\tlgd_logid.lgl_ogen: %#x\n", d->lgd_logid.lgl_ogen);
  49         CDEBUG(D_OTHER, "\tlgd_ctxt_idx: %#x\n", d->lgd_ctxt_idx);
  50         CDEBUG(D_OTHER, "\tlgd_llh_flags: %#x\n", d->lgd_llh_flags);
  51         CDEBUG(D_OTHER, "\tlgd_index: %#x\n", d->lgd_index);
  52         CDEBUG(D_OTHER, "\tlgd_saved_index: %#x\n", d->lgd_saved_index);
  53         CDEBUG(D_OTHER, "\tlgd_len: %#x\n", d->lgd_len);
  54         CDEBUG(D_OTHER, "\tlgd_cur_offset: %#llx\n", d->lgd_cur_offset);
  55 }
  56
  57 void lustre_swab_lu_fid(struct lu_fid *fid)
  58 {
  59         __swab64s(&fid->f_seq);
  60         __swab32s(&fid->f_oid);
  61         __swab32s(&fid->f_ver);
  62 }
  63 EXPORT_SYMBOL(lustre_swab_lu_fid);
  64
  65 void lustre_swab_ost_id(struct ost_id *oid)
  66 {
  67         if (fid_seq_is_mdt0(oid->oi.oi_seq)) {
  68                 __swab64s(&oid->oi.oi_id);
  69                 __swab64s(&oid->oi.oi_seq);
  70         } else {
  71                 lustre_swab_lu_fid(&oid->oi_fid);
  72         }
  73 }
  74 EXPORT_SYMBOL(lustre_swab_ost_id);
  75
  76 static void lustre_swab_llog_id(struct llog_logid *log_id)
  77 {
  78         __swab64s(&log_id->lgl_oi.oi.oi_id);
  79         __swab64s(&log_id->lgl_oi.oi.oi_seq);
  80         __swab32s(&log_id->lgl_ogen);
  81 }
  82
  83 void lustre_swab_llogd_body(struct llogd_body *d)
  84 {
  85         print_llogd_body(d);
  86         lustre_swab_llog_id(&d->lgd_logid);
  87         __swab32s(&d->lgd_ctxt_idx);
  88         __swab32s(&d->lgd_llh_flags);
  89         __swab32s(&d->lgd_index);
  90         __swab32s(&d->lgd_saved_index);
  91         __swab32s(&d->lgd_len);
  92         __swab64s(&d->lgd_cur_offset);
  93         print_llogd_body(d);
  94 }
  95 EXPORT_SYMBOL(lustre_swab_llogd_body);
  96
  97 void lustre_swab_llogd_conn_body(struct llogd_conn_body *d)
  98 {
  99         __swab64s(&d->lgdc_gen.mnt_cnt);
 100         __swab64s(&d->lgdc_gen.conn_cnt);
 101         lustre_swab_llog_id(&d->lgdc_logid);
 102         __swab32s(&d->lgdc_ctxt_idx);
 103 }
 104 EXPORT_SYMBOL(lustre_swab_llogd_conn_body);
 105
 106 static void lustre_swab_ll_fid(struct ll_fid *fid)
 107 {
 108         __swab64s(&fid->id);
 109         __swab32s(&fid->generation);
 110         __swab32s(&fid->f_type);
 111 }
 112
 113 void lustre_swab_lu_seq_range(struct lu_seq_range *range)
 114 {
 115         __swab64s(&range->lsr_start);
 116         __swab64s(&range->lsr_end);
 117         __swab32s(&range->lsr_index);
 118         __swab32s(&range->lsr_flags);
 119 }
 120 EXPORT_SYMBOL(lustre_swab_lu_seq_range);
 121
 122 void lustre_swab_llog_rec(struct llog_rec_hdr *rec)
 123 {
 124         struct llog_rec_tail *tail = NULL;
 125
 126         __swab32s(&rec->lrh_len);
 127         __swab32s(&rec->lrh_index);
 128         __swab32s(&rec->lrh_type);
 129         __swab32s(&rec->lrh_id);
 130
 131         switch (rec->lrh_type) {
 132         case OST_SZ_REC:
 133         {
 134                 struct llog_size_change_rec *lsc =
 135                         (struct llog_size_change_rec *)rec;
 136
 137                 lustre_swab_ll_fid(&lsc->lsc_fid);
 138                 __swab32s(&lsc->lsc_ioepoch);
 139                 tail = &lsc->lsc_tail;
 140                 break;
 141         }
 142         case MDS_UNLINK_REC:
 143         {
 144                 struct llog_unlink_rec *lur = (struct llog_unlink_rec *)rec;
 145
 146                 __swab64s(&lur->lur_oid);
 147                 __swab32s(&lur->lur_oseq);
 148                 __swab32s(&lur->lur_count);
 149                 tail = &lur->lur_tail;
 150                 break;
 151         }
 152         case MDS_UNLINK64_REC:
 153         {
 154                 struct llog_unlink64_rec *lur =
 155                         (struct llog_unlink64_rec *)rec;
 156
 157                 lustre_swab_lu_fid(&lur->lur_fid);
 158                 __swab32s(&lur->lur_count);
 159                 tail = &lur->lur_tail;
 160                 break;
 161         }
 162         case CHANGELOG_REC:
 163         {
 164                 struct llog_changelog_rec *cr =
 165                         (struct llog_changelog_rec *)rec;
 166
 167                 __swab16s(&cr->cr.cr_namelen);
 168                 __swab16s(&cr->cr.cr_flags);
 169                 __swab32s(&cr->cr.cr_type);
 170                 __swab64s(&cr->cr.cr_index);
 171                 __swab64s(&cr->cr.cr_prev);
 172                 __swab64s(&cr->cr.cr_time);
 173                 lustre_swab_lu_fid(&cr->cr.cr_tfid);
 174                 lustre_swab_lu_fid(&cr->cr.cr_pfid);
 175                 if (cr->cr.cr_flags & CLF_RENAME) {
 176                         struct changelog_ext_rename *rnm =
 177                                 changelog_rec_rename(&cr->cr);
 178
 179                         lustre_swab_lu_fid(&rnm->cr_sfid);
 180                         lustre_swab_lu_fid(&rnm->cr_spfid);
 181                 }
 182                 /*
 183                  * Because the tail follows a variable-length structure we need
 184                  * to compute its location at runtime
 185                  */
 186                 tail = (struct llog_rec_tail *)((char *)&cr->cr +
 187                                                 changelog_rec_size(&cr->cr) +
 188                                                 cr->cr.cr_namelen);
 189                 break;
 190         }
 191
 192         case CHANGELOG_USER_REC:
 193         {
 194                 struct llog_changelog_user_rec *cur =
 195                         (struct llog_changelog_user_rec *)rec;
 196
 197                 __swab32s(&cur->cur_id);
 198                 __swab64s(&cur->cur_endrec);
 199                 tail = &cur->cur_tail;
 200                 break;
 201         }
 202
 203         case HSM_AGENT_REC: {
 204                 struct llog_agent_req_rec *arr =
 205                         (struct llog_agent_req_rec *)rec;
 206
 207                 __swab32s(&arr->arr_hai.hai_len);
 208                 __swab32s(&arr->arr_hai.hai_action);
 209                 lustre_swab_lu_fid(&arr->arr_hai.hai_fid);
 210                 lustre_swab_lu_fid(&arr->arr_hai.hai_dfid);
 211                 __swab64s(&arr->arr_hai.hai_cookie);
 212                 __swab64s(&arr->arr_hai.hai_extent.offset);
 213                 __swab64s(&arr->arr_hai.hai_extent.length);
 214                 __swab64s(&arr->arr_hai.hai_gid);
 215                 /* no swabing for opaque data */
 216                 /* hai_data[0]; */
 217                 break;
 218         }
 219
 220         case MDS_SETATTR64_REC:
 221         {
 222                 struct llog_setattr64_rec *lsr =
 223                         (struct llog_setattr64_rec *)rec;
 224
 225                 lustre_swab_ost_id(&lsr->lsr_oi);
 226                 __swab32s(&lsr->lsr_uid);
 227                 __swab32s(&lsr->lsr_uid_h);
 228                 __swab32s(&lsr->lsr_gid);
 229                 __swab32s(&lsr->lsr_gid_h);
 230                 __swab64s(&lsr->lsr_valid);
 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
 351 /* used only for compatibility with old on-disk cfg_marker data */
 352 struct cfg_marker32 {
 353         __u32   cm_step;
 354         __u32   cm_flags;
 355         __u32   cm_vers;
 356         __u32   padding;
 357         __u32   cm_createtime;
 358         __u32   cm_canceltime;
 359         char    cm_tgtname[MTI_NAME_MAXLEN];
 360         char    cm_comment[MTI_NAME_MAXLEN];
 361 };
 362
 363 #define MTI_NAMELEN32    (MTI_NAME_MAXLEN - \
 364         (sizeof(struct cfg_marker) - sizeof(struct cfg_marker32)))
 365
 366 void lustre_swab_cfg_marker(struct cfg_marker *marker, int swab, int size)
 367 {
 368         struct cfg_marker32 *cm32 = (struct cfg_marker32 *)marker;
 369
 370         if (swab) {
 371                 __swab32s(&marker->cm_step);
 372                 __swab32s(&marker->cm_flags);
 373                 __swab32s(&marker->cm_vers);
 374         }
 375         if (size == sizeof(*cm32)) {
 376                 __u32 createtime, canceltime;
 377                 /* There was a problem with the original declaration of
 378                  * cfg_marker on 32-bit systems because it used time_t as
 379                  * a wire protocol structure, and didn't verify this in
 380                  * wirecheck.  We now have to convert the offsets of the
 381                  * later fields in order to work on 32- and 64-bit systems.
 382                  *
 383                  * Fortunately, the cm_comment field has no functional use
 384                  * so can be sacrificed when converting the timestamp size.
 385                  *
 386                  * Overwrite fields from the end first, so they are not
 387                  * clobbered, and use memmove() instead of memcpy() because
 388                  * the source and target buffers overlap.  bug 16771
 389                  */
 390                 createtime = cm32->cm_createtime;
 391                 canceltime = cm32->cm_canceltime;
 392                 memmove(marker->cm_comment, cm32->cm_comment, MTI_NAMELEN32);
 393                 marker->cm_comment[MTI_NAMELEN32 - 1] = '\0';
 394                 memmove(marker->cm_tgtname, cm32->cm_tgtname,
 395                         sizeof(marker->cm_tgtname));
 396                 if (swab) {
 397                         __swab32s(&createtime);
 398                         __swab32s(&canceltime);
 399                 }
 400                 marker->cm_createtime = createtime;
 401                 marker->cm_canceltime = canceltime;
 402                 CDEBUG(D_CONFIG, "Find old cfg_marker(Srv32b,Clt64b) for target %s, converting\n",
 403                        marker->cm_tgtname);
 404         } else if (swab) {
 405                 __swab64s(&marker->cm_createtime);
 406                 __swab64s(&marker->cm_canceltime);
 407         }
 408 }