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/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/obdclass/llog_swab.c
34 * Swabbing of llog datatypes (from disk or over the wire).
36 * Author: jacob berkman <jacob@clusterfs.com>
39 #define DEBUG_SUBSYSTEM S_LOG
42 #include <lustre_log.h>
43 #include <lustre_update.h>
45 static void print_llogd_body(struct llogd_body *d)
47 CDEBUG(D_OTHER, "llogd body: %p\n", d);
48 CDEBUG(D_OTHER, "\tlgd_logid.lgl_oi.oi_fid: "DFID"\n",
49 PFID(&d->lgd_logid.lgl_oi.oi_fid));
50 CDEBUG(D_OTHER, "\tlgd_logid.lgl_ogen: %#x\n", d->lgd_logid.lgl_ogen);
51 CDEBUG(D_OTHER, "\tlgd_ctxt_idx: %#x\n", d->lgd_ctxt_idx);
52 CDEBUG(D_OTHER, "\tlgd_llh_flags: %#x\n", d->lgd_llh_flags);
53 CDEBUG(D_OTHER, "\tlgd_index: %#x\n", d->lgd_index);
54 CDEBUG(D_OTHER, "\tlgd_saved_index: %#x\n", d->lgd_saved_index);
55 CDEBUG(D_OTHER, "\tlgd_len: %#x\n", d->lgd_len);
56 CDEBUG(D_OTHER, "\tlgd_cur_offset: %#llx\n", d->lgd_cur_offset);
59 void lustre_swab_lu_fid(struct lu_fid *fid)
61 __swab64s (&fid->f_seq);
62 __swab32s (&fid->f_oid);
63 __swab32s (&fid->f_ver);
65 EXPORT_SYMBOL(lustre_swab_lu_fid);
67 void lustre_swab_ost_id(struct ost_id *oid)
69 if (fid_seq_is_mdt0(oid->oi.oi_seq) ||
70 fid_seq_is_default(oid->oi.oi_seq)) {
71 __swab64s(&oid->oi.oi_id);
72 __swab64s(&oid->oi.oi_seq);
74 lustre_swab_lu_fid(&oid->oi_fid);
77 EXPORT_SYMBOL(lustre_swab_ost_id);
79 void lustre_swab_llog_id(struct llog_logid *log_id)
81 __swab64s(&log_id->lgl_oi.oi.oi_id);
82 __swab64s(&log_id->lgl_oi.oi.oi_seq);
83 __swab32s(&log_id->lgl_ogen);
86 void lustre_swab_llogd_body (struct 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);
100 EXPORT_SYMBOL(lustre_swab_llogd_body);
102 void lustre_swab_llogd_conn_body (struct llogd_conn_body *d)
104 __swab64s (&d->lgdc_gen.mnt_cnt);
105 __swab64s (&d->lgdc_gen.conn_cnt);
106 lustre_swab_llog_id(&d->lgdc_logid);
107 __swab32s (&d->lgdc_ctxt_idx);
109 EXPORT_SYMBOL(lustre_swab_llogd_conn_body);
111 void lustre_swab_ll_fid(struct ll_fid *fid)
113 __swab64s (&fid->id);
114 __swab32s (&fid->generation);
115 __swab32s (&fid->f_type);
118 void lustre_swab_lu_seq_range(struct lu_seq_range *range)
120 __swab64s (&range->lsr_start);
121 __swab64s (&range->lsr_end);
122 __swab32s (&range->lsr_index);
123 __swab32s (&range->lsr_flags);
125 EXPORT_SYMBOL(lustre_swab_lu_seq_range);
127 void lustre_swab_update_ops(struct update_ops *uops, unsigned int op_count)
132 for (i = 0; i < op_count; i++) {
133 lustre_swab_lu_fid(&uops->uops_op[i].uop_fid);
134 __swab16s(&uops->uops_op[i].uop_type);
135 __swab16s(&uops->uops_op[i].uop_param_count);
136 for (j = 0; j < uops->uops_op[i].uop_param_count; j++)
137 __swab16s(&uops->uops_op[i].uop_params_off[j]);
140 EXPORT_SYMBOL(lustre_swab_update_ops);
142 void lustre_swab_llog_rec(struct llog_rec_hdr *rec)
144 struct llog_rec_tail *tail = NULL;
146 __swab32s(&rec->lrh_len);
147 __swab32s(&rec->lrh_index);
148 __swab32s(&rec->lrh_type);
149 __swab32s(&rec->lrh_id);
151 switch (rec->lrh_type) {
154 struct llog_size_change_rec *lsc =
155 (struct llog_size_change_rec *)rec;
157 lustre_swab_ll_fid(&lsc->lsc_fid);
158 __swab32s(&lsc->lsc_ioepoch);
159 tail = &lsc->lsc_tail;
164 struct llog_unlink_rec *lur = (struct llog_unlink_rec *)rec;
166 __swab64s(&lur->lur_oid);
167 __swab32s(&lur->lur_oseq);
168 __swab32s(&lur->lur_count);
169 tail = &lur->lur_tail;
172 case MDS_UNLINK64_REC:
174 struct llog_unlink64_rec *lur =
175 (struct llog_unlink64_rec *)rec;
177 lustre_swab_lu_fid(&lur->lur_fid);
178 __swab32s(&lur->lur_count);
179 tail = &lur->lur_tail;
184 struct llog_changelog_rec *cr =
185 (struct llog_changelog_rec *)rec;
187 __swab16s(&cr->cr.cr_namelen);
188 __swab16s(&cr->cr.cr_flags);
189 __swab32s(&cr->cr.cr_type);
190 __swab64s(&cr->cr.cr_index);
191 __swab64s(&cr->cr.cr_prev);
192 __swab64s(&cr->cr.cr_time);
193 lustre_swab_lu_fid(&cr->cr.cr_tfid);
194 lustre_swab_lu_fid(&cr->cr.cr_pfid);
195 if (cr->cr.cr_flags & CLF_RENAME) {
196 struct changelog_ext_rename *rnm =
197 changelog_rec_rename(&cr->cr);
199 lustre_swab_lu_fid(&rnm->cr_sfid);
200 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 */
204 tail = (struct llog_rec_tail *)((char *)&cr->cr +
205 changelog_rec_size(&cr->cr) +
210 case CHANGELOG_USER_REC:
212 struct llog_changelog_user_rec *cur =
213 (struct llog_changelog_user_rec*)rec;
215 __swab32s(&cur->cur_id);
216 __swab64s(&cur->cur_endrec);
217 __swab32s(&cur->cur_time);
218 tail = &cur->cur_tail;
222 case HSM_AGENT_REC: {
223 struct llog_agent_req_rec *arr =
224 (struct llog_agent_req_rec *)rec;
226 __swab32s(&arr->arr_hai.hai_len);
227 __swab32s(&arr->arr_hai.hai_action);
228 lustre_swab_lu_fid(&arr->arr_hai.hai_fid);
229 lustre_swab_lu_fid(&arr->arr_hai.hai_dfid);
230 __swab64s(&arr->arr_hai.hai_cookie);
231 __swab64s(&arr->arr_hai.hai_extent.offset);
232 __swab64s(&arr->arr_hai.hai_extent.length);
233 __swab64s(&arr->arr_hai.hai_gid);
234 /* no swabing for opaque data */
239 case MDS_SETATTR64_REC:
241 struct llog_setattr64_rec *lsr =
242 (struct llog_setattr64_rec *)rec;
244 lustre_swab_ost_id(&lsr->lsr_oi);
245 __swab32s(&lsr->lsr_uid);
246 __swab32s(&lsr->lsr_uid_h);
247 __swab32s(&lsr->lsr_gid);
248 __swab32s(&lsr->lsr_gid_h);
249 __swab64s(&lsr->lsr_valid);
251 if (rec->lrh_len > sizeof(struct llog_setattr64_rec)) {
252 struct llog_setattr64_rec_v2 *lsr2 =
253 (struct llog_setattr64_rec_v2 *)rec;
255 __swab32s(&lsr2->lsr_projid);
256 __swab32s(&lsr2->lsr_layout_version);
257 tail = &lsr2->lsr_tail;
259 tail = &lsr->lsr_tail;
264 /* these are swabbed as they are consumed */
268 struct llog_log_hdr *llh = (struct llog_log_hdr *)rec;
270 __swab64s(&llh->llh_timestamp);
271 __swab32s(&llh->llh_count);
272 __swab32s(&llh->llh_bitmap_offset);
273 __swab32s(&llh->llh_flags);
274 __swab32s(&llh->llh_size);
275 __swab32s(&llh->llh_cat_idx);
276 tail = LLOG_HDR_TAIL(llh);
279 case LLOG_LOGID_MAGIC:
281 struct llog_logid_rec *lid = (struct llog_logid_rec *)rec;
283 lustre_swab_llog_id(&lid->lid_id);
284 tail = &lid->lid_tail;
289 struct llog_gen_rec *lgr = (struct llog_gen_rec *)rec;
291 __swab64s(&lgr->lgr_gen.mnt_cnt);
292 __swab64s(&lgr->lgr_gen.conn_cnt);
293 tail = &lgr->lgr_tail;
300 struct llog_update_record *lur =
301 (struct llog_update_record *)rec;
302 struct update_records *record = &lur->lur_update_rec;
304 __swab32s(&record->ur_flags);
305 __swab64s(&record->ur_batchid);
306 __swab64s(&record->ur_master_transno);
307 __swab32s(&record->ur_param_count);
308 __swab32s(&record->ur_update_count);
309 lustre_swab_update_ops(&record->ur_ops,
310 record->ur_update_count);
312 /* Compute tail location. */
313 tail = (struct llog_rec_tail *)((char *)record +
314 update_records_size(record));
318 CERROR("Unknown llog rec type %#x swabbing rec %p\n",
323 __swab32s(&tail->lrt_len);
324 __swab32s(&tail->lrt_index);
328 static void print_llog_hdr(struct llog_log_hdr *h)
330 CDEBUG(D_OTHER, "llog header: %p\n", h);
331 CDEBUG(D_OTHER, "\tllh_hdr.lrh_index: %#x\n", h->llh_hdr.lrh_index);
332 CDEBUG(D_OTHER, "\tllh_hdr.lrh_len: %#x\n", h->llh_hdr.lrh_len);
333 CDEBUG(D_OTHER, "\tllh_hdr.lrh_type: %#x\n", h->llh_hdr.lrh_type);
334 CDEBUG(D_OTHER, "\tllh_timestamp: %#llx\n", h->llh_timestamp);
335 CDEBUG(D_OTHER, "\tllh_count: %#x\n", h->llh_count);
336 CDEBUG(D_OTHER, "\tllh_bitmap_offset: %#x\n", h->llh_bitmap_offset);
337 CDEBUG(D_OTHER, "\tllh_flags: %#x\n", h->llh_flags);
338 CDEBUG(D_OTHER, "\tllh_size: %#x\n", h->llh_size);
339 CDEBUG(D_OTHER, "\tllh_cat_idx: %#x\n", h->llh_cat_idx);
340 CDEBUG(D_OTHER, "\tllh_tail.lrt_index: %#x\n",
341 LLOG_HDR_TAIL(h)->lrt_index);
342 CDEBUG(D_OTHER, "\tllh_tail.lrt_len: %#x\n",
343 LLOG_HDR_TAIL(h)->lrt_len);
346 void lustre_swab_llog_hdr (struct llog_log_hdr *h)
351 lustre_swab_llog_rec(&h->llh_hdr);
356 EXPORT_SYMBOL(lustre_swab_llog_hdr);
358 static void print_lustre_cfg(struct lustre_cfg *lcfg)
363 if (!(libcfs_debug & D_OTHER)) /* don't loop on nothing */
365 CDEBUG(D_OTHER, "lustre_cfg: %p\n", lcfg);
366 CDEBUG(D_OTHER, "\tlcfg->lcfg_version: %#x\n", lcfg->lcfg_version);
368 CDEBUG(D_OTHER, "\tlcfg->lcfg_command: %#x\n", lcfg->lcfg_command);
369 CDEBUG(D_OTHER, "\tlcfg->lcfg_num: %#x\n", lcfg->lcfg_num);
370 CDEBUG(D_OTHER, "\tlcfg->lcfg_flags: %#x\n", lcfg->lcfg_flags);
371 CDEBUG(D_OTHER, "\tlcfg->lcfg_nid: %s\n", libcfs_nid2str(lcfg->lcfg_nid));
373 CDEBUG(D_OTHER, "\tlcfg->lcfg_bufcount: %d\n", lcfg->lcfg_bufcount);
374 if (lcfg->lcfg_bufcount < LUSTRE_CFG_MAX_BUFCOUNT)
375 for (i = 0; i < lcfg->lcfg_bufcount; i++)
376 CDEBUG(D_OTHER, "\tlcfg->lcfg_buflens[%d]: %d\n",
377 i, lcfg->lcfg_buflens[i]);
381 void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg)
386 __swab32s(&lcfg->lcfg_version);
388 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION) {
389 CERROR("not swabbing lustre_cfg version %#x (expecting %#x)\n",
390 lcfg->lcfg_version, LUSTRE_CFG_VERSION);
395 __swab32s(&lcfg->lcfg_command);
396 __swab32s(&lcfg->lcfg_num);
397 __swab32s(&lcfg->lcfg_flags);
398 __swab64s(&lcfg->lcfg_nid);
399 __swab32s(&lcfg->lcfg_bufcount);
400 for (i = 0; i < lcfg->lcfg_bufcount && i < LUSTRE_CFG_MAX_BUFCOUNT; i++)
401 __swab32s(&lcfg->lcfg_buflens[i]);
403 print_lustre_cfg(lcfg);
408 /* used only for compatibility with old on-disk cfg_marker data */
409 struct cfg_marker32 {
416 char cm_tgtname[MTI_NAME_MAXLEN];
417 char cm_comment[MTI_NAME_MAXLEN];
420 #define MTI_NAMELEN32 (MTI_NAME_MAXLEN - \
421 (sizeof(struct cfg_marker) - sizeof(struct cfg_marker32)))
423 void lustre_swab_cfg_marker(struct cfg_marker *marker, int swab, int size)
425 struct cfg_marker32 *cm32 = (struct cfg_marker32*)marker;
429 __swab32s(&marker->cm_step);
430 __swab32s(&marker->cm_flags);
431 __swab32s(&marker->cm_vers);
433 if (size == sizeof(*cm32)) {
434 __u32 createtime, canceltime;
435 /* There was a problem with the original declaration of
436 * cfg_marker on 32-bit systems because it used time_t as
437 * a wire protocol structure, and didn't verify this in
438 * wirecheck. We now have to convert the offsets of the
439 * later fields in order to work on 32- and 64-bit systems.
441 * Fortunately, the cm_comment field has no functional use
442 * so can be sacrificed when converting the timestamp size.
444 * Overwrite fields from the end first, so they are not
445 * clobbered, and use memmove() instead of memcpy() because
446 * the source and target buffers overlap. bug 16771 */
447 createtime = cm32->cm_createtime;
448 canceltime = cm32->cm_canceltime;
449 memmove(marker->cm_comment, cm32->cm_comment, MTI_NAMELEN32);
450 marker->cm_comment[MTI_NAMELEN32 - 1] = '\0';
451 memmove(marker->cm_tgtname, cm32->cm_tgtname,
452 sizeof(marker->cm_tgtname));
454 __swab32s(&createtime);
455 __swab32s(&canceltime);
457 marker->cm_createtime = createtime;
458 marker->cm_canceltime = canceltime;
459 CDEBUG(D_CONFIG, "Find old cfg_marker(Srv32b,Clt64b) "
460 "for target %s, converting\n",
463 __swab64s(&marker->cm_createtime);
464 __swab64s(&marker->cm_canceltime);