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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 #define DEBUG_SUBSYSTEM S_LOG
34 #include <obd_class.h>
35 #include <uapi/linux/lustre/lustre_ioctl.h>
36 #include <lustre_log.h>
37 #include "llog_internal.h"
39 static int str2logid(struct llog_logid *logid, char *str, int len)
41 unsigned long long id, seq;
48 if (start[0] == '[') {
49 struct lu_fid *fid = &logid->lgl_oi.oi_fid;
55 num = sscanf(start + 1, SFID, RFID(fid));
56 CDEBUG(D_INFO, DFID":%x\n", PFID(fid), logid->lgl_ogen);
57 logid_to_fid(logid, &sfid);
58 RETURN(num == 3 && fid_is_sane(&sfid) ? 0 : -EINVAL);
61 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 1, 53, 0)
63 * logids used to be input in the form "#id#seq:ogen" before they
64 * were changed over to accept the FID [seq:oid:ver] format.
65 * This is accepted for compatibility reasons, though I doubt
66 * anyone is actually using this for anything.
72 if (start - str >= len - 1)
74 end = strchr(start, '#');
75 if (end == NULL || end == start)
79 rc = kstrtoull(start, 0, &id);
84 if (start - str >= len - 1)
87 end = strchr(start, '#');
88 if (!end || end == start)
92 rc = kstrtoull(start, 0, &seq);
96 ostid_set_seq(&logid->lgl_oi, seq);
97 if (ostid_set_id(&logid->lgl_oi, id))
101 if (start - str >= len - 1)
104 rc = kstrtouint(start, 16, &ogen);
107 logid->lgl_ogen = ogen;
115 static int llog_check_cb(const struct lu_env *env, struct llog_handle *handle,
116 struct llog_rec_hdr *rec, void *data)
118 struct obd_ioctl_data *ioc_data = data;
119 static int l, remains;
120 static long from, to;
126 if (ioc_data && ioc_data->ioc_inllen1 > 0) {
128 remains = ioc_data->ioc_inllen4 +
129 round_up(ioc_data->ioc_inllen1, 8) +
130 round_up(ioc_data->ioc_inllen2, 8) +
131 round_up(ioc_data->ioc_inllen3, 8);
133 rc = kstrtol(ioc_data->ioc_inlbuf2, 0, &from);
137 rc = kstrtol(ioc_data->ioc_inlbuf3, 0, &to);
141 ioc_data->ioc_inllen1 = 0;
142 out = ioc_data->ioc_bulk;
145 cur_index = rec->lrh_index;
146 if (cur_index < from)
148 if (to > 0 && cur_index > to)
149 RETURN(-LLOG_EEMPTY);
151 if (handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT) {
152 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
153 struct llog_handle *loghandle;
155 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
156 l = snprintf(out, remains,
157 "[index]: %05d [type]: %02x [len]: %04d failed\n",
158 cur_index, rec->lrh_type,
161 if (handle->lgh_ctxt == NULL)
163 rc = llog_cat_id2handle(env, handle, &loghandle, &lir->lid_id);
165 CDEBUG(D_IOCTL, "cannot find log "DFID":%x\n",
166 PFID(&lir->lid_id.lgl_oi.oi_fid),
167 lir->lid_id.lgl_ogen);
170 rc = llog_process(env, loghandle, llog_check_cb, NULL, NULL);
171 llog_handle_put(env, loghandle);
175 switch (rec->lrh_type) {
178 case MDS_UNLINK64_REC:
179 case MDS_SETATTR64_REC:
189 l = snprintf(out, remains, "[index]: %05d [type]: "
190 "%02x [len]: %04d %s\n",
191 cur_index, rec->lrh_type, rec->lrh_len,
192 ok ? "ok" : "failed");
196 CERROR("%s: no space to print log records\n",
197 handle->lgh_ctxt->loc_obd->obd_name);
198 RETURN(-LLOG_EEMPTY);
204 static int llog_print_cb(const struct lu_env *env, struct llog_handle *handle,
205 struct llog_rec_hdr *rec, void *data)
207 struct obd_ioctl_data *ioc_data = data;
208 static int l, remains;
209 static long from, to;
215 if (ioc_data && ioc_data->ioc_inllen1 > 0) {
217 remains = ioc_data->ioc_inllen4 +
218 round_up(ioc_data->ioc_inllen1, 8) +
219 round_up(ioc_data->ioc_inllen2, 8) +
220 round_up(ioc_data->ioc_inllen3, 8);
222 rc = kstrtol(ioc_data->ioc_inlbuf2, 0, &from);
226 rc = kstrtol(ioc_data->ioc_inlbuf3, 0, &to);
230 out = ioc_data->ioc_bulk;
231 ioc_data->ioc_inllen1 = 0;
234 cur_index = rec->lrh_index;
235 if (cur_index < from)
237 if (to > 0 && cur_index > to)
238 RETURN(-LLOG_EEMPTY);
240 if (handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT) {
241 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
243 if (rec->lrh_type != LLOG_LOGID_MAGIC) {
244 CERROR("invalid record in catalog\n");
248 l = snprintf(out, remains,
249 "[index]: %05d [logid]: "DFID":%x\n",
250 cur_index, PFID(&lir->lid_id.lgl_oi.oi_fid),
251 lir->lid_id.lgl_ogen);
252 } else if (rec->lrh_type == OBD_CFG_REC) {
255 rc = class_config_yaml_output(rec, out, remains);
260 l = snprintf(out, remains,
261 "[index]: %05d [type]: %02x [len]: %04d\n",
262 cur_index, rec->lrh_type, rec->lrh_len);
267 CERROR("not enough space for print log records\n");
268 RETURN(-LLOG_EEMPTY);
273 static int llog_remove_log(const struct lu_env *env, struct llog_handle *cat,
274 struct llog_logid *logid)
276 struct llog_handle *log;
281 rc = llog_cat_id2handle(env, cat, &log, logid);
283 CDEBUG(D_IOCTL, "cannot find log "DFID":%x\n",
284 PFID(&logid->lgl_oi.oi_fid), logid->lgl_ogen);
288 rc = llog_destroy(env, log);
290 CDEBUG(D_IOCTL, "cannot destroy log "DFID":%x\n",
291 PFID(&logid->lgl_oi.oi_fid), logid->lgl_ogen);
294 llog_cat_cleanup(env, cat, log, log->u.phd.phd_cookie.lgc_index);
296 llog_handle_put(env, log);
301 static int llog_delete_cb(const struct lu_env *env, struct llog_handle *handle,
302 struct llog_rec_hdr *rec, void *data)
304 struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
308 if (rec->lrh_type != LLOG_LOGID_MAGIC)
310 rc = llog_remove_log(env, handle, &lir->lid_id);
316 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
317 struct obd_ioctl_data *data)
319 struct llog_logid logid;
321 struct llog_handle *handle = NULL;
322 char *logname, start;
326 logname = data->ioc_inlbuf1;
328 if (start == '#' || start == '[') {
329 rc = str2logid(&logid, logname, data->ioc_inllen1);
332 rc = llog_open(env, ctxt, &handle, &logid, NULL,
336 } else if (start == '$' || isalpha(start) || isdigit(start)) {
340 rc = llog_open(env, ctxt, &handle, NULL, logname,
346 CDEBUG(D_INFO, "%s: invalid log name '%s': rc = %d\n",
347 ctxt->loc_obd->obd_name, logname, rc);
351 rc = llog_init_handle(env, handle, 0, NULL);
353 GOTO(out_close, rc = -ENOENT);
356 case OBD_IOC_LLOG_INFO: {
358 int remains = data->ioc_inllen2 +
359 cfs_size_round(data->ioc_inllen1);
360 char *out = data->ioc_bulk;
362 l = snprintf(out, remains,
365 "records_count: %d\n"
367 PFID(&handle->lgh_id.lgl_oi.oi_fid),
368 handle->lgh_id.lgl_ogen,
369 handle->lgh_hdr->llh_flags,
370 handle->lgh_hdr->llh_flags &
371 LLOG_F_IS_CAT ? "cat" : "plain",
372 handle->lgh_hdr->llh_count,
373 handle->lgh_last_idx);
377 CERROR("%s: not enough space for log header info\n",
378 ctxt->loc_obd->obd_name);
383 case OBD_IOC_LLOG_CHECK:
384 LASSERT(data->ioc_inllen1 > 0);
385 rc = llog_process(env, handle, llog_check_cb, data, NULL);
386 if (rc == -LLOG_EEMPTY)
391 case OBD_IOC_LLOG_PRINT:
392 LASSERT(data->ioc_inllen1 > 0);
393 rc = llog_process(env, handle, llog_print_cb, data, NULL);
394 if (rc == -LLOG_EEMPTY)
399 case OBD_IOC_LLOG_CANCEL: {
400 struct llog_cookie cookie;
401 struct llog_logid plain;
404 rc = kstrtouint(data->ioc_inlbuf3, 0, &lgc_index);
407 cookie.lgc_index = lgc_index;
409 if (handle->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN) {
410 rc = llog_cancel_rec(env, handle, cookie.lgc_index);
412 } else if (!(handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT)) {
413 GOTO(out_close, rc = -EINVAL);
416 if (data->ioc_inlbuf2 == NULL) /* catalog but no logid */
417 GOTO(out_close, rc = -ENOTTY);
419 rc = str2logid(&plain, data->ioc_inlbuf2, data->ioc_inllen2);
422 cookie.lgc_lgl = plain;
423 rc = llog_cat_cancel_records(env, handle, 1, &cookie);
428 case OBD_IOC_LLOG_REMOVE: {
429 struct llog_logid plain;
431 if (handle->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN) {
432 rc = llog_destroy(env, handle);
434 } else if (!(handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT)) {
435 GOTO(out_close, rc = -EINVAL);
438 if (data->ioc_inlbuf2) {
439 /* remove indicate log from the catalog */
440 rc = str2logid(&plain, data->ioc_inlbuf2,
444 rc = llog_remove_log(env, handle, &plain);
446 /* remove all the log of the catalog */
447 rc = llog_process(env, handle, llog_delete_cb, NULL,
455 CERROR("%s: Unknown ioctl cmd %#x\n",
456 ctxt->loc_obd->obd_name, cmd);
457 GOTO(out_close, rc = -ENOTTY);
461 if (handle->lgh_hdr &&
462 handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT)
463 llog_cat_close(env, handle);
465 llog_close(env, handle);
468 EXPORT_SYMBOL(llog_ioctl);
470 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
471 int count, struct obd_ioctl_data *data,
472 const struct lu_fid *fid)
475 struct llog_catid *idarray;
476 struct llog_logid *id;
478 int l, remains, rc = 0;
482 if (count == 0) { /* get total number of logs */
483 rc = llog_osd_get_cat_list(env, d, 0, 0, NULL, fid);
489 size = sizeof(*idarray) * count;
491 OBD_ALLOC_LARGE(idarray, size);
495 rc = llog_osd_get_cat_list(env, d, 0, count, idarray, fid);
499 out = data->ioc_bulk;
500 remains = data->ioc_inllen1;
501 /* OBD_FAIL: fetch the catalog records from the specified one */
502 if (OBD_FAIL_CHECK(OBD_FAIL_CATLIST))
503 data->ioc_count = cfs_fail_val - 1;
504 for (i = data->ioc_count; i < count; i++) {
505 id = &idarray[i].lci_logid;
506 l = snprintf(out, remains, "catalog_log: "DFID":%x\n",
507 PFID(&id->lgl_oi.oi_fid), id->lgl_ogen);
512 /* the print is not complete */
514 data->ioc_bulk[out - data->ioc_bulk - l] = '\0';
517 data->ioc_count = i++;
524 OBD_FREE_LARGE(idarray, size);
527 EXPORT_SYMBOL(llog_catalog_list);