Whamcloud - gitweb
LU-15406 sec: fix in-kernel fscrypt support
[fs/lustre-release.git] / lustre / obdclass / llog_swab.c
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, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * lustre/obdclass/llog_swab.c
32  *
33  * Swabbing of llog datatypes (from disk or over the wire).
34  *
35  * Author: jacob berkman  <jacob@clusterfs.com>
36  */
37
38 #define DEBUG_SUBSYSTEM S_LOG
39
40
41 #include <lustre_log.h>
42 #include <lustre_update.h>
43
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.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);
56 }
57
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
66 void lustre_swab_ost_id(struct ost_id *oid)
67 {
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);
72         } else {
73                 lustre_swab_lu_fid(&oid->oi_fid);
74         }
75 }
76 EXPORT_SYMBOL(lustre_swab_ost_id);
77
78 void lustre_swab_llog_id(struct llog_logid *log_id)
79 {
80         __swab64s(&log_id->lgl_oi.oi.oi_id);
81         __swab64s(&log_id->lgl_oi.oi.oi_seq);
82         __swab32s(&log_id->lgl_ogen);
83 }
84
85 void lustre_swab_llogd_body (struct llogd_body *d)
86 {
87         ENTRY;
88         print_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);
96         print_llogd_body(d);
97         EXIT;
98 }
99 EXPORT_SYMBOL(lustre_swab_llogd_body);
100
101 void lustre_swab_llogd_conn_body (struct llogd_conn_body *d)
102 {
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);
107 }
108 EXPORT_SYMBOL(lustre_swab_llogd_conn_body);
109
110 void lustre_swab_ll_fid(struct ll_fid *fid)
111 {
112         __swab64s(&fid->id);
113         __swab32s(&fid->generation);
114         __swab32s(&fid->f_type);
115 }
116
117 void lustre_swab_lu_seq_range(struct lu_seq_range *range)
118 {
119         __swab64s(&range->lsr_start);
120         __swab64s(&range->lsr_end);
121         __swab32s(&range->lsr_index);
122         __swab32s(&range->lsr_flags);
123 }
124 EXPORT_SYMBOL(lustre_swab_lu_seq_range);
125
126 void lustre_swab_update_ops(struct update_ops *uops, unsigned int op_count)
127 {
128         unsigned int i;
129         unsigned int j;
130
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]);
137         }
138 }
139 EXPORT_SYMBOL(lustre_swab_update_ops);
140
141 void lustre_swab_llog_rec(struct llog_rec_hdr *rec)
142 {
143         struct llog_rec_tail *tail = NULL;
144
145         __swab32s(&rec->lrh_len);
146         __swab32s(&rec->lrh_index);
147         __swab32s(&rec->lrh_type);
148         __swab32s(&rec->lrh_id);
149
150         switch (rec->lrh_type) {
151         case OST_SZ_REC:
152         {
153                 struct llog_size_change_rec *lsc =
154                         (struct llog_size_change_rec *)rec;
155
156                 lustre_swab_ll_fid(&lsc->lsc_fid);
157                 __swab32s(&lsc->lsc_ioepoch);
158                 tail = &lsc->lsc_tail;
159                 break;
160         }
161         case MDS_UNLINK_REC:
162         {
163                 struct llog_unlink_rec *lur = (struct llog_unlink_rec *)rec;
164
165                 __swab64s(&lur->lur_oid);
166                 __swab32s(&lur->lur_oseq);
167                 __swab32s(&lur->lur_count);
168                 tail = &lur->lur_tail;
169                 break;
170         }
171         case MDS_UNLINK64_REC:
172         {
173                 struct llog_unlink64_rec *lur =
174                         (struct llog_unlink64_rec *)rec;
175
176                 lustre_swab_lu_fid(&lur->lur_fid);
177                 __swab32s(&lur->lur_count);
178                 tail = &lur->lur_tail;
179                 break;
180         }
181         case CHANGELOG_REC:
182         {
183                 struct llog_changelog_rec *cr =
184                         (struct llog_changelog_rec *)rec;
185
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);
197
198                         lustre_swab_lu_fid(&rnm->cr_sfid);
199                         lustre_swab_lu_fid(&rnm->cr_spfid);
200                 }
201                 /*
202                  * Because the tail follows a variable-length structure we need
203                  * to compute its location at runtime
204                  */
205                 tail = (struct llog_rec_tail *)((char *)rec +
206                                                 rec->lrh_len - sizeof(*tail));
207                 break;
208         }
209
210         case CHANGELOG_USER_REC:
211         case CHANGELOG_USER_REC2:
212         {
213                 struct llog_changelog_user_rec2 *cur =
214                         (struct llog_changelog_user_rec2 *)rec;
215
216                 __swab32s(&cur->cur_id);
217                 __swab64s(&cur->cur_endrec);
218                 __swab32s(&cur->cur_time);
219                 if (cur->cur_hdr.lrh_type == CHANGELOG_USER_REC2) {
220                         __swab32s(&cur->cur_mask);
221                         BUILD_BUG_ON(offsetof(typeof(*cur), cur_padding1) == 0);
222                         BUILD_BUG_ON(offsetof(typeof(*cur), cur_padding2) == 0);
223                         BUILD_BUG_ON(offsetof(typeof(*cur), cur_padding3) == 0);
224                 }
225                 tail = (struct llog_rec_tail *)((char *)rec +
226                                                 rec->lrh_len - sizeof(*tail));
227                 break;
228         }
229
230         case HSM_AGENT_REC: {
231                 struct llog_agent_req_rec *arr =
232                         (struct llog_agent_req_rec *)rec;
233
234                 __swab32s(&arr->arr_hai.hai_len);
235                 __swab32s(&arr->arr_hai.hai_action);
236                 lustre_swab_lu_fid(&arr->arr_hai.hai_fid);
237                 lustre_swab_lu_fid(&arr->arr_hai.hai_dfid);
238                 __swab64s(&arr->arr_hai.hai_cookie);
239                 __swab64s(&arr->arr_hai.hai_extent.offset);
240                 __swab64s(&arr->arr_hai.hai_extent.length);
241                 __swab64s(&arr->arr_hai.hai_gid);
242                 /*
243                  * no swabing for opaque data
244                  * hai_data[0];
245                  */
246                 break;
247         }
248
249         case MDS_SETATTR64_REC:
250         {
251                 struct llog_setattr64_rec *lsr =
252                         (struct llog_setattr64_rec *)rec;
253
254                 lustre_swab_ost_id(&lsr->lsr_oi);
255                 __swab32s(&lsr->lsr_uid);
256                 __swab32s(&lsr->lsr_uid_h);
257                 __swab32s(&lsr->lsr_gid);
258                 __swab32s(&lsr->lsr_gid_h);
259                 __swab64s(&lsr->lsr_valid);
260
261                 if (rec->lrh_len > sizeof(struct llog_setattr64_rec)) {
262                         struct llog_setattr64_rec_v2 *lsr2 =
263                                 (struct llog_setattr64_rec_v2 *)rec;
264
265                         __swab32s(&lsr2->lsr_projid);
266                         __swab32s(&lsr2->lsr_layout_version);
267                         tail = &lsr2->lsr_tail;
268                 } else {
269                         tail = &lsr->lsr_tail;
270                 }
271                 break;
272         }
273         case OBD_CFG_REC:
274                 /* these are swabbed as they are consumed */
275                 break;
276         case LLOG_HDR_MAGIC:
277         {
278                 struct llog_log_hdr *llh = (struct llog_log_hdr *)rec;
279
280                 __swab64s(&llh->llh_timestamp);
281                 __swab32s(&llh->llh_count);
282                 __swab32s(&llh->llh_bitmap_offset);
283                 __swab32s(&llh->llh_flags);
284                 __swab32s(&llh->llh_size);
285                 __swab32s(&llh->llh_cat_idx);
286                 tail = LLOG_HDR_TAIL(llh);
287                 break;
288         }
289         case LLOG_LOGID_MAGIC:
290         {
291                 struct llog_logid_rec *lid = (struct llog_logid_rec *)rec;
292
293                 lustre_swab_llog_id(&lid->lid_id);
294                 tail = &lid->lid_tail;
295                 break;
296         }
297         case LLOG_GEN_REC:
298         {
299                 struct llog_gen_rec *lgr = (struct llog_gen_rec *)rec;
300
301                 __swab64s(&lgr->lgr_gen.mnt_cnt);
302                 __swab64s(&lgr->lgr_gen.conn_cnt);
303                 tail = &lgr->lgr_tail;
304                 break;
305         }
306         case LLOG_PAD_MAGIC:
307                 break;
308         case UPDATE_REC:
309         {
310                 struct llog_update_record *lur =
311                                 (struct llog_update_record *)rec;
312                 struct update_records *record = &lur->lur_update_rec;
313
314                 __swab32s(&record->ur_flags);
315                 __swab64s(&record->ur_batchid);
316                 __swab64s(&record->ur_master_transno);
317                 __swab32s(&record->ur_param_count);
318                 __swab32s(&record->ur_update_count);
319                 lustre_swab_update_ops(&record->ur_ops,
320                                        record->ur_update_count);
321
322                 /* Compute tail location. */
323                 tail = (struct llog_rec_tail *)((char *)record +
324                                                 update_records_size(record));
325                 break;
326         }
327         default:
328                 CERROR("Unknown llog rec type %#x swabbing rec %p\n",
329                         rec->lrh_type, rec);
330         }
331
332         if (tail) {
333                 __swab32s(&tail->lrt_len);
334                 __swab32s(&tail->lrt_index);
335         }
336 }
337
338 static void print_llog_hdr(struct llog_log_hdr *h)
339 {
340         CDEBUG(D_OTHER, "llog header: %p\n", h);
341         CDEBUG(D_OTHER, "\tllh_hdr.lrh_index: %#x\n", h->llh_hdr.lrh_index);
342         CDEBUG(D_OTHER, "\tllh_hdr.lrh_len: %#x\n", h->llh_hdr.lrh_len);
343         CDEBUG(D_OTHER, "\tllh_hdr.lrh_type: %#x\n", h->llh_hdr.lrh_type);
344         CDEBUG(D_OTHER, "\tllh_timestamp: %#llx\n", h->llh_timestamp);
345         CDEBUG(D_OTHER, "\tllh_count: %#x\n", h->llh_count);
346         CDEBUG(D_OTHER, "\tllh_bitmap_offset: %#x\n", h->llh_bitmap_offset);
347         CDEBUG(D_OTHER, "\tllh_flags: %#x\n", h->llh_flags);
348         CDEBUG(D_OTHER, "\tllh_size: %#x\n", h->llh_size);
349         CDEBUG(D_OTHER, "\tllh_cat_idx: %#x\n", h->llh_cat_idx);
350         CDEBUG(D_OTHER, "\tllh_tail.lrt_index: %#x\n",
351                LLOG_HDR_TAIL(h)->lrt_index);
352         CDEBUG(D_OTHER, "\tllh_tail.lrt_len: %#x\n",
353                LLOG_HDR_TAIL(h)->lrt_len);
354 }
355
356 void lustre_swab_llog_hdr (struct llog_log_hdr *h)
357 {
358         ENTRY;
359         print_llog_hdr(h);
360
361         lustre_swab_llog_rec(&h->llh_hdr);
362
363         print_llog_hdr(h);
364         EXIT;
365 }
366 EXPORT_SYMBOL(lustre_swab_llog_hdr);
367
368 void print_lustre_cfg(struct lustre_cfg *lcfg)
369 {
370         int i;
371
372         ENTRY;
373
374         if (!(libcfs_debug & D_OTHER)) /* don't loop on nothing */
375                 return;
376
377         CDEBUG(D_OTHER, "lustre_cfg: %p\n", lcfg);
378         CDEBUG(D_OTHER, "\tlcfg->lcfg_version: %#x\n", lcfg->lcfg_version);
379
380         CDEBUG(D_OTHER, "\tlcfg->lcfg_command: %#x\n", lcfg->lcfg_command);
381         CDEBUG(D_OTHER, "\tlcfg->lcfg_num: %#x\n", lcfg->lcfg_num);
382         CDEBUG(D_OTHER, "\tlcfg->lcfg_flags: %#x\n", lcfg->lcfg_flags);
383         CDEBUG(D_OTHER, "\tlcfg->lcfg_nid: %s\n",
384                libcfs_nid2str(lcfg->lcfg_nid));
385
386         CDEBUG(D_OTHER, "\tlcfg->lcfg_bufcount: %d\n", lcfg->lcfg_bufcount);
387         if (lcfg->lcfg_bufcount < LUSTRE_CFG_MAX_BUFCOUNT)
388                 for (i = 0; i < lcfg->lcfg_bufcount; i++) {
389                         CDEBUG(D_OTHER, "\tlcfg->lcfg_buflens[%d]: %d %s\n",
390                                i, lcfg->lcfg_buflens[i],
391                                lustre_cfg_string(lcfg, i));
392                 }
393
394         EXIT;
395 }
396 EXPORT_SYMBOL(print_lustre_cfg);
397
398 void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg)
399 {
400         int i;
401
402         ENTRY;
403
404         __swab32s(&lcfg->lcfg_version);
405
406         if (lcfg->lcfg_version != LUSTRE_CFG_VERSION) {
407                 CERROR("not swabbing lustre_cfg version %#x (expecting %#x)\n",
408                         lcfg->lcfg_version, LUSTRE_CFG_VERSION);
409                 EXIT;
410                 return;
411         }
412
413         __swab32s(&lcfg->lcfg_command);
414         __swab32s(&lcfg->lcfg_num);
415         __swab32s(&lcfg->lcfg_flags);
416         __swab64s(&lcfg->lcfg_nid);
417         __swab32s(&lcfg->lcfg_bufcount);
418         for (i = 0; i < lcfg->lcfg_bufcount && i < LUSTRE_CFG_MAX_BUFCOUNT; i++)
419                 __swab32s(&lcfg->lcfg_buflens[i]);
420
421         print_lustre_cfg(lcfg);
422         EXIT;
423 }
424
425 /* used only for compatibility with old on-disk cfg_marker data */
426 struct cfg_marker32 {
427         __u32   cm_step;
428         __u32   cm_flags;
429         __u32   cm_vers;
430         __u32   padding;
431         __u32   cm_createtime;
432         __u32   cm_canceltime;
433         char    cm_tgtname[MTI_NAME_MAXLEN];
434         char    cm_comment[MTI_NAME_MAXLEN];
435 };
436
437 #define MTI_NAMELEN32    (MTI_NAME_MAXLEN - \
438         (sizeof(struct cfg_marker) - sizeof(struct cfg_marker32)))
439
440 void lustre_swab_cfg_marker(struct cfg_marker *marker, int swab, int size)
441 {
442         struct cfg_marker32 *cm32 = (struct cfg_marker32 *)marker;
443
444         ENTRY;
445
446         if (swab) {
447                 __swab32s(&marker->cm_step);
448                 __swab32s(&marker->cm_flags);
449                 __swab32s(&marker->cm_vers);
450         }
451         if (size == sizeof(*cm32)) {
452                 __u32 createtime, canceltime;
453                 /*
454                  * There was a problem with the original declaration of
455                  * cfg_marker on 32-bit systems because it used 32 time as
456                  * a wire protocol structure, and didn't verify this in
457                  * wirecheck.  We now have to convert the offsets of the
458                  * later fields in order to work on 32- and 64-bit systems.
459                  *
460                  * Fortunately, the cm_comment field has no functional use
461                  * so can be sacrificed when converting the timestamp size.
462                  *
463                  * Overwrite fields from the end first, so they are not
464                  * clobbered, and use memmove() instead of memcpy() because
465                  * the source and target buffers overlap.  bug 16771
466                  */
467                 createtime = cm32->cm_createtime;
468                 canceltime = cm32->cm_canceltime;
469                 memmove(marker->cm_comment, cm32->cm_comment, MTI_NAMELEN32);
470                 marker->cm_comment[MTI_NAMELEN32 - 1] = '\0';
471                 memmove(marker->cm_tgtname, cm32->cm_tgtname,
472                         sizeof(marker->cm_tgtname));
473                 if (swab) {
474                         __swab32s(&createtime);
475                         __swab32s(&canceltime);
476                 }
477                 marker->cm_createtime = createtime;
478                 marker->cm_canceltime = canceltime;
479                 CDEBUG(D_CONFIG,
480                        "Find old cfg_marker(Srv32b,Clt64b) for target %s, converting\n",
481                        marker->cm_tgtname);
482         } else if (swab) {
483                 __swab64s(&marker->cm_createtime);
484                 __swab64s(&marker->cm_canceltime);
485         }
486
487         EXIT;
488 }