4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
31 * lustre/obdclass/llog_swab.c
33 * Swabbing of llog datatypes (from disk or over the wire).
35 * Author: jacob berkman <jacob@clusterfs.com>
38 #define DEBUG_SUBSYSTEM S_LOG
41 #include <lustre_log.h>
42 #include <lustre_update.h>
44 static void print_llogd_body(struct llogd_body *d)
46 CDEBUG(D_OTHER, "llogd body: %p\n", d);
47 CDEBUG(D_OTHER, "\tlgd_logid.lgl_oi.oi_fid: "DFID"\n",
48 PFID(&d->lgd_logid.lgl_oi.oi_fid));
49 CDEBUG(D_OTHER, "\tlgd_logid.lgl_ogen: %#x\n", d->lgd_logid.lgl_ogen);
50 CDEBUG(D_OTHER, "\tlgd_ctxt_idx: %#x\n", d->lgd_ctxt_idx);
51 CDEBUG(D_OTHER, "\tlgd_llh_flags: %#x\n", d->lgd_llh_flags);
52 CDEBUG(D_OTHER, "\tlgd_index: %#x\n", d->lgd_index);
53 CDEBUG(D_OTHER, "\tlgd_saved_index: %#x\n", d->lgd_saved_index);
54 CDEBUG(D_OTHER, "\tlgd_len: %#x\n", d->lgd_len);
55 CDEBUG(D_OTHER, "\tlgd_cur_offset: %#llx\n", d->lgd_cur_offset);
58 void lustre_swab_lu_fid(struct lu_fid *fid)
60 __swab64s(&fid->f_seq);
61 __swab32s(&fid->f_oid);
62 __swab32s(&fid->f_ver);
64 EXPORT_SYMBOL(lustre_swab_lu_fid);
66 void lustre_swab_ost_id(struct ost_id *oid)
68 if (fid_seq_is_mdt0(oid->oi.oi_seq) ||
69 fid_seq_is_default(oid->oi.oi_seq)) {
70 __swab64s(&oid->oi.oi_id);
71 __swab64s(&oid->oi.oi_seq);
73 lustre_swab_lu_fid(&oid->oi_fid);
76 EXPORT_SYMBOL(lustre_swab_ost_id);
78 void lustre_swab_llog_id(struct llog_logid *log_id)
80 __swab64s(&log_id->lgl_oi.oi.oi_id);
81 __swab64s(&log_id->lgl_oi.oi.oi_seq);
82 __swab32s(&log_id->lgl_ogen);
85 void lustre_swab_llogd_body (struct llogd_body *d)
89 lustre_swab_llog_id(&d->lgd_logid);
90 __swab32s(&d->lgd_ctxt_idx);
91 __swab32s(&d->lgd_llh_flags);
92 __swab32s(&d->lgd_index);
93 __swab32s(&d->lgd_saved_index);
94 __swab32s(&d->lgd_len);
95 __swab64s(&d->lgd_cur_offset);
99 EXPORT_SYMBOL(lustre_swab_llogd_body);
101 void lustre_swab_llogd_conn_body (struct llogd_conn_body *d)
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);
108 EXPORT_SYMBOL(lustre_swab_llogd_conn_body);
110 void lustre_swab_ll_fid(struct ll_fid *fid)
113 __swab32s(&fid->generation);
114 __swab32s(&fid->f_type);
117 void lustre_swab_lu_seq_range(struct lu_seq_range *range)
119 __swab64s(&range->lsr_start);
120 __swab64s(&range->lsr_end);
121 __swab32s(&range->lsr_index);
122 __swab32s(&range->lsr_flags);
124 EXPORT_SYMBOL(lustre_swab_lu_seq_range);
126 void lustre_swab_update_ops(struct update_ops *uops, unsigned int op_count)
131 for (i = 0; i < op_count; i++) {
132 lustre_swab_lu_fid(&uops->uops_op[i].uop_fid);
133 __swab16s(&uops->uops_op[i].uop_type);
134 __swab16s(&uops->uops_op[i].uop_param_count);
135 for (j = 0; j < uops->uops_op[i].uop_param_count; j++)
136 __swab16s(&uops->uops_op[i].uop_params_off[j]);
139 EXPORT_SYMBOL(lustre_swab_update_ops);
141 void lustre_swab_llog_rec(struct llog_rec_hdr *rec)
143 struct llog_rec_tail *tail = NULL;
145 __swab32s(&rec->lrh_len);
146 __swab32s(&rec->lrh_index);
147 __swab32s(&rec->lrh_type);
148 __swab32s(&rec->lrh_id);
150 switch (rec->lrh_type) {
153 struct llog_size_change_rec *lsc =
154 (struct llog_size_change_rec *)rec;
156 lustre_swab_ll_fid(&lsc->lsc_fid);
157 __swab32s(&lsc->lsc_ioepoch);
158 tail = &lsc->lsc_tail;
163 struct llog_unlink_rec *lur = (struct llog_unlink_rec *)rec;
165 __swab64s(&lur->lur_oid);
166 __swab32s(&lur->lur_oseq);
167 __swab32s(&lur->lur_count);
168 tail = &lur->lur_tail;
171 case MDS_UNLINK64_REC:
173 struct llog_unlink64_rec *lur =
174 (struct llog_unlink64_rec *)rec;
176 lustre_swab_lu_fid(&lur->lur_fid);
177 __swab32s(&lur->lur_count);
178 tail = &lur->lur_tail;
183 struct llog_changelog_rec *cr =
184 (struct llog_changelog_rec *)rec;
186 __swab16s(&cr->cr.cr_namelen);
187 __swab16s(&cr->cr.cr_flags);
188 __swab32s(&cr->cr.cr_type);
189 __swab64s(&cr->cr.cr_index);
190 __swab64s(&cr->cr.cr_prev);
191 __swab64s(&cr->cr.cr_time);
192 lustre_swab_lu_fid(&cr->cr.cr_tfid);
193 lustre_swab_lu_fid(&cr->cr.cr_pfid);
194 if (cr->cr.cr_flags & CLF_RENAME) {
195 struct changelog_ext_rename *rnm =
196 changelog_rec_rename(&cr->cr);
198 lustre_swab_lu_fid(&rnm->cr_sfid);
199 lustre_swab_lu_fid(&rnm->cr_spfid);
202 * Because the tail follows a variable-length structure we need
203 * to compute its location at runtime
205 tail = (struct llog_rec_tail *)((char *)&cr->cr +
206 changelog_rec_size(&cr->cr) +
211 case CHANGELOG_USER_REC:
213 struct llog_changelog_user_rec *cur =
214 (struct llog_changelog_user_rec *)rec;
216 __swab32s(&cur->cur_id);
217 __swab64s(&cur->cur_endrec);
218 __swab32s(&cur->cur_time);
219 tail = &cur->cur_tail;
223 case HSM_AGENT_REC: {
224 struct llog_agent_req_rec *arr =
225 (struct llog_agent_req_rec *)rec;
227 __swab32s(&arr->arr_hai.hai_len);
228 __swab32s(&arr->arr_hai.hai_action);
229 lustre_swab_lu_fid(&arr->arr_hai.hai_fid);
230 lustre_swab_lu_fid(&arr->arr_hai.hai_dfid);
231 __swab64s(&arr->arr_hai.hai_cookie);
232 __swab64s(&arr->arr_hai.hai_extent.offset);
233 __swab64s(&arr->arr_hai.hai_extent.length);
234 __swab64s(&arr->arr_hai.hai_gid);
236 * no swabing for opaque data
242 case MDS_SETATTR64_REC:
244 struct llog_setattr64_rec *lsr =
245 (struct llog_setattr64_rec *)rec;
247 lustre_swab_ost_id(&lsr->lsr_oi);
248 __swab32s(&lsr->lsr_uid);
249 __swab32s(&lsr->lsr_uid_h);
250 __swab32s(&lsr->lsr_gid);
251 __swab32s(&lsr->lsr_gid_h);
252 __swab64s(&lsr->lsr_valid);
254 if (rec->lrh_len > sizeof(struct llog_setattr64_rec)) {
255 struct llog_setattr64_rec_v2 *lsr2 =
256 (struct llog_setattr64_rec_v2 *)rec;
258 __swab32s(&lsr2->lsr_projid);
259 __swab32s(&lsr2->lsr_layout_version);
260 tail = &lsr2->lsr_tail;
262 tail = &lsr->lsr_tail;
267 /* these are swabbed as they are consumed */
271 struct llog_log_hdr *llh = (struct llog_log_hdr *)rec;
273 __swab64s(&llh->llh_timestamp);
274 __swab32s(&llh->llh_count);
275 __swab32s(&llh->llh_bitmap_offset);
276 __swab32s(&llh->llh_flags);
277 __swab32s(&llh->llh_size);
278 __swab32s(&llh->llh_cat_idx);
279 tail = LLOG_HDR_TAIL(llh);
282 case LLOG_LOGID_MAGIC:
284 struct llog_logid_rec *lid = (struct llog_logid_rec *)rec;
286 lustre_swab_llog_id(&lid->lid_id);
287 tail = &lid->lid_tail;
292 struct llog_gen_rec *lgr = (struct llog_gen_rec *)rec;
294 __swab64s(&lgr->lgr_gen.mnt_cnt);
295 __swab64s(&lgr->lgr_gen.conn_cnt);
296 tail = &lgr->lgr_tail;
303 struct llog_update_record *lur =
304 (struct llog_update_record *)rec;
305 struct update_records *record = &lur->lur_update_rec;
307 __swab32s(&record->ur_flags);
308 __swab64s(&record->ur_batchid);
309 __swab64s(&record->ur_master_transno);
310 __swab32s(&record->ur_param_count);
311 __swab32s(&record->ur_update_count);
312 lustre_swab_update_ops(&record->ur_ops,
313 record->ur_update_count);
315 /* Compute tail location. */
316 tail = (struct llog_rec_tail *)((char *)record +
317 update_records_size(record));
321 CERROR("Unknown llog rec type %#x swabbing rec %p\n",
326 __swab32s(&tail->lrt_len);
327 __swab32s(&tail->lrt_index);
331 static void print_llog_hdr(struct llog_log_hdr *h)
333 CDEBUG(D_OTHER, "llog header: %p\n", h);
334 CDEBUG(D_OTHER, "\tllh_hdr.lrh_index: %#x\n", h->llh_hdr.lrh_index);
335 CDEBUG(D_OTHER, "\tllh_hdr.lrh_len: %#x\n", h->llh_hdr.lrh_len);
336 CDEBUG(D_OTHER, "\tllh_hdr.lrh_type: %#x\n", h->llh_hdr.lrh_type);
337 CDEBUG(D_OTHER, "\tllh_timestamp: %#llx\n", h->llh_timestamp);
338 CDEBUG(D_OTHER, "\tllh_count: %#x\n", h->llh_count);
339 CDEBUG(D_OTHER, "\tllh_bitmap_offset: %#x\n", h->llh_bitmap_offset);
340 CDEBUG(D_OTHER, "\tllh_flags: %#x\n", h->llh_flags);
341 CDEBUG(D_OTHER, "\tllh_size: %#x\n", h->llh_size);
342 CDEBUG(D_OTHER, "\tllh_cat_idx: %#x\n", h->llh_cat_idx);
343 CDEBUG(D_OTHER, "\tllh_tail.lrt_index: %#x\n",
344 LLOG_HDR_TAIL(h)->lrt_index);
345 CDEBUG(D_OTHER, "\tllh_tail.lrt_len: %#x\n",
346 LLOG_HDR_TAIL(h)->lrt_len);
349 void lustre_swab_llog_hdr (struct llog_log_hdr *h)
354 lustre_swab_llog_rec(&h->llh_hdr);
359 EXPORT_SYMBOL(lustre_swab_llog_hdr);
361 void print_lustre_cfg(struct lustre_cfg *lcfg)
367 if (!(libcfs_debug & D_OTHER)) /* don't loop on nothing */
370 CDEBUG(D_OTHER, "lustre_cfg: %p\n", lcfg);
371 CDEBUG(D_OTHER, "\tlcfg->lcfg_version: %#x\n", lcfg->lcfg_version);
373 CDEBUG(D_OTHER, "\tlcfg->lcfg_command: %#x\n", lcfg->lcfg_command);
374 CDEBUG(D_OTHER, "\tlcfg->lcfg_num: %#x\n", lcfg->lcfg_num);
375 CDEBUG(D_OTHER, "\tlcfg->lcfg_flags: %#x\n", lcfg->lcfg_flags);
376 CDEBUG(D_OTHER, "\tlcfg->lcfg_nid: %s\n",
377 libcfs_nid2str(lcfg->lcfg_nid));
379 CDEBUG(D_OTHER, "\tlcfg->lcfg_bufcount: %d\n", lcfg->lcfg_bufcount);
380 if (lcfg->lcfg_bufcount < LUSTRE_CFG_MAX_BUFCOUNT)
381 for (i = 0; i < lcfg->lcfg_bufcount; i++) {
382 CDEBUG(D_OTHER, "\tlcfg->lcfg_buflens[%d]: %d %s\n",
383 i, lcfg->lcfg_buflens[i],
384 lustre_cfg_string(lcfg, i));
389 EXPORT_SYMBOL(print_lustre_cfg);
391 void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg)
397 __swab32s(&lcfg->lcfg_version);
399 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION) {
400 CERROR("not swabbing lustre_cfg version %#x (expecting %#x)\n",
401 lcfg->lcfg_version, LUSTRE_CFG_VERSION);
406 __swab32s(&lcfg->lcfg_command);
407 __swab32s(&lcfg->lcfg_num);
408 __swab32s(&lcfg->lcfg_flags);
409 __swab64s(&lcfg->lcfg_nid);
410 __swab32s(&lcfg->lcfg_bufcount);
411 for (i = 0; i < lcfg->lcfg_bufcount && i < LUSTRE_CFG_MAX_BUFCOUNT; i++)
412 __swab32s(&lcfg->lcfg_buflens[i]);
414 print_lustre_cfg(lcfg);
418 /* used only for compatibility with old on-disk cfg_marker data */
419 struct cfg_marker32 {
426 char cm_tgtname[MTI_NAME_MAXLEN];
427 char cm_comment[MTI_NAME_MAXLEN];
430 #define MTI_NAMELEN32 (MTI_NAME_MAXLEN - \
431 (sizeof(struct cfg_marker) - sizeof(struct cfg_marker32)))
433 void lustre_swab_cfg_marker(struct cfg_marker *marker, int swab, int size)
435 struct cfg_marker32 *cm32 = (struct cfg_marker32 *)marker;
440 __swab32s(&marker->cm_step);
441 __swab32s(&marker->cm_flags);
442 __swab32s(&marker->cm_vers);
444 if (size == sizeof(*cm32)) {
445 __u32 createtime, canceltime;
447 * There was a problem with the original declaration of
448 * cfg_marker on 32-bit systems because it used 32 time as
449 * a wire protocol structure, and didn't verify this in
450 * wirecheck. We now have to convert the offsets of the
451 * later fields in order to work on 32- and 64-bit systems.
453 * Fortunately, the cm_comment field has no functional use
454 * so can be sacrificed when converting the timestamp size.
456 * Overwrite fields from the end first, so they are not
457 * clobbered, and use memmove() instead of memcpy() because
458 * the source and target buffers overlap. bug 16771
460 createtime = cm32->cm_createtime;
461 canceltime = cm32->cm_canceltime;
462 memmove(marker->cm_comment, cm32->cm_comment, MTI_NAMELEN32);
463 marker->cm_comment[MTI_NAMELEN32 - 1] = '\0';
464 memmove(marker->cm_tgtname, cm32->cm_tgtname,
465 sizeof(marker->cm_tgtname));
467 __swab32s(&createtime);
468 __swab32s(&canceltime);
470 marker->cm_createtime = createtime;
471 marker->cm_canceltime = canceltime;
473 "Find old cfg_marker(Srv32b,Clt64b) for target %s, converting\n",
476 __swab64s(&marker->cm_createtime);
477 __swab64s(&marker->cm_canceltime);