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 <llog_swab.h>
42 #include <lustre_log.h>
43
print_llogd_body(struct llogd_body * d)44 static void print_llogd_body(struct llogd_body *d)
45 {
46 CDEBUG(D_OTHER, "llogd body: %p\n", d);
47 CDEBUG(D_OTHER, "\tlgd_logid.lgl_oi: " DOSTID "\n",
48 POSTID(&d->lgd_logid.lgl_oi));
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);
56 }
57
lustre_swab_lu_fid(struct lu_fid * fid)58 void lustre_swab_lu_fid(struct lu_fid *fid)
59 {
60 __swab64s(&fid->f_seq);
61 __swab32s(&fid->f_oid);
62 __swab32s(&fid->f_ver);
63 }
64 EXPORT_SYMBOL(lustre_swab_lu_fid);
65
lustre_swab_ost_id(struct ost_id * oid)66 void lustre_swab_ost_id(struct ost_id *oid)
67 {
68 if (fid_seq_is_mdt0(oid->oi.oi_seq)) {
69 __swab64s(&oid->oi.oi_id);
70 __swab64s(&oid->oi.oi_seq);
71 } else {
72 lustre_swab_lu_fid(&oid->oi_fid);
73 }
74 }
75 EXPORT_SYMBOL(lustre_swab_ost_id);
76
lustre_swab_llog_id(struct llog_logid * log_id)77 static void lustre_swab_llog_id(struct llog_logid *log_id)
78 {
79 __swab64s(&log_id->lgl_oi.oi.oi_id);
80 __swab64s(&log_id->lgl_oi.oi.oi_seq);
81 __swab32s(&log_id->lgl_ogen);
82 }
83
lustre_swab_llogd_body(struct llogd_body * d)84 void lustre_swab_llogd_body(struct llogd_body *d)
85 {
86 print_llogd_body(d);
87 lustre_swab_llog_id(&d->lgd_logid);
88 __swab32s(&d->lgd_ctxt_idx);
89 __swab32s(&d->lgd_llh_flags);
90 __swab32s(&d->lgd_index);
91 __swab32s(&d->lgd_saved_index);
92 __swab32s(&d->lgd_len);
93 __swab64s(&d->lgd_cur_offset);
94 print_llogd_body(d);
95 }
96 EXPORT_SYMBOL(lustre_swab_llogd_body);
97
lustre_swab_llogd_conn_body(struct llogd_conn_body * d)98 void lustre_swab_llogd_conn_body(struct llogd_conn_body *d)
99 {
100 __swab64s(&d->lgdc_gen.mnt_cnt);
101 __swab64s(&d->lgdc_gen.conn_cnt);
102 lustre_swab_llog_id(&d->lgdc_logid);
103 __swab32s(&d->lgdc_ctxt_idx);
104 }
105 EXPORT_SYMBOL(lustre_swab_llogd_conn_body);
106
lustre_swab_ll_fid(struct ll_fid * fid)107 static void lustre_swab_ll_fid(struct ll_fid *fid)
108 {
109 __swab64s(&fid->id);
110 __swab32s(&fid->generation);
111 __swab32s(&fid->f_type);
112 }
113
lustre_swab_lu_seq_range(struct lu_seq_range * range)114 void lustre_swab_lu_seq_range(struct lu_seq_range *range)
115 {
116 __swab64s(&range->lsr_start);
117 __swab64s(&range->lsr_end);
118 __swab32s(&range->lsr_index);
119 __swab32s(&range->lsr_flags);
120 }
121 EXPORT_SYMBOL(lustre_swab_lu_seq_range);
122
lustre_swab_llog_rec(struct llog_rec_hdr * rec)123 void lustre_swab_llog_rec(struct llog_rec_hdr *rec)
124 {
125 struct llog_rec_tail *tail = NULL;
126
127 __swab32s(&rec->lrh_len);
128 __swab32s(&rec->lrh_index);
129 __swab32s(&rec->lrh_type);
130 __swab32s(&rec->lrh_id);
131
132 switch (rec->lrh_type) {
133 case OST_SZ_REC:
134 {
135 struct llog_size_change_rec *lsc =
136 (struct llog_size_change_rec *)rec;
137
138 lustre_swab_ll_fid(&lsc->lsc_fid);
139 __swab32s(&lsc->lsc_ioepoch);
140 tail = &lsc->lsc_tail;
141 break;
142 }
143 case MDS_UNLINK_REC:
144 {
145 struct llog_unlink_rec *lur = (struct llog_unlink_rec *)rec;
146
147 __swab64s(&lur->lur_oid);
148 __swab32s(&lur->lur_oseq);
149 __swab32s(&lur->lur_count);
150 tail = &lur->lur_tail;
151 break;
152 }
153 case MDS_UNLINK64_REC:
154 {
155 struct llog_unlink64_rec *lur =
156 (struct llog_unlink64_rec *)rec;
157
158 lustre_swab_lu_fid(&lur->lur_fid);
159 __swab32s(&lur->lur_count);
160 tail = &lur->lur_tail;
161 break;
162 }
163 case CHANGELOG_REC:
164 {
165 struct llog_changelog_rec *cr =
166 (struct llog_changelog_rec *)rec;
167
168 __swab16s(&cr->cr.cr_namelen);
169 __swab16s(&cr->cr.cr_flags);
170 __swab32s(&cr->cr.cr_type);
171 __swab64s(&cr->cr.cr_index);
172 __swab64s(&cr->cr.cr_prev);
173 __swab64s(&cr->cr.cr_time);
174 lustre_swab_lu_fid(&cr->cr.cr_tfid);
175 lustre_swab_lu_fid(&cr->cr.cr_pfid);
176 if (cr->cr.cr_flags & CLF_RENAME) {
177 struct changelog_ext_rename *rnm =
178 changelog_rec_rename(&cr->cr);
179
180 lustre_swab_lu_fid(&rnm->cr_sfid);
181 lustre_swab_lu_fid(&rnm->cr_spfid);
182 }
183 /*
184 * Because the tail follows a variable-length structure we need
185 * to compute its location at runtime
186 */
187 tail = (struct llog_rec_tail *)((char *)&cr->cr +
188 changelog_rec_size(&cr->cr) +
189 cr->cr.cr_namelen);
190 break;
191 }
192
193 case CHANGELOG_USER_REC:
194 {
195 struct llog_changelog_user_rec *cur =
196 (struct llog_changelog_user_rec *)rec;
197
198 __swab32s(&cur->cur_id);
199 __swab64s(&cur->cur_endrec);
200 tail = &cur->cur_tail;
201 break;
202 }
203
204 case HSM_AGENT_REC: {
205 struct llog_agent_req_rec *arr =
206 (struct llog_agent_req_rec *)rec;
207
208 __swab32s(&arr->arr_hai.hai_len);
209 __swab32s(&arr->arr_hai.hai_action);
210 lustre_swab_lu_fid(&arr->arr_hai.hai_fid);
211 lustre_swab_lu_fid(&arr->arr_hai.hai_dfid);
212 __swab64s(&arr->arr_hai.hai_cookie);
213 __swab64s(&arr->arr_hai.hai_extent.offset);
214 __swab64s(&arr->arr_hai.hai_extent.length);
215 __swab64s(&arr->arr_hai.hai_gid);
216 /* no swabing for opaque data */
217 /* hai_data[0]; */
218 break;
219 }
220
221 case MDS_SETATTR64_REC:
222 {
223 struct llog_setattr64_rec *lsr =
224 (struct llog_setattr64_rec *)rec;
225
226 lustre_swab_ost_id(&lsr->lsr_oi);
227 __swab32s(&lsr->lsr_uid);
228 __swab32s(&lsr->lsr_uid_h);
229 __swab32s(&lsr->lsr_gid);
230 __swab32s(&lsr->lsr_gid_h);
231 __swab64s(&lsr->lsr_valid);
232 tail = &lsr->lsr_tail;
233 break;
234 }
235 case OBD_CFG_REC:
236 /* these are swabbed as they are consumed */
237 break;
238 case LLOG_HDR_MAGIC:
239 {
240 struct llog_log_hdr *llh = (struct llog_log_hdr *)rec;
241
242 __swab64s(&llh->llh_timestamp);
243 __swab32s(&llh->llh_count);
244 __swab32s(&llh->llh_bitmap_offset);
245 __swab32s(&llh->llh_flags);
246 __swab32s(&llh->llh_size);
247 __swab32s(&llh->llh_cat_idx);
248 tail = LLOG_HDR_TAIL(llh);
249 break;
250 }
251 case LLOG_LOGID_MAGIC:
252 {
253 struct llog_logid_rec *lid = (struct llog_logid_rec *)rec;
254
255 lustre_swab_llog_id(&lid->lid_id);
256 tail = &lid->lid_tail;
257 break;
258 }
259 case LLOG_GEN_REC:
260 {
261 struct llog_gen_rec *lgr = (struct llog_gen_rec *)rec;
262
263 __swab64s(&lgr->lgr_gen.mnt_cnt);
264 __swab64s(&lgr->lgr_gen.conn_cnt);
265 tail = &lgr->lgr_tail;
266 break;
267 }
268 case LLOG_PAD_MAGIC:
269 break;
270 default:
271 CERROR("Unknown llog rec type %#x swabbing rec %p\n",
272 rec->lrh_type, rec);
273 }
274
275 if (tail) {
276 __swab32s(&tail->lrt_len);
277 __swab32s(&tail->lrt_index);
278 }
279 }
280 EXPORT_SYMBOL(lustre_swab_llog_rec);
281
print_llog_hdr(struct llog_log_hdr * h)282 static void print_llog_hdr(struct llog_log_hdr *h)
283 {
284 CDEBUG(D_OTHER, "llog header: %p\n", h);
285 CDEBUG(D_OTHER, "\tllh_hdr.lrh_index: %#x\n", h->llh_hdr.lrh_index);
286 CDEBUG(D_OTHER, "\tllh_hdr.lrh_len: %#x\n", h->llh_hdr.lrh_len);
287 CDEBUG(D_OTHER, "\tllh_hdr.lrh_type: %#x\n", h->llh_hdr.lrh_type);
288 CDEBUG(D_OTHER, "\tllh_timestamp: %#llx\n", h->llh_timestamp);
289 CDEBUG(D_OTHER, "\tllh_count: %#x\n", h->llh_count);
290 CDEBUG(D_OTHER, "\tllh_bitmap_offset: %#x\n", h->llh_bitmap_offset);
291 CDEBUG(D_OTHER, "\tllh_flags: %#x\n", h->llh_flags);
292 CDEBUG(D_OTHER, "\tllh_size: %#x\n", h->llh_size);
293 CDEBUG(D_OTHER, "\tllh_cat_idx: %#x\n", h->llh_cat_idx);
294 CDEBUG(D_OTHER, "\tllh_tail.lrt_index: %#x\n",
295 LLOG_HDR_TAIL(h)->lrt_index);
296 CDEBUG(D_OTHER, "\tllh_tail.lrt_len: %#x\n",
297 LLOG_HDR_TAIL(h)->lrt_len);
298 }
299
lustre_swab_llog_hdr(struct llog_log_hdr * h)300 void lustre_swab_llog_hdr(struct llog_log_hdr *h)
301 {
302 print_llog_hdr(h);
303
304 lustre_swab_llog_rec(&h->llh_hdr);
305
306 print_llog_hdr(h);
307 }
308 EXPORT_SYMBOL(lustre_swab_llog_hdr);
309
print_lustre_cfg(struct lustre_cfg * lcfg)310 static void print_lustre_cfg(struct lustre_cfg *lcfg)
311 {
312 int i;
313
314 if (!(libcfs_debug & D_OTHER)) /* don't loop on nothing */
315 return;
316 CDEBUG(D_OTHER, "lustre_cfg: %p\n", lcfg);
317 CDEBUG(D_OTHER, "\tlcfg->lcfg_version: %#x\n", lcfg->lcfg_version);
318
319 CDEBUG(D_OTHER, "\tlcfg->lcfg_command: %#x\n", lcfg->lcfg_command);
320 CDEBUG(D_OTHER, "\tlcfg->lcfg_num: %#x\n", lcfg->lcfg_num);
321 CDEBUG(D_OTHER, "\tlcfg->lcfg_flags: %#x\n", lcfg->lcfg_flags);
322 CDEBUG(D_OTHER, "\tlcfg->lcfg_nid: %s\n", libcfs_nid2str(lcfg->lcfg_nid));
323
324 CDEBUG(D_OTHER, "\tlcfg->lcfg_bufcount: %d\n", lcfg->lcfg_bufcount);
325 if (lcfg->lcfg_bufcount < LUSTRE_CFG_MAX_BUFCOUNT)
326 for (i = 0; i < lcfg->lcfg_bufcount; i++)
327 CDEBUG(D_OTHER, "\tlcfg->lcfg_buflens[%d]: %d\n",
328 i, lcfg->lcfg_buflens[i]);
329 }
330
lustre_swab_lustre_cfg(struct lustre_cfg * lcfg)331 void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg)
332 {
333 int i;
334
335 __swab32s(&lcfg->lcfg_version);
336
337 if (lcfg->lcfg_version != LUSTRE_CFG_VERSION) {
338 CERROR("not swabbing lustre_cfg version %#x (expecting %#x)\n",
339 lcfg->lcfg_version, LUSTRE_CFG_VERSION);
340 return;
341 }
342
343 __swab32s(&lcfg->lcfg_command);
344 __swab32s(&lcfg->lcfg_num);
345 __swab32s(&lcfg->lcfg_flags);
346 __swab64s(&lcfg->lcfg_nid);
347 __swab32s(&lcfg->lcfg_bufcount);
348 for (i = 0; i < lcfg->lcfg_bufcount && i < LUSTRE_CFG_MAX_BUFCOUNT; i++)
349 __swab32s(&lcfg->lcfg_buflens[i]);
350
351 print_lustre_cfg(lcfg);
352 }
353
354 /* used only for compatibility with old on-disk cfg_marker data */
355 struct cfg_marker32 {
356 __u32 cm_step;
357 __u32 cm_flags;
358 __u32 cm_vers;
359 __u32 padding;
360 __u32 cm_createtime;
361 __u32 cm_canceltime;
362 char cm_tgtname[MTI_NAME_MAXLEN];
363 char cm_comment[MTI_NAME_MAXLEN];
364 };
365
366 #define MTI_NAMELEN32 (MTI_NAME_MAXLEN - \
367 (sizeof(struct cfg_marker) - sizeof(struct cfg_marker32)))
368
lustre_swab_cfg_marker(struct cfg_marker * marker,int swab,int size)369 void lustre_swab_cfg_marker(struct cfg_marker *marker, int swab, int size)
370 {
371 struct cfg_marker32 *cm32 = (struct cfg_marker32 *)marker;
372
373 if (swab) {
374 __swab32s(&marker->cm_step);
375 __swab32s(&marker->cm_flags);
376 __swab32s(&marker->cm_vers);
377 }
378 if (size == sizeof(*cm32)) {
379 __u32 createtime, canceltime;
380 /* There was a problem with the original declaration of
381 * cfg_marker on 32-bit systems because it used time_t as
382 * a wire protocol structure, and didn't verify this in
383 * wirecheck. We now have to convert the offsets of the
384 * later fields in order to work on 32- and 64-bit systems.
385 *
386 * Fortunately, the cm_comment field has no functional use
387 * so can be sacrificed when converting the timestamp size.
388 *
389 * Overwrite fields from the end first, so they are not
390 * clobbered, and use memmove() instead of memcpy() because
391 * the source and target buffers overlap. bug 16771
392 */
393 createtime = cm32->cm_createtime;
394 canceltime = cm32->cm_canceltime;
395 memmove(marker->cm_comment, cm32->cm_comment, MTI_NAMELEN32);
396 marker->cm_comment[MTI_NAMELEN32 - 1] = '\0';
397 memmove(marker->cm_tgtname, cm32->cm_tgtname,
398 sizeof(marker->cm_tgtname));
399 if (swab) {
400 __swab32s(&createtime);
401 __swab32s(&canceltime);
402 }
403 marker->cm_createtime = createtime;
404 marker->cm_canceltime = canceltime;
405 CDEBUG(D_CONFIG, "Find old cfg_marker(Srv32b,Clt64b) for target %s, converting\n",
406 marker->cm_tgtname);
407 } else if (swab) {
408 __swab64s(&marker->cm_createtime);
409 __swab64s(&marker->cm_canceltime);
410 }
411 }
412