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