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.sun.com/software/products/lustre/docs/GPLv2.pdf
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
27 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2015, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/obdclass/llog_swab.c
38 * Swabbing of llog datatypes (from disk or over the wire).
40 * Author: jacob berkman <jacob@clusterfs.com>
43 #define DEBUG_SUBSYSTEM S_LOG
46 #include <lustre_log.h>
47 #include <lustre_update.h>
49 static void print_llogd_body(struct llogd_body *d)
51 CDEBUG(D_OTHER, "llogd body: %p\n", d);
52 CDEBUG(D_OTHER, "\tlgd_logid.lgl_oi: "DOSTID"\n",
53 POSTID(&d->lgd_logid.lgl_oi));
54 CDEBUG(D_OTHER, "\tlgd_logid.lgl_ogen: %#x\n", d->lgd_logid.lgl_ogen);
55 CDEBUG(D_OTHER, "\tlgd_ctxt_idx: %#x\n", d->lgd_ctxt_idx);
56 CDEBUG(D_OTHER, "\tlgd_llh_flags: %#x\n", d->lgd_llh_flags);
57 CDEBUG(D_OTHER, "\tlgd_index: %#x\n", d->lgd_index);
58 CDEBUG(D_OTHER, "\tlgd_saved_index: %#x\n", d->lgd_saved_index);
59 CDEBUG(D_OTHER, "\tlgd_len: %#x\n", d->lgd_len);
60 CDEBUG(D_OTHER, "\tlgd_cur_offset: "LPX64"\n", d->lgd_cur_offset);
63 void lustre_swab_lu_fid(struct lu_fid *fid)
65 __swab64s (&fid->f_seq);
66 __swab32s (&fid->f_oid);
67 __swab32s (&fid->f_ver);
69 EXPORT_SYMBOL(lustre_swab_lu_fid);
71 void lustre_swab_ost_id(struct ost_id *oid)
73 if (fid_seq_is_mdt0(oid->oi.oi_seq) ||
74 fid_seq_is_default(oid->oi.oi_seq)) {
75 __swab64s(&oid->oi.oi_id);
76 __swab64s(&oid->oi.oi_seq);
78 lustre_swab_lu_fid(&oid->oi_fid);
81 EXPORT_SYMBOL(lustre_swab_ost_id);
83 void lustre_swab_llog_id(struct llog_logid *log_id)
85 __swab64s(&log_id->lgl_oi.oi.oi_id);
86 __swab64s(&log_id->lgl_oi.oi.oi_seq);
87 __swab32s(&log_id->lgl_ogen);
90 void lustre_swab_llogd_body (struct llogd_body *d)
94 lustre_swab_llog_id(&d->lgd_logid);
95 __swab32s (&d->lgd_ctxt_idx);
96 __swab32s (&d->lgd_llh_flags);
97 __swab32s (&d->lgd_index);
98 __swab32s (&d->lgd_saved_index);
99 __swab32s (&d->lgd_len);
100 __swab64s (&d->lgd_cur_offset);
104 EXPORT_SYMBOL(lustre_swab_llogd_body);
106 void lustre_swab_llogd_conn_body (struct llogd_conn_body *d)
108 __swab64s (&d->lgdc_gen.mnt_cnt);
109 __swab64s (&d->lgdc_gen.conn_cnt);
110 lustre_swab_llog_id(&d->lgdc_logid);
111 __swab32s (&d->lgdc_ctxt_idx);
113 EXPORT_SYMBOL(lustre_swab_llogd_conn_body);
115 void lustre_swab_ll_fid(struct ll_fid *fid)
117 __swab64s (&fid->id);
118 __swab32s (&fid->generation);
119 __swab32s (&fid->f_type);
122 void lustre_swab_lu_seq_range(struct lu_seq_range *range)
124 __swab64s (&range->lsr_start);
125 __swab64s (&range->lsr_end);
126 __swab32s (&range->lsr_index);
127 __swab32s (&range->lsr_flags);
129 EXPORT_SYMBOL(lustre_swab_lu_seq_range);
131 void lustre_swab_update_ops(struct update_ops *uops, unsigned int op_count)
136 for (i = 0; i < op_count; i++) {
137 lustre_swab_lu_fid(&uops->uops_op[i].uop_fid);
138 __swab16s(&uops->uops_op[i].uop_type);
139 __swab16s(&uops->uops_op[i].uop_param_count);
140 for (j = 0; j < uops->uops_op[i].uop_param_count; j++)
141 __swab16s(&uops->uops_op[i].uop_params_off[j]);
144 EXPORT_SYMBOL(lustre_swab_update_ops);
146 void lustre_swab_llog_rec(struct llog_rec_hdr *rec)
148 struct llog_rec_tail *tail = NULL;
150 __swab32s(&rec->lrh_len);
151 __swab32s(&rec->lrh_index);
152 __swab32s(&rec->lrh_type);
153 __swab32s(&rec->lrh_id);
155 switch (rec->lrh_type) {
158 struct llog_size_change_rec *lsc =
159 (struct llog_size_change_rec *)rec;
161 lustre_swab_ll_fid(&lsc->lsc_fid);
162 __swab32s(&lsc->lsc_ioepoch);
163 tail = &lsc->lsc_tail;
168 struct llog_unlink_rec *lur = (struct llog_unlink_rec *)rec;
170 __swab64s(&lur->lur_oid);
171 __swab32s(&lur->lur_oseq);
172 __swab32s(&lur->lur_count);
173 tail = &lur->lur_tail;
176 case MDS_UNLINK64_REC:
178 struct llog_unlink64_rec *lur =
179 (struct llog_unlink64_rec *)rec;
181 lustre_swab_lu_fid(&lur->lur_fid);
182 __swab32s(&lur->lur_count);
183 tail = &lur->lur_tail;
188 struct llog_changelog_rec *cr =
189 (struct llog_changelog_rec *)rec;
191 __swab16s(&cr->cr.cr_namelen);
192 __swab16s(&cr->cr.cr_flags);
193 __swab32s(&cr->cr.cr_type);
194 __swab64s(&cr->cr.cr_index);
195 __swab64s(&cr->cr.cr_prev);
196 __swab64s(&cr->cr.cr_time);
197 lustre_swab_lu_fid(&cr->cr.cr_tfid);
198 lustre_swab_lu_fid(&cr->cr.cr_pfid);
199 if (cr->cr.cr_flags & CLF_RENAME) {
200 struct changelog_ext_rename *rnm =
201 changelog_rec_rename(&cr->cr);
203 lustre_swab_lu_fid(&rnm->cr_sfid);
204 lustre_swab_lu_fid(&rnm->cr_spfid);
206 /* Because the tail follows a variable-length structure we need
207 * to compute its location at runtime */
208 tail = (struct llog_rec_tail *)((char *)&cr->cr +
209 changelog_rec_size(&cr->cr) +
214 case CHANGELOG_USER_REC:
216 struct llog_changelog_user_rec *cur =
217 (struct llog_changelog_user_rec*)rec;
219 __swab32s(&cur->cur_id);
220 __swab64s(&cur->cur_endrec);
221 tail = &cur->cur_tail;
225 case HSM_AGENT_REC: {
226 struct llog_agent_req_rec *arr =
227 (struct llog_agent_req_rec *)rec;
229 __swab32s(&arr->arr_hai.hai_len);
230 __swab32s(&arr->arr_hai.hai_action);
231 lustre_swab_lu_fid(&arr->arr_hai.hai_fid);
232 lustre_swab_lu_fid(&arr->arr_hai.hai_dfid);
233 __swab64s(&arr->arr_hai.hai_cookie);
234 __swab64s(&arr->arr_hai.hai_extent.offset);
235 __swab64s(&arr->arr_hai.hai_extent.length);
236 __swab64s(&arr->arr_hai.hai_gid);
237 /* 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);
253 tail = &lsr->lsr_tail;
257 /* these are swabbed as they are consumed */
261 struct llog_log_hdr *llh = (struct llog_log_hdr *)rec;
263 __swab64s(&llh->llh_timestamp);
264 __swab32s(&llh->llh_count);
265 __swab32s(&llh->llh_bitmap_offset);
266 __swab32s(&llh->llh_flags);
267 __swab32s(&llh->llh_size);
268 __swab32s(&llh->llh_cat_idx);
269 tail = LLOG_HDR_TAIL(llh);
272 case LLOG_LOGID_MAGIC:
274 struct llog_logid_rec *lid = (struct llog_logid_rec *)rec;
276 lustre_swab_llog_id(&lid->lid_id);
277 tail = &lid->lid_tail;
282 struct llog_gen_rec *lgr = (struct llog_gen_rec *)rec;
284 __swab64s(&lgr->lgr_gen.mnt_cnt);
285 __swab64s(&lgr->lgr_gen.conn_cnt);
286 tail = &lgr->lgr_tail;
293 struct llog_update_record *lur =
294 (struct llog_update_record *)rec;
295 struct update_records *record = &lur->lur_update_rec;
297 __swab32s(&record->ur_flags);
298 __swab64s(&record->ur_batchid);
299 __swab64s(&record->ur_master_transno);
300 __swab32s(&record->ur_param_count);
301 __swab32s(&record->ur_update_count);
302 lustre_swab_update_ops(&record->ur_ops,
303 record->ur_update_count);
305 /* Compute tail location. */
306 tail = (struct llog_rec_tail *)((char *)record +
307 update_records_size(record));
311 CERROR("Unknown llog rec type %#x swabbing rec %p\n",
316 __swab32s(&tail->lrt_len);
317 __swab32s(&tail->lrt_index);
321 static void print_llog_hdr(struct llog_log_hdr *h)
323 CDEBUG(D_OTHER, "llog header: %p\n", h);
324 CDEBUG(D_OTHER, "\tllh_hdr.lrh_index: %#x\n", h->llh_hdr.lrh_index);
325 CDEBUG(D_OTHER, "\tllh_hdr.lrh_len: %#x\n", h->llh_hdr.lrh_len);
326 CDEBUG(D_OTHER, "\tllh_hdr.lrh_type: %#x\n", h->llh_hdr.lrh_type);
327 CDEBUG(D_OTHER, "\tllh_timestamp: "LPX64"\n", h->llh_timestamp);
328 CDEBUG(D_OTHER, "\tllh_count: %#x\n", h->llh_count);
329 CDEBUG(D_OTHER, "\tllh_bitmap_offset: %#x\n", h->llh_bitmap_offset);
330 CDEBUG(D_OTHER, "\tllh_flags: %#x\n", h->llh_flags);
331 CDEBUG(D_OTHER, "\tllh_size: %#x\n", h->llh_size);
332 CDEBUG(D_OTHER, "\tllh_cat_idx: %#x\n", h->llh_cat_idx);
333 CDEBUG(D_OTHER, "\tllh_tail.lrt_index: %#x\n",
334 LLOG_HDR_TAIL(h)->lrt_index);
335 CDEBUG(D_OTHER, "\tllh_tail.lrt_len: %#x\n",
336 LLOG_HDR_TAIL(h)->lrt_len);
339 void lustre_swab_llog_hdr (struct llog_log_hdr *h)
344 lustre_swab_llog_rec(&h->llh_hdr);
349 EXPORT_SYMBOL(lustre_swab_llog_hdr);
351 static void print_lustre_cfg(struct lustre_cfg *lcfg)
356 if (!(libcfs_debug & D_OTHER)) /* don't loop on nothing */
358 CDEBUG(D_OTHER, "lustre_cfg: %p\n", lcfg);
359 CDEBUG(D_OTHER, "\tlcfg->lcfg_version: %#x\n", lcfg->lcfg_version);
361 CDEBUG(D_OTHER, "\tlcfg->lcfg_command: %#x\n", lcfg->lcfg_command);
362 CDEBUG(D_OTHER, "\tlcfg->lcfg_num: %#x\n", lcfg->lcfg_num);
363 CDEBUG(D_OTHER, "\tlcfg->lcfg_flags: %#x\n", lcfg->lcfg_flags);
364 CDEBUG(D_OTHER, "\tlcfg->lcfg_nid: %s\n", libcfs_nid2str(lcfg->lcfg_nid));
366 CDEBUG(D_OTHER, "\tlcfg->lcfg_bufcount: %d\n", lcfg->lcfg_bufcount);
367 if (lcfg->lcfg_bufcount < LUSTRE_CFG_MAX_BUFCOUNT)
368 for (i = 0; i < lcfg->lcfg_bufcount; i++)
369 CDEBUG(D_OTHER, "\tlcfg->lcfg_buflens[%d]: %d\n",
370 i, lcfg->lcfg_buflens[i]);
374 void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg)
379 __swab32s(&lcfg->lcfg_version);
381 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION) {
382 CERROR("not swabbing lustre_cfg version %#x (expecting %#x)\n",
383 lcfg->lcfg_version, LUSTRE_CFG_VERSION);
388 __swab32s(&lcfg->lcfg_command);
389 __swab32s(&lcfg->lcfg_num);
390 __swab32s(&lcfg->lcfg_flags);
391 __swab64s(&lcfg->lcfg_nid);
392 __swab32s(&lcfg->lcfg_bufcount);
393 for (i = 0; i < lcfg->lcfg_bufcount && i < LUSTRE_CFG_MAX_BUFCOUNT; i++)
394 __swab32s(&lcfg->lcfg_buflens[i]);
396 print_lustre_cfg(lcfg);
401 /* used only for compatibility with old on-disk cfg_marker data */
402 struct cfg_marker32 {
409 char cm_tgtname[MTI_NAME_MAXLEN];
410 char cm_comment[MTI_NAME_MAXLEN];
413 #define MTI_NAMELEN32 (MTI_NAME_MAXLEN - \
414 (sizeof(struct cfg_marker) - sizeof(struct cfg_marker32)))
416 void lustre_swab_cfg_marker(struct cfg_marker *marker, int swab, int size)
418 struct cfg_marker32 *cm32 = (struct cfg_marker32*)marker;
422 __swab32s(&marker->cm_step);
423 __swab32s(&marker->cm_flags);
424 __swab32s(&marker->cm_vers);
426 if (size == sizeof(*cm32)) {
427 __u32 createtime, canceltime;
428 /* There was a problem with the original declaration of
429 * cfg_marker on 32-bit systems because it used time_t as
430 * a wire protocol structure, and didn't verify this in
431 * wirecheck. We now have to convert the offsets of the
432 * later fields in order to work on 32- and 64-bit systems.
434 * Fortunately, the cm_comment field has no functional use
435 * so can be sacrificed when converting the timestamp size.
437 * Overwrite fields from the end first, so they are not
438 * clobbered, and use memmove() instead of memcpy() because
439 * the source and target buffers overlap. bug 16771 */
440 createtime = cm32->cm_createtime;
441 canceltime = cm32->cm_canceltime;
442 memmove(marker->cm_comment, cm32->cm_comment, MTI_NAMELEN32);
443 marker->cm_comment[MTI_NAMELEN32 - 1] = '\0';
444 memmove(marker->cm_tgtname, cm32->cm_tgtname,
445 sizeof(marker->cm_tgtname));
447 __swab32s(&createtime);
448 __swab32s(&canceltime);
450 marker->cm_createtime = createtime;
451 marker->cm_canceltime = canceltime;
452 CDEBUG(D_CONFIG, "Find old cfg_marker(Srv32b,Clt64b) "
453 "for target %s, converting\n",
456 __swab64s(&marker->cm_createtime);
457 __swab64s(&marker->cm_canceltime);