drivers/staging/lustre/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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  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
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2015, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/ptlrpc/llog_client.c
  37  *
  38  * remote api for llog - client side
  39  *
  40  * Author: Andreas Dilger <adilger@clusterfs.com>
  41  */
  42
  43 #define DEBUG_SUBSYSTEM S_LOG
  44
  45 #include "../../include/linux/libcfs/libcfs.h"
  46
  47 #include "../include/obd_class.h"
  48 #include "../include/lustre_log.h"
  49 #include "../include/lustre_net.h"
  50 #include <linux/list.h>
  51
  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);                  \
  56         } else {                                                        \
  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",   \
  60                        ctxt->loc_idx);                                  \
  61                 imp = NULL;                                             \
  62                 mutex_unlock(&ctxt->loc_mutex);                         \
  63                 return (-EINVAL);                                       \
  64         }                                                               \
  65         mutex_unlock(&ctxt->loc_mutex);                                 \
  66 } while (0)
  67
  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);                                 \
  75 } while (0)
  76
  77 /* This is a callback from the llog_* functions.
  78  * Assumes caller has already pushed us into the kernel context.
  79  */
  80 static int llog_client_open(const struct lu_env *env,
  81                             struct llog_handle *lgh, struct llog_logid *logid,
  82                             char *name, enum llog_open_param open_param)
  83 {
  84         struct obd_import *imp;
  85         struct llogd_body *body;
  86         struct llog_ctxt *ctxt = lgh->lgh_ctxt;
  87         struct ptlrpc_request *req = NULL;
  88         int rc;
  89
  90         LLOG_CLIENT_ENTRY(ctxt, imp);
  91
  92         /* client cannot create llog */
  93         LASSERTF(open_param != LLOG_OPEN_NEW, "%#x\n", open_param);
  94         LASSERT(lgh);
  95
  96         req = ptlrpc_request_alloc(imp, &RQF_LLOG_ORIGIN_HANDLE_CREATE);
  97         if (!req) {
  98                 rc = -ENOMEM;
  99                 goto out;
 100         }
 101
 102         if (name)
 103                 req_capsule_set_size(&req->rq_pill, &RMF_NAME, RCL_CLIENT,
 104                                      strlen(name) + 1);
 105
 106         rc = ptlrpc_request_pack(req, LUSTRE_LOG_VERSION,
 107                                  LLOG_ORIGIN_HANDLE_CREATE);
 108         if (rc) {
 109                 ptlrpc_request_free(req);
 110                 req = NULL;
 111                 goto out;
 112         }
 113         ptlrpc_request_set_replen(req);
 114
 115         body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
 116         if (logid)
 117                 body->lgd_logid = *logid;
 118         body->lgd_ctxt_idx = ctxt->loc_idx - 1;
 119
 120         if (name) {
 121                 char *tmp;
 122
 123                 tmp = req_capsule_client_sized_get(&req->rq_pill, &RMF_NAME,
 124                                                    strlen(name) + 1);
 125                 LASSERT(tmp);
 126                 strcpy(tmp, name);
 127         }
 128
 129         rc = ptlrpc_queue_wait(req);
 130         if (rc)
 131                 goto out;
 132
 133         body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
 134         if (!body) {
 135                 rc = -EFAULT;
 136                 goto out;
 137         }
 138
 139         lgh->lgh_id = body->lgd_logid;
 140         lgh->lgh_ctxt = ctxt;
 141 out:
 142         LLOG_CLIENT_EXIT(ctxt, imp);
 143         ptlrpc_req_finished(req);
 144         return rc;
 145 }
 146
 147 static int llog_client_next_block(const struct lu_env *env,
 148                                   struct llog_handle *loghandle,
 149                                   int *cur_idx, int next_idx,
 150                                   __u64 *cur_offset, void *buf, int len)
 151 {
 152         struct obd_import *imp;
 153         struct ptlrpc_request *req = NULL;
 154         struct llogd_body *body;
 155         void *ptr;
 156         int rc;
 157
 158         LLOG_CLIENT_ENTRY(loghandle->lgh_ctxt, imp);
 159         req = ptlrpc_request_alloc_pack(imp, &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
 160                                         LUSTRE_LOG_VERSION,
 161                                         LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
 162         if (!req) {
 163                 rc = -ENOMEM;
 164                 goto err_exit;
 165         }
 166
 167         body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
 168         body->lgd_logid = loghandle->lgh_id;
 169         body->lgd_ctxt_idx = loghandle->lgh_ctxt->loc_idx - 1;
 170         body->lgd_llh_flags = loghandle->lgh_hdr->llh_flags;
 171         body->lgd_index = next_idx;
 172         body->lgd_saved_index = *cur_idx;
 173         body->lgd_len = len;
 174         body->lgd_cur_offset = *cur_offset;
 175
 176         req_capsule_set_size(&req->rq_pill, &RMF_EADATA, RCL_SERVER, len);
 177         ptlrpc_request_set_replen(req);
 178         rc = ptlrpc_queue_wait(req);
 179         if (rc)
 180                 goto out;
 181
 182         body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
 183         if (!body) {
 184                 rc = -EFAULT;
 185                 goto out;
 186         }
 187
 188         /* The log records are swabbed as they are processed */
 189         ptr = req_capsule_server_get(&req->rq_pill, &RMF_EADATA);
 190         if (!ptr) {
 191                 rc = -EFAULT;
 192                 goto out;
 193         }
 194
 195         *cur_idx = body->lgd_saved_index;
 196         *cur_offset = body->lgd_cur_offset;
 197
 198         memcpy(buf, ptr, len);
 199 out:
 200         ptlrpc_req_finished(req);
 201 err_exit:
 202         LLOG_CLIENT_EXIT(loghandle->lgh_ctxt, imp);
 203         return rc;
 204 }
 205
 206 static int llog_client_prev_block(const struct lu_env *env,
 207                                   struct llog_handle *loghandle,
 208                                   int prev_idx, void *buf, int len)
 209 {
 210         struct obd_import *imp;
 211         struct ptlrpc_request *req = NULL;
 212         struct llogd_body *body;
 213         void *ptr;
 214         int rc;
 215
 216         LLOG_CLIENT_ENTRY(loghandle->lgh_ctxt, imp);
 217         req = ptlrpc_request_alloc_pack(imp, &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
 218                                         LUSTRE_LOG_VERSION,
 219                                         LLOG_ORIGIN_HANDLE_PREV_BLOCK);
 220         if (!req) {
 221                 rc = -ENOMEM;
 222                 goto err_exit;
 223         }
 224
 225         body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
 226         body->lgd_logid = loghandle->lgh_id;
 227         body->lgd_ctxt_idx = loghandle->lgh_ctxt->loc_idx - 1;
 228         body->lgd_llh_flags = loghandle->lgh_hdr->llh_flags;
 229         body->lgd_index = prev_idx;
 230         body->lgd_len = len;
 231
 232         req_capsule_set_size(&req->rq_pill, &RMF_EADATA, RCL_SERVER, len);
 233         ptlrpc_request_set_replen(req);
 234
 235         rc = ptlrpc_queue_wait(req);
 236         if (rc)
 237                 goto out;
 238
 239         body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
 240         if (!body) {
 241                 rc = -EFAULT;
 242                 goto out;
 243         }
 244
 245         ptr = req_capsule_server_get(&req->rq_pill, &RMF_EADATA);
 246         if (!ptr) {
 247                 rc = -EFAULT;
 248                 goto out;
 249         }
 250
 251         memcpy(buf, ptr, len);
 252 out:
 253         ptlrpc_req_finished(req);
 254 err_exit:
 255         LLOG_CLIENT_EXIT(loghandle->lgh_ctxt, imp);
 256         return rc;
 257 }
 258
 259 static int llog_client_read_header(const struct lu_env *env,
 260                                    struct llog_handle *handle)
 261 {
 262         struct obd_import *imp;
 263         struct ptlrpc_request *req = NULL;
 264         struct llogd_body *body;
 265         struct llog_log_hdr *hdr;
 266         struct llog_rec_hdr *llh_hdr;
 267         int rc;
 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) {
 274                 rc = -ENOMEM;
 275                 goto err_exit;
 276         }
 277
 278         body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
 279         body->lgd_logid = handle->lgh_id;
 280         body->lgd_ctxt_idx = handle->lgh_ctxt->loc_idx - 1;
 281         body->lgd_llh_flags = handle->lgh_hdr->llh_flags;
 282
 283         ptlrpc_request_set_replen(req);
 284         rc = ptlrpc_queue_wait(req);
 285         if (rc)
 286                 goto out;
 287
 288         hdr = req_capsule_server_get(&req->rq_pill, &RMF_LLOG_LOG_HDR);
 289         if (!hdr) {
 290                 rc = -EFAULT;
 291                 goto out;
 292         }
 293
 294         memcpy(handle->lgh_hdr, hdr, sizeof(*hdr));
 295         handle->lgh_last_idx = handle->lgh_hdr->llh_tail.lrt_index;
 296
 297         /* sanity checks */
 298         llh_hdr = &handle->lgh_hdr->llh_hdr;
 299         if (llh_hdr->lrh_type != LLOG_HDR_MAGIC) {
 300                 CERROR("bad log header magic: %#x (expecting %#x)\n",
 301                        llh_hdr->lrh_type, LLOG_HDR_MAGIC);
 302                 rc = -EIO;
 303         } else if (llh_hdr->lrh_len != LLOG_CHUNK_SIZE) {
 304                 CERROR("incorrectly sized log header: %#x (expecting %#x)\n",
 305                        llh_hdr->lrh_len, LLOG_CHUNK_SIZE);
 306                 CERROR("you may need to re-run lconf --write_conf.\n");
 307                 rc = -EIO;
 308         }
 309 out:
 310         ptlrpc_req_finished(req);
 311 err_exit:
 312         LLOG_CLIENT_EXIT(handle->lgh_ctxt, imp);
 313         return rc;
 314 }
 315
 316 static int llog_client_close(const struct lu_env *env,
 317                              struct llog_handle *handle)
 318 {
 319         /* this doesn't call LLOG_ORIGIN_HANDLE_CLOSE because
 320          *  the servers all close the file at the end of every
 321          * other LLOG_ RPC.
 322          */
 323         return 0;
 324 }
 325
 326 struct llog_operations llog_client_ops = {
 327         .lop_next_block         = llog_client_next_block,
 328         .lop_prev_block         = llog_client_prev_block,
 329         .lop_read_header        = llog_client_read_header,
 330         .lop_open               = llog_client_open,
 331         .lop_close              = llog_client_close,
 332 };
 333 EXPORT_SYMBOL(llog_client_ops);