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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/llog_client.c
38 * remote api for llog - client side
40 * Author: Andreas Dilger <adilger@clusterfs.com>
43 #define DEBUG_SUBSYSTEM S_LOG
45 #include <libcfs/libcfs.h>
47 #include <obd_class.h>
48 #include <lustre_log.h>
49 #include <lustre_net.h>
50 #include <libcfs/list.h>
52 #define LLOG_CLIENT_ENTRY(ctxt, imp) do { \
53 mutex_lock(&ctxt->loc_mutex); \
54 if (ctxt->loc_imp) { \
55 imp = class_import_get(ctxt->loc_imp); \
57 CERROR("ctxt->loc_imp == NULL for context idx %d." \
58 "Unable to complete MDS/OSS recovery," \
59 "but I'll try again next time. Not fatal.\n", \
62 mutex_unlock(&ctxt->loc_mutex); \
65 mutex_unlock(&ctxt->loc_mutex); \
68 #define LLOG_CLIENT_EXIT(ctxt, imp) do { \
69 mutex_lock(&ctxt->loc_mutex); \
70 if (ctxt->loc_imp != imp) \
71 CWARN("loc_imp has changed from %p to %p\n", \
72 ctxt->loc_imp, imp); \
73 class_import_put(imp); \
74 mutex_unlock(&ctxt->loc_mutex); \
77 /* This is a callback from the llog_* functions.
78 * Assumes caller has already pushed us into the kernel context. */
79 static int llog_client_open(const struct lu_env *env,
80 struct llog_handle *lgh, struct llog_logid *logid,
81 char *name, enum llog_open_param open_param)
83 struct obd_import *imp;
84 struct llogd_body *body;
85 struct llog_ctxt *ctxt = lgh->lgh_ctxt;
86 struct ptlrpc_request *req = NULL;
90 LLOG_CLIENT_ENTRY(ctxt, imp);
92 /* client cannot create llog */
93 LASSERTF(open_param != LLOG_OPEN_NEW, "%#x\n", open_param);
96 req = ptlrpc_request_alloc(imp, &RQF_LLOG_ORIGIN_HANDLE_CREATE);
98 GOTO(out, rc = -ENOMEM);
101 req_capsule_set_size(&req->rq_pill, &RMF_NAME, RCL_CLIENT,
104 rc = ptlrpc_request_pack(req, LUSTRE_LOG_VERSION,
105 LLOG_ORIGIN_HANDLE_CREATE);
107 ptlrpc_request_free(req);
111 ptlrpc_request_set_replen(req);
113 body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
115 body->lgd_logid = *logid;
116 body->lgd_ctxt_idx = ctxt->loc_idx - 1;
120 tmp = req_capsule_client_sized_get(&req->rq_pill, &RMF_NAME,
126 rc = ptlrpc_queue_wait(req);
130 body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
132 GOTO(out, rc = -EFAULT);
134 lgh->lgh_id = body->lgd_logid;
135 lgh->lgh_ctxt = ctxt;
138 LLOG_CLIENT_EXIT(ctxt, imp);
139 ptlrpc_req_finished(req);
143 static int llog_client_destroy(const struct lu_env *env,
144 struct llog_handle *loghandle)
146 struct obd_import *imp;
147 struct ptlrpc_request *req = NULL;
148 struct llogd_body *body;
152 LLOG_CLIENT_ENTRY(loghandle->lgh_ctxt, imp);
153 req = ptlrpc_request_alloc_pack(imp, &RQF_LLOG_ORIGIN_HANDLE_DESTROY,
155 LLOG_ORIGIN_HANDLE_DESTROY);
157 GOTO(err_exit, rc =-ENOMEM);
159 body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
160 body->lgd_logid = loghandle->lgh_id;
161 body->lgd_llh_flags = loghandle->lgh_hdr->llh_flags;
163 if (!(body->lgd_llh_flags & LLOG_F_IS_PLAIN))
164 CERROR("%s: wrong llog flags %x\n", imp->imp_obd->obd_name,
165 body->lgd_llh_flags);
167 ptlrpc_request_set_replen(req);
168 rc = ptlrpc_queue_wait(req);
170 ptlrpc_req_finished(req);
172 LLOG_CLIENT_EXIT(loghandle->lgh_ctxt, imp);
177 static int llog_client_next_block(const struct lu_env *env,
178 struct llog_handle *loghandle,
179 int *cur_idx, int next_idx,
180 __u64 *cur_offset, void *buf, int len)
182 struct obd_import *imp;
183 struct ptlrpc_request *req = NULL;
184 struct llogd_body *body;
189 LLOG_CLIENT_ENTRY(loghandle->lgh_ctxt, imp);
190 req = ptlrpc_request_alloc_pack(imp, &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
192 LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
194 GOTO(err_exit, rc =-ENOMEM);
196 body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
197 body->lgd_logid = loghandle->lgh_id;
198 body->lgd_ctxt_idx = loghandle->lgh_ctxt->loc_idx - 1;
199 body->lgd_llh_flags = loghandle->lgh_hdr->llh_flags;
200 body->lgd_index = next_idx;
201 body->lgd_saved_index = *cur_idx;
203 body->lgd_cur_offset = *cur_offset;
205 req_capsule_set_size(&req->rq_pill, &RMF_EADATA, RCL_SERVER, len);
206 ptlrpc_request_set_replen(req);
207 rc = ptlrpc_queue_wait(req);
211 body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
213 GOTO(out, rc =-EFAULT);
215 /* The log records are swabbed as they are processed */
216 ptr = req_capsule_server_get(&req->rq_pill, &RMF_EADATA);
218 GOTO(out, rc =-EFAULT);
220 *cur_idx = body->lgd_saved_index;
221 *cur_offset = body->lgd_cur_offset;
223 memcpy(buf, ptr, len);
226 ptlrpc_req_finished(req);
228 LLOG_CLIENT_EXIT(loghandle->lgh_ctxt, imp);
232 static int llog_client_prev_block(const struct lu_env *env,
233 struct llog_handle *loghandle,
234 int prev_idx, void *buf, int len)
236 struct obd_import *imp;
237 struct ptlrpc_request *req = NULL;
238 struct llogd_body *body;
243 LLOG_CLIENT_ENTRY(loghandle->lgh_ctxt, imp);
244 req = ptlrpc_request_alloc_pack(imp, &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
246 LLOG_ORIGIN_HANDLE_PREV_BLOCK);
248 GOTO(err_exit, rc = -ENOMEM);
250 body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
251 body->lgd_logid = loghandle->lgh_id;
252 body->lgd_ctxt_idx = loghandle->lgh_ctxt->loc_idx - 1;
253 body->lgd_llh_flags = loghandle->lgh_hdr->llh_flags;
254 body->lgd_index = prev_idx;
257 req_capsule_set_size(&req->rq_pill, &RMF_EADATA, RCL_SERVER, len);
258 ptlrpc_request_set_replen(req);
260 rc = ptlrpc_queue_wait(req);
264 body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
266 GOTO(out, rc =-EFAULT);
268 ptr = req_capsule_server_get(&req->rq_pill, &RMF_EADATA);
270 GOTO(out, rc =-EFAULT);
272 memcpy(buf, ptr, len);
275 ptlrpc_req_finished(req);
277 LLOG_CLIENT_EXIT(loghandle->lgh_ctxt, imp);
281 static int llog_client_read_header(const struct lu_env *env,
282 struct llog_handle *handle)
284 struct obd_import *imp;
285 struct ptlrpc_request *req = NULL;
286 struct llogd_body *body;
287 struct llog_log_hdr *hdr;
288 struct llog_rec_hdr *llh_hdr;
292 LLOG_CLIENT_ENTRY(handle->lgh_ctxt, imp);
293 req = ptlrpc_request_alloc_pack(imp,&RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
295 LLOG_ORIGIN_HANDLE_READ_HEADER);
297 GOTO(err_exit, rc = -ENOMEM);
299 body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
300 body->lgd_logid = handle->lgh_id;
301 body->lgd_ctxt_idx = handle->lgh_ctxt->loc_idx - 1;
302 body->lgd_llh_flags = handle->lgh_hdr->llh_flags;
304 ptlrpc_request_set_replen(req);
305 rc = ptlrpc_queue_wait(req);
309 hdr = req_capsule_server_get(&req->rq_pill, &RMF_LLOG_LOG_HDR);
311 GOTO(out, rc =-EFAULT);
313 if (handle->lgh_hdr_size < hdr->llh_hdr.lrh_len)
314 GOTO(out, rc = -EFAULT);
316 memcpy(handle->lgh_hdr, hdr, hdr->llh_hdr.lrh_len);
317 handle->lgh_last_idx = LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_index;
320 llh_hdr = &handle->lgh_hdr->llh_hdr;
321 if (llh_hdr->lrh_type != LLOG_HDR_MAGIC) {
322 CERROR("bad log header magic: %#x (expecting %#x)\n",
323 llh_hdr->lrh_type, LLOG_HDR_MAGIC);
325 } else if (llh_hdr->lrh_len !=
326 LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_len ||
327 (llh_hdr->lrh_len & (llh_hdr->lrh_len - 1)) != 0 ||
328 llh_hdr->lrh_len < LLOG_MIN_CHUNK_SIZE ||
329 llh_hdr->lrh_len > handle->lgh_hdr_size) {
330 CERROR("incorrectly sized log header: %#x, "
331 "expecting %#x (power of two > 8192)\n",
333 LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_len);
334 CERROR("you may need to re-run lconf --write_conf.\n");
339 ptlrpc_req_finished(req);
341 LLOG_CLIENT_EXIT(handle->lgh_ctxt, imp);
345 static int llog_client_close(const struct lu_env *env,
346 struct llog_handle *handle)
348 /* this doesn't call LLOG_ORIGIN_HANDLE_CLOSE because
349 the servers all close the file at the end of every
354 struct llog_operations llog_client_ops = {
355 .lop_next_block = llog_client_next_block,
356 .lop_prev_block = llog_client_prev_block,
357 .lop_read_header = llog_client_read_header,
358 .lop_open = llog_client_open,
359 .lop_destroy = llog_client_destroy,
360 .lop_close = llog_client_close,
362 EXPORT_SYMBOL(llog_client_ops);