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, 2013, 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 <liblustre.h>
49 #include <lustre_log.h>
51 static void print_llogd_body(struct llogd_body *d)
53 CDEBUG(D_OTHER, "llogd body: %p\n", d);
54 CDEBUG(D_OTHER, "\tlgd_logid.lgl_oi: "DOSTID"\n",
55 POSTID(&d->lgd_logid.lgl_oi));
56 CDEBUG(D_OTHER, "\tlgd_logid.lgl_ogen: %#x\n", d->lgd_logid.lgl_ogen);
57 CDEBUG(D_OTHER, "\tlgd_ctxt_idx: %#x\n", d->lgd_ctxt_idx);
58 CDEBUG(D_OTHER, "\tlgd_llh_flags: %#x\n", d->lgd_llh_flags);
59 CDEBUG(D_OTHER, "\tlgd_index: %#x\n", d->lgd_index);
60 CDEBUG(D_OTHER, "\tlgd_saved_index: %#x\n", d->lgd_saved_index);
61 CDEBUG(D_OTHER, "\tlgd_len: %#x\n", d->lgd_len);
62 CDEBUG(D_OTHER, "\tlgd_cur_offset: "LPX64"\n", d->lgd_cur_offset);
65 void lustre_swab_lu_fid(struct lu_fid *fid)
67 __swab64s (&fid->f_seq);
68 __swab32s (&fid->f_oid);
69 __swab32s (&fid->f_ver);
71 EXPORT_SYMBOL(lustre_swab_lu_fid);
73 void lustre_swab_ost_id(struct ost_id *oid)
75 if (fid_seq_is_mdt0(oid->oi.oi_seq) ||
76 fid_seq_is_default(oid->oi.oi_seq)) {
77 __swab64s(&oid->oi.oi_id);
78 __swab64s(&oid->oi.oi_seq);
80 lustre_swab_lu_fid(&oid->oi_fid);
83 EXPORT_SYMBOL(lustre_swab_ost_id);
85 void lustre_swab_llog_id(struct llog_logid *log_id)
87 __swab64s(&log_id->lgl_oi.oi.oi_id);
88 __swab64s(&log_id->lgl_oi.oi.oi_seq);
89 __swab32s(&log_id->lgl_ogen);
91 EXPORT_SYMBOL(lustre_swab_llog_id);
93 void lustre_swab_llogd_body (struct llogd_body *d)
97 lustre_swab_llog_id(&d->lgd_logid);
98 __swab32s (&d->lgd_ctxt_idx);
99 __swab32s (&d->lgd_llh_flags);
100 __swab32s (&d->lgd_index);
101 __swab32s (&d->lgd_saved_index);
102 __swab32s (&d->lgd_len);
103 __swab64s (&d->lgd_cur_offset);
107 EXPORT_SYMBOL(lustre_swab_llogd_body);
109 void lustre_swab_llogd_conn_body (struct llogd_conn_body *d)
111 __swab64s (&d->lgdc_gen.mnt_cnt);
112 __swab64s (&d->lgdc_gen.conn_cnt);
113 lustre_swab_llog_id(&d->lgdc_logid);
114 __swab32s (&d->lgdc_ctxt_idx);
116 EXPORT_SYMBOL(lustre_swab_llogd_conn_body);
118 void lustre_swab_ll_fid(struct ll_fid *fid)
120 __swab64s (&fid->id);
121 __swab32s (&fid->generation);
122 __swab32s (&fid->f_type);
124 EXPORT_SYMBOL(lustre_swab_ll_fid);
126 void lustre_swab_lu_seq_range(struct lu_seq_range *range)
128 __swab64s (&range->lsr_start);
129 __swab64s (&range->lsr_end);
130 __swab32s (&range->lsr_index);
131 __swab32s (&range->lsr_flags);
133 EXPORT_SYMBOL(lustre_swab_lu_seq_range);
135 void lustre_swab_llog_rec(struct llog_rec_hdr *rec)
137 struct llog_rec_tail *tail = NULL;
139 __swab32s(&rec->lrh_len);
140 __swab32s(&rec->lrh_index);
141 __swab32s(&rec->lrh_type);
142 __swab32s(&rec->lrh_id);
144 switch (rec->lrh_type) {
147 struct llog_size_change_rec *lsc =
148 (struct llog_size_change_rec *)rec;
150 lustre_swab_ll_fid(&lsc->lsc_fid);
151 __swab32s(&lsc->lsc_ioepoch);
152 tail = &lsc->lsc_tail;
157 struct llog_unlink_rec *lur = (struct llog_unlink_rec *)rec;
159 __swab64s(&lur->lur_oid);
160 __swab32s(&lur->lur_oseq);
161 __swab32s(&lur->lur_count);
162 tail = &lur->lur_tail;
165 case MDS_UNLINK64_REC:
167 struct llog_unlink64_rec *lur =
168 (struct llog_unlink64_rec *)rec;
170 lustre_swab_lu_fid(&lur->lur_fid);
171 __swab32s(&lur->lur_count);
172 tail = &lur->lur_tail;
177 struct llog_changelog_rec *cr = (struct llog_changelog_rec*)rec;
179 __swab16s(&cr->cr.cr_namelen);
180 __swab16s(&cr->cr.cr_flags);
181 __swab32s(&cr->cr.cr_type);
182 __swab64s(&cr->cr.cr_index);
183 __swab64s(&cr->cr.cr_prev);
184 __swab64s(&cr->cr.cr_time);
185 lustre_swab_lu_fid(&cr->cr.cr_tfid);
186 lustre_swab_lu_fid(&cr->cr.cr_pfid);
187 if (CHANGELOG_REC_EXTENDED(&cr->cr)) {
188 struct llog_changelog_ext_rec *ext =
189 (struct llog_changelog_ext_rec *)rec;
191 lustre_swab_lu_fid(&ext->cr.cr_sfid);
192 lustre_swab_lu_fid(&ext->cr.cr_spfid);
193 tail = &ext->cr_tail;
199 case CHANGELOG_USER_REC:
201 struct llog_changelog_user_rec *cur =
202 (struct llog_changelog_user_rec*)rec;
204 __swab32s(&cur->cur_id);
205 __swab64s(&cur->cur_endrec);
206 tail = &cur->cur_tail;
210 case HSM_AGENT_REC: {
211 struct llog_agent_req_rec *arr =
212 (struct llog_agent_req_rec *)rec;
214 __swab32s(&arr->arr_hai.hai_len);
215 __swab32s(&arr->arr_hai.hai_action);
216 lustre_swab_lu_fid(&arr->arr_hai.hai_fid);
217 lustre_swab_lu_fid(&arr->arr_hai.hai_dfid);
218 __swab64s(&arr->arr_hai.hai_cookie);
219 __swab64s(&arr->arr_hai.hai_extent.offset);
220 __swab64s(&arr->arr_hai.hai_extent.length);
221 __swab64s(&arr->arr_hai.hai_gid);
222 /* no swabing for opaque data */
227 case MDS_SETATTR64_REC:
229 struct llog_setattr64_rec *lsr =
230 (struct llog_setattr64_rec *)rec;
232 lustre_swab_ost_id(&lsr->lsr_oi);
233 __swab32s(&lsr->lsr_uid);
234 __swab32s(&lsr->lsr_uid_h);
235 __swab32s(&lsr->lsr_gid);
236 __swab32s(&lsr->lsr_gid_h);
237 tail = &lsr->lsr_tail;
241 /* these are swabbed as they are consumed */
245 struct llog_log_hdr *llh = (struct llog_log_hdr *)rec;
247 __swab64s(&llh->llh_timestamp);
248 __swab32s(&llh->llh_count);
249 __swab32s(&llh->llh_bitmap_offset);
250 __swab32s(&llh->llh_flags);
251 __swab32s(&llh->llh_size);
252 __swab32s(&llh->llh_cat_idx);
253 tail = &llh->llh_tail;
256 case LLOG_LOGID_MAGIC:
258 struct llog_logid_rec *lid = (struct llog_logid_rec *)rec;
260 lustre_swab_llog_id(&lid->lid_id);
261 tail = &lid->lid_tail;
266 struct llog_gen_rec *lgr = (struct llog_gen_rec *)rec;
268 __swab64s(&lgr->lgr_gen.mnt_cnt);
269 __swab64s(&lgr->lgr_gen.conn_cnt);
270 tail = &lgr->lgr_tail;
276 CERROR("Unknown llog rec type %#x swabbing rec %p\n",
281 __swab32s(&tail->lrt_len);
282 __swab32s(&tail->lrt_index);
285 EXPORT_SYMBOL(lustre_swab_llog_rec);
287 static void print_llog_hdr(struct llog_log_hdr *h)
289 CDEBUG(D_OTHER, "llog header: %p\n", h);
290 CDEBUG(D_OTHER, "\tllh_hdr.lrh_index: %#x\n", h->llh_hdr.lrh_index);
291 CDEBUG(D_OTHER, "\tllh_hdr.lrh_len: %#x\n", h->llh_hdr.lrh_len);
292 CDEBUG(D_OTHER, "\tllh_hdr.lrh_type: %#x\n", h->llh_hdr.lrh_type);
293 CDEBUG(D_OTHER, "\tllh_timestamp: "LPX64"\n", h->llh_timestamp);
294 CDEBUG(D_OTHER, "\tllh_count: %#x\n", h->llh_count);
295 CDEBUG(D_OTHER, "\tllh_bitmap_offset: %#x\n", h->llh_bitmap_offset);
296 CDEBUG(D_OTHER, "\tllh_flags: %#x\n", h->llh_flags);
297 CDEBUG(D_OTHER, "\tllh_size: %#x\n", h->llh_size);
298 CDEBUG(D_OTHER, "\tllh_cat_idx: %#x\n", h->llh_cat_idx);
299 CDEBUG(D_OTHER, "\tllh_tail.lrt_index: %#x\n", h->llh_tail.lrt_index);
300 CDEBUG(D_OTHER, "\tllh_tail.lrt_len: %#x\n", h->llh_tail.lrt_len);
303 void lustre_swab_llog_hdr (struct llog_log_hdr *h)
308 lustre_swab_llog_rec(&h->llh_hdr);
313 EXPORT_SYMBOL(lustre_swab_llog_hdr);
315 static void print_lustre_cfg(struct lustre_cfg *lcfg)
320 if (!(libcfs_debug & D_OTHER)) /* don't loop on nothing */
322 CDEBUG(D_OTHER, "lustre_cfg: %p\n", lcfg);
323 CDEBUG(D_OTHER, "\tlcfg->lcfg_version: %#x\n", lcfg->lcfg_version);
325 CDEBUG(D_OTHER, "\tlcfg->lcfg_command: %#x\n", lcfg->lcfg_command);
326 CDEBUG(D_OTHER, "\tlcfg->lcfg_num: %#x\n", lcfg->lcfg_num);
327 CDEBUG(D_OTHER, "\tlcfg->lcfg_flags: %#x\n", lcfg->lcfg_flags);
328 CDEBUG(D_OTHER, "\tlcfg->lcfg_nid: %s\n", libcfs_nid2str(lcfg->lcfg_nid));
330 CDEBUG(D_OTHER, "\tlcfg->lcfg_bufcount: %d\n", lcfg->lcfg_bufcount);
331 if (lcfg->lcfg_bufcount < LUSTRE_CFG_MAX_BUFCOUNT)
332 for (i = 0; i < lcfg->lcfg_bufcount; i++)
333 CDEBUG(D_OTHER, "\tlcfg->lcfg_buflens[%d]: %d\n",
334 i, lcfg->lcfg_buflens[i]);
338 void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg)
343 __swab32s(&lcfg->lcfg_version);
345 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION) {
346 CERROR("not swabbing lustre_cfg version %#x (expecting %#x)\n",
347 lcfg->lcfg_version, LUSTRE_CFG_VERSION);
352 __swab32s(&lcfg->lcfg_command);
353 __swab32s(&lcfg->lcfg_num);
354 __swab32s(&lcfg->lcfg_flags);
355 __swab64s(&lcfg->lcfg_nid);
356 __swab32s(&lcfg->lcfg_bufcount);
357 for (i = 0; i < lcfg->lcfg_bufcount && i < LUSTRE_CFG_MAX_BUFCOUNT; i++)
358 __swab32s(&lcfg->lcfg_buflens[i]);
360 print_lustre_cfg(lcfg);
364 EXPORT_SYMBOL(lustre_swab_lustre_cfg);
366 /* used only for compatibility with old on-disk cfg_marker data */
367 struct cfg_marker32 {
374 char cm_tgtname[MTI_NAME_MAXLEN];
375 char cm_comment[MTI_NAME_MAXLEN];
378 #define MTI_NAMELEN32 (MTI_NAME_MAXLEN - \
379 (sizeof(struct cfg_marker) - sizeof(struct cfg_marker32)))
381 void lustre_swab_cfg_marker(struct cfg_marker *marker, int swab, int size)
383 struct cfg_marker32 *cm32 = (struct cfg_marker32*)marker;
387 __swab32s(&marker->cm_step);
388 __swab32s(&marker->cm_flags);
389 __swab32s(&marker->cm_vers);
391 if (size == sizeof(*cm32)) {
392 __u32 createtime, canceltime;
393 /* There was a problem with the original declaration of
394 * cfg_marker on 32-bit systems because it used time_t as
395 * a wire protocol structure, and didn't verify this in
396 * wirecheck. We now have to convert the offsets of the
397 * later fields in order to work on 32- and 64-bit systems.
399 * Fortunately, the cm_comment field has no functional use
400 * so can be sacrificed when converting the timestamp size.
402 * Overwrite fields from the end first, so they are not
403 * clobbered, and use memmove() instead of memcpy() because
404 * the source and target buffers overlap. bug 16771 */
405 createtime = cm32->cm_createtime;
406 canceltime = cm32->cm_canceltime;
407 memmove(marker->cm_comment, cm32->cm_comment, MTI_NAMELEN32);
408 marker->cm_comment[MTI_NAMELEN32 - 1] = '\0';
409 memmove(marker->cm_tgtname, cm32->cm_tgtname,
410 sizeof(marker->cm_tgtname));
412 __swab32s(&createtime);
413 __swab32s(&canceltime);
415 marker->cm_createtime = createtime;
416 marker->cm_canceltime = canceltime;
417 CDEBUG(D_CONFIG, "Find old cfg_marker(Srv32b,Clt64b) "
418 "for target %s, converting\n",
421 __swab64s(&marker->cm_createtime);
422 __swab64s(&marker->cm_canceltime);
428 EXPORT_SYMBOL(lustre_swab_cfg_marker);