lustre/ptlrpc/llog_client.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) 2003, 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/ptlrpc/llog_client.c
  33  *
  34  * remote api for llog - client side
  35  *
  36  * Author: Andreas Dilger <adilger@clusterfs.com>
  37  */
  38
  39 #define DEBUG_SUBSYSTEM S_LOG
  40
  41 #include <linux/list.h>
  42 #include <libcfs/libcfs.h>
  43
  44 #include <obd_class.h>
  45 #include <lustre_log.h>
  46 #include <lustre_net.h>
  47
  48 #define LLOG_CLIENT_ENTRY(ctxt, imp) do {                             \
  49         mutex_lock(&ctxt->loc_mutex);                             \
  50         if (ctxt->loc_imp) {                                          \
  51                 imp = class_import_get(ctxt->loc_imp);                \
  52         } else {                                                      \
  53                 CERROR("ctxt->loc_imp == NULL for context idx %d."    \
  54                        "Unable to complete MDS/OSS recovery,"         \
  55                        "but I'll try again next time.  Not fatal.\n", \
  56                        ctxt->loc_idx);                                \
  57                 imp = NULL;                                           \
  58                 mutex_unlock(&ctxt->loc_mutex);                   \
  59                 return (-EINVAL);                                     \
  60         }                                                             \
  61         mutex_unlock(&ctxt->loc_mutex);                           \
  62 } while(0)
  63
  64 #define LLOG_CLIENT_EXIT(ctxt, imp) do {                              \
  65         mutex_lock(&ctxt->loc_mutex);                             \
  66         if (ctxt->loc_imp != imp)                                     \
  67                 CWARN("loc_imp has changed from %p to %p\n",          \
  68                        ctxt->loc_imp, imp);                           \
  69         class_import_put(imp);                                        \
  70         mutex_unlock(&ctxt->loc_mutex);                           \
  71 } while(0)
  72
  73 /* This is a callback from the llog_* functions.
  74  * Assumes caller has already pushed us into the kernel context. */
  75 static int llog_client_open(const struct lu_env *env,
  76                             struct llog_handle *lgh, struct llog_logid *logid,
  77                             char *name, enum llog_open_param open_param)
  78 {
  79         struct obd_import     *imp;
  80         struct llogd_body     *body;
  81         struct llog_ctxt      *ctxt = lgh->lgh_ctxt;
  82         struct ptlrpc_request *req = NULL;
  83         int                    rc;
  84         ENTRY;
  85
  86         LLOG_CLIENT_ENTRY(ctxt, imp);
  87
  88         /* client cannot create llog */
  89         LASSERTF(open_param != LLOG_OPEN_NEW, "%#x\n", open_param);
  90         LASSERT(lgh);
  91
  92         req = ptlrpc_request_alloc(imp, &RQF_LLOG_ORIGIN_HANDLE_CREATE);
  93         if (req == NULL)
  94                 GOTO(out, rc = -ENOMEM);
  95
  96         if (name)
  97                 req_capsule_set_size(&req->rq_pill, &RMF_NAME, RCL_CLIENT,
  98                                      strlen(name) + 1);
  99
 100         rc = ptlrpc_request_pack(req, LUSTRE_LOG_VERSION,
 101                                  LLOG_ORIGIN_HANDLE_CREATE);
 102         if (rc) {
 103                 ptlrpc_request_free(req);
 104                 req = NULL;
 105                 GOTO(out, rc);
 106         }
 107         ptlrpc_request_set_replen(req);
 108
 109         body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
 110         if (logid)
 111                 body->lgd_logid = *logid;
 112         body->lgd_ctxt_idx = ctxt->loc_idx - 1;
 113
 114         if (name) {
 115                 char *tmp;
 116                 tmp = req_capsule_client_sized_get(&req->rq_pill, &RMF_NAME,
 117                                                    strlen(name) + 1);
 118                 LASSERT(tmp);
 119                 strcpy(tmp, name);
 120         }
 121
 122         rc = ptlrpc_queue_wait(req);
 123         if (rc)
 124                 GOTO(out, rc);
 125
 126         body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
 127         if (body == NULL)
 128                 GOTO(out, rc = -EFAULT);
 129
 130         lgh->lgh_id = body->lgd_logid;
 131         lgh->lgh_ctxt = ctxt;
 132         EXIT;
 133 out:
 134         LLOG_CLIENT_EXIT(ctxt, imp);
 135         ptlrpc_req_finished(req);
 136         return rc;
 137 }
 138
 139 static int llog_client_next_block(const struct lu_env *env,
 140                                   struct llog_handle *loghandle,
 141                                   int *cur_idx, int next_idx,
 142                                   __u64 *cur_offset, void *buf, int len)
 143 {
 144         struct obd_import     *imp;
 145         struct ptlrpc_request *req = NULL;
 146         struct llogd_body     *body;
 147         void                  *ptr;
 148         int                    rc;
 149         ENTRY;
 150
 151         LLOG_CLIENT_ENTRY(loghandle->lgh_ctxt, imp);
 152         req = ptlrpc_request_alloc_pack(imp, &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
 153                                         LUSTRE_LOG_VERSION,
 154                                         LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
 155         if (req == NULL)
 156                 GOTO(err_exit, rc =-ENOMEM);
 157
 158         body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
 159         body->lgd_logid = loghandle->lgh_id;
 160         body->lgd_ctxt_idx = loghandle->lgh_ctxt->loc_idx - 1;
 161         body->lgd_llh_flags = loghandle->lgh_hdr->llh_flags;
 162         body->lgd_index = next_idx;
 163         body->lgd_saved_index = *cur_idx;
 164         body->lgd_len = len;
 165         body->lgd_cur_offset = *cur_offset;
 166
 167         req_capsule_set_size(&req->rq_pill, &RMF_EADATA, RCL_SERVER, len);
 168         ptlrpc_request_set_replen(req);
 169         rc = ptlrpc_queue_wait(req);
 170         /* -EIO has a special meaning here. If llog_osd_next_block()
 171          * reaches the end of the log without finding the desired
 172          * record then it updates *cur_offset and *cur_idx and returns
 173          * -EIO. In llog_process_thread() we use this to detect
 174          * EOF. But we must be careful to distinguish between -EIO
 175          * coming from llog_osd_next_block() and -EIO coming from
 176          * ptlrpc or below. */
 177         if (rc == -EIO) {
 178                 if (req->rq_repmsg == NULL ||
 179                     lustre_msg_get_status(req->rq_repmsg) != -EIO)
 180                         GOTO(out, rc);
 181         } else if (rc < 0) {
 182                 GOTO(out, rc);
 183         }
 184
 185         body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
 186         if (body == NULL)
 187                 GOTO(out, rc = -EFAULT);
 188
 189         *cur_idx = body->lgd_saved_index;
 190         *cur_offset = body->lgd_cur_offset;
 191
 192         if (rc < 0)
 193                 GOTO(out, rc);
 194
 195         /* The log records are swabbed as they are processed */
 196         ptr = req_capsule_server_get(&req->rq_pill, &RMF_EADATA);
 197         if (ptr == NULL)
 198                 GOTO(out, rc =-EFAULT);
 199
 200         memcpy(buf, ptr, len);
 201         EXIT;
 202 out:
 203         ptlrpc_req_finished(req);
 204 err_exit:
 205         LLOG_CLIENT_EXIT(loghandle->lgh_ctxt, imp);
 206         return rc;
 207 }
 208
 209 static int llog_client_prev_block(const struct lu_env *env,
 210                                   struct llog_handle *loghandle,
 211                                   int prev_idx, void *buf, int len)
 212 {
 213         struct obd_import     *imp;
 214         struct ptlrpc_request *req = NULL;
 215         struct llogd_body     *body;
 216         void                  *ptr;
 217         int                    rc;
 218         ENTRY;
 219
 220         LLOG_CLIENT_ENTRY(loghandle->lgh_ctxt, imp);
 221         req = ptlrpc_request_alloc_pack(imp, &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
 222                                         LUSTRE_LOG_VERSION,
 223                                         LLOG_ORIGIN_HANDLE_PREV_BLOCK);
 224         if (req == NULL)
 225                 GOTO(err_exit, rc = -ENOMEM);
 226
 227         body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
 228         body->lgd_logid = loghandle->lgh_id;
 229         body->lgd_ctxt_idx = loghandle->lgh_ctxt->loc_idx - 1;
 230         body->lgd_llh_flags = loghandle->lgh_hdr->llh_flags;
 231         body->lgd_index = prev_idx;
 232         body->lgd_len = len;
 233
 234         req_capsule_set_size(&req->rq_pill, &RMF_EADATA, RCL_SERVER, len);
 235         ptlrpc_request_set_replen(req);
 236
 237         rc = ptlrpc_queue_wait(req);
 238         if (rc)
 239                 GOTO(out, rc);
 240
 241         body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
 242         if (body == NULL)
 243                 GOTO(out, rc =-EFAULT);
 244
 245         ptr = req_capsule_server_get(&req->rq_pill, &RMF_EADATA);
 246         if (ptr == NULL)
 247                 GOTO(out, rc =-EFAULT);
 248
 249         memcpy(buf, ptr, len);
 250         EXIT;
 251 out:
 252         ptlrpc_req_finished(req);
 253 err_exit:
 254         LLOG_CLIENT_EXIT(loghandle->lgh_ctxt, imp);
 255         return rc;
 256 }
 257
 258 static int llog_client_read_header(const struct lu_env *env,
 259                                    struct llog_handle *handle)
 260 {
 261         struct obd_import     *imp;
 262         struct ptlrpc_request *req = NULL;
 263         struct llogd_body     *body;
 264         struct llog_log_hdr   *hdr;
 265         struct llog_rec_hdr   *llh_hdr;
 266         int                    rc;
 267         ENTRY;
 268
 269         LLOG_CLIENT_ENTRY(handle->lgh_ctxt, imp);
 270         req = ptlrpc_request_alloc_pack(imp,&RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
 271                                         LUSTRE_LOG_VERSION,
 272                                         LLOG_ORIGIN_HANDLE_READ_HEADER);
 273         if (req == NULL)
 274                 GOTO(err_exit, rc = -ENOMEM);
 275
 276         body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
 277         body->lgd_logid = handle->lgh_id;
 278         body->lgd_ctxt_idx = handle->lgh_ctxt->loc_idx - 1;
 279         body->lgd_llh_flags = handle->lgh_hdr->llh_flags;
 280
 281         ptlrpc_request_set_replen(req);
 282         rc = ptlrpc_queue_wait(req);
 283         if (rc)
 284                 GOTO(out, rc);
 285
 286         hdr = req_capsule_server_get(&req->rq_pill, &RMF_LLOG_LOG_HDR);
 287         if (hdr == NULL)
 288                 GOTO(out, rc =-EFAULT);
 289
 290         if (handle->lgh_hdr_size < hdr->llh_hdr.lrh_len)
 291                 GOTO(out, rc = -EFAULT);
 292
 293         memcpy(handle->lgh_hdr, hdr, hdr->llh_hdr.lrh_len);
 294         handle->lgh_last_idx = LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_index;
 295
 296         /* sanity checks */
 297         llh_hdr = &handle->lgh_hdr->llh_hdr;
 298         if (llh_hdr->lrh_type != LLOG_HDR_MAGIC) {
 299                 CERROR("bad log header magic: %#x (expecting %#x)\n",
 300                        llh_hdr->lrh_type, LLOG_HDR_MAGIC);
 301                 rc = -EIO;
 302         } else if (llh_hdr->lrh_len !=
 303                    LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_len ||
 304                    (llh_hdr->lrh_len & (llh_hdr->lrh_len - 1)) != 0 ||
 305                    llh_hdr->lrh_len < LLOG_MIN_CHUNK_SIZE ||
 306                    llh_hdr->lrh_len > handle->lgh_hdr_size) {
 307                 CERROR("incorrectly sized log header: %#x, "
 308                        "expecting %#x (power of two > 8192)\n",
 309                        llh_hdr->lrh_len,
 310                        LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_len);
 311                 CERROR("you may need to re-run lconf --write_conf.\n");
 312                 rc = -EIO;
 313         }
 314         EXIT;
 315 out:
 316         ptlrpc_req_finished(req);
 317 err_exit:
 318         LLOG_CLIENT_EXIT(handle->lgh_ctxt, imp);
 319         return rc;
 320 }
 321
 322 static int llog_client_close(const struct lu_env *env,
 323                              struct llog_handle *handle)
 324 {
 325         /* this doesn't call LLOG_ORIGIN_HANDLE_CLOSE because
 326            the servers all close the file at the end of every
 327            other LLOG_ RPC. */
 328         return(0);
 329 }
 330
 331 struct llog_operations llog_client_ops = {
 332         .lop_next_block         = llog_client_next_block,
 333         .lop_prev_block         = llog_client_prev_block,
 334         .lop_read_header        = llog_client_read_header,
 335         .lop_open               = llog_client_open,
 336         .lop_close              = llog_client_close,
 337 };
 338 EXPORT_SYMBOL(llog_client_ops);