Whamcloud - gitweb
LU-8602 gss: get rid of cfs_crypto_hash_desc
[fs/lustre-release.git] / lustre / ptlrpc / llog_client.c
index 27578a4..0f149b6 100644 (file)
-/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
- * vim:expandtab:shiftwidth=8:tabstop=8:
+/*
+ * GPL HEADER START
  *
- *  Copyright (C) 2001-2004 Cluster File Systems, Inc.
- *   Author: Andreas Dilger <adilger@clusterfs.com>
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
- *   This file is part of the Lustre file system, http://www.lustre.org
- *   Lustre is a trademark of Cluster File Systems, Inc.
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 only,
+ * as published by the Free Software Foundation.
  *
- *   You may have signed or agreed to another license before downloading
- *   this software.  If so, you are bound by the terms and conditions
- *   of that agreement, and the following does not apply to you.  See the
- *   LICENSE file included with this distribution for more information.
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License version 2 for more details (a copy is included
+ * in the LICENSE file that accompanied this code).
  *
- *   If you did not agree to a different license, then this copy of Lustre
- *   is open source software; you can redistribute it and/or modify it
- *   under the terms of version 2 of the GNU General Public License as
- *   published by the Free Software Foundation.
+ * You should have received a copy of the GNU General Public License
+ * version 2 along with this program; If not, see
+ * http://www.gnu.org/licenses/gpl-2.0.html
  *
- *   In either case, Lustre is distributed in the hope that it will be
- *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
- *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *   license text for more details.
+ * GPL HEADER END
+ */
+/*
+ * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
+ * Use is subject to license terms.
+ *
+ * Copyright (c) 2012, 2015, Intel Corporation.
+ */
+/*
+ * This file is part of Lustre, http://www.lustre.org/
+ * Lustre is a trademark of Sun Microsystems, Inc.
  *
- *  remote api for llog - client side
+ * lustre/ptlrpc/llog_client.c
  *
+ * remote api for llog - client side
+ *
+ * Author: Andreas Dilger <adilger@clusterfs.com>
  */
 
 #define DEBUG_SUBSYSTEM S_LOG
 
-#ifndef EXPORT_SYMTAB
-#define EXPORT_SYMTAB
-#endif
-
-#ifdef __KERNEL__
+#include <linux/list.h>
 #include <libcfs/libcfs.h>
-#else
-#include <liblustre.h>
-#endif
 
 #include <obd_class.h>
 #include <lustre_log.h>
 #include <lustre_net.h>
-#include <libcfs/list.h>
+
+#define LLOG_CLIENT_ENTRY(ctxt, imp) do {                             \
+       mutex_lock(&ctxt->loc_mutex);                             \
+        if (ctxt->loc_imp) {                                          \
+                imp = class_import_get(ctxt->loc_imp);                \
+        } else {                                                      \
+                CERROR("ctxt->loc_imp == NULL for context idx %d."    \
+                       "Unable to complete MDS/OSS recovery,"         \
+                       "but I'll try again next time.  Not fatal.\n", \
+                       ctxt->loc_idx);                                \
+                imp = NULL;                                           \
+               mutex_unlock(&ctxt->loc_mutex);                   \
+                return (-EINVAL);                                     \
+        }                                                             \
+       mutex_unlock(&ctxt->loc_mutex);                           \
+} while(0)
+
+#define LLOG_CLIENT_EXIT(ctxt, imp) do {                              \
+       mutex_lock(&ctxt->loc_mutex);                             \
+        if (ctxt->loc_imp != imp)                                     \
+                CWARN("loc_imp has changed from %p to %p\n",          \
+                       ctxt->loc_imp, imp);                           \
+        class_import_put(imp);                                        \
+       mutex_unlock(&ctxt->loc_mutex);                           \
+} while(0)
 
 /* This is a callback from the llog_* functions.
  * Assumes caller has already pushed us into the kernel context. */
-static int llog_client_create(struct llog_ctxt *ctxt, struct llog_handle **res,
-                              struct llog_logid *logid, char *name)
+static int llog_client_open(const struct lu_env *env,
+                           struct llog_handle *lgh, struct llog_logid *logid,
+                           char *name, enum llog_open_param open_param)
 {
-        struct obd_import *imp;
-        struct llogd_body req_body;
-        struct llogd_body *body;
-        struct llog_handle *handle;
+        struct obd_import     *imp;
+        struct llogd_body     *body;
+       struct llog_ctxt      *ctxt = lgh->lgh_ctxt;
         struct ptlrpc_request *req = NULL;
-        int size[3] = { sizeof(struct ptlrpc_body), sizeof(req_body) };
-        char *bufs[3] = { NULL, (char*)&req_body };
-        int bufcount = 2;
-        int rc;
+        int                    rc;
         ENTRY;
 
-        if (ctxt->loc_imp == NULL) {
-                /* This used to be an assert; bug 6200 */
-                CERROR("ctxt->loc_imp == NULL for context idx %d.  Unable to "
-                       "complete MDS/OSS recovery, but I'll try again next "
-                       "time.  Not fatal.\n", ctxt->loc_idx);
-                RETURN(-EINVAL);
-        }
-        imp = ctxt->loc_imp;
+        LLOG_CLIENT_ENTRY(ctxt, imp);
+
+       /* client cannot create llog */
+       LASSERTF(open_param != LLOG_OPEN_NEW, "%#x\n", open_param);
+       LASSERT(lgh);
+
+       req = ptlrpc_request_alloc(imp, &RQF_LLOG_ORIGIN_HANDLE_CREATE);
+       if (req == NULL)
+               GOTO(out, rc = -ENOMEM);
 
-        handle = llog_alloc_handle();
-        if (handle == NULL)
-                RETURN(-ENOMEM);
-        *res = handle;
+        if (name)
+                req_capsule_set_size(&req->rq_pill, &RMF_NAME, RCL_CLIENT,
+                                     strlen(name) + 1);
 
-        memset(&req_body, 0, sizeof(req_body));
+        rc = ptlrpc_request_pack(req, LUSTRE_LOG_VERSION,
+                                 LLOG_ORIGIN_HANDLE_CREATE);
+        if (rc) {
+                ptlrpc_request_free(req);
+                req = NULL;
+               GOTO(out, rc);
+        }
+        ptlrpc_request_set_replen(req);
+
+        body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
         if (logid)
-                req_body.lgd_logid = *logid;
-        req_body.lgd_ctxt_idx = ctxt->loc_idx - 1;
+                body->lgd_logid = *logid;
+        body->lgd_ctxt_idx = ctxt->loc_idx - 1;
 
         if (name) {
-                size[bufcount] = strlen(name) + 1;
-                bufs[bufcount] = name;
-                bufcount++;
+                char *tmp;
+                tmp = req_capsule_client_sized_get(&req->rq_pill, &RMF_NAME,
+                                                   strlen(name) + 1);
+                LASSERT(tmp);
+                strcpy(tmp, name);
         }
 
-        req = ptlrpc_prep_req(imp, LUSTRE_LOG_VERSION,
-                              LLOG_ORIGIN_HANDLE_CREATE, bufcount, size, bufs);
-        if (!req)
-                GOTO(err_free, rc = -ENOMEM);
-
-        ptlrpc_req_set_repsize(req, 2, size);
         rc = ptlrpc_queue_wait(req);
         if (rc)
-                GOTO(err_free, rc);
+               GOTO(out, rc);
 
-        body = lustre_swab_repbuf(req, REPLY_REC_OFF, sizeof(*body),
-                                 lustre_swab_llogd_body);
-        if (body == NULL) {
-                CERROR ("Can't unpack llogd_body\n");
-                GOTO(err_free, rc =-EFAULT);
-        }
-
-        handle->lgh_id = body->lgd_logid;
-        handle->lgh_ctxt = ctxt;
+       body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
+       if (body == NULL)
+               GOTO(out, rc = -EFAULT);
 
+       lgh->lgh_id = body->lgd_logid;
+       lgh->lgh_ctxt = ctxt;
+       EXIT;
 out:
-        if (req)
-                ptlrpc_req_finished(req);
-        RETURN(rc);
-
-err_free:
-        llog_free_handle(handle);
-        goto out;
+       LLOG_CLIENT_EXIT(ctxt, imp);
+       ptlrpc_req_finished(req);
+       return rc;
 }
 
-static int llog_client_destroy(struct llog_handle *loghandle)
+static int llog_client_next_block(const struct lu_env *env,
+                                 struct llog_handle *loghandle,
+                                 int *cur_idx, int next_idx,
+                                 __u64 *cur_offset, void *buf, int len)
 {
-        struct obd_import *imp = loghandle->lgh_ctxt->loc_imp;
+        struct obd_import     *imp;
         struct ptlrpc_request *req = NULL;
-        struct llogd_body *body;
-        int size[] = { sizeof(struct ptlrpc_body), sizeof(*body) };
-        int rc;
+        struct llogd_body     *body;
+        void                  *ptr;
+        int                    rc;
         ENTRY;
 
-        req = ptlrpc_prep_req(imp, LUSTRE_LOG_VERSION, 
-                              LLOG_ORIGIN_HANDLE_DESTROY, 2, size, NULL);
-        if (!req)
-                RETURN(-ENOMEM);
+        LLOG_CLIENT_ENTRY(loghandle->lgh_ctxt, imp);
+        req = ptlrpc_request_alloc_pack(imp, &RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK,
+                                        LUSTRE_LOG_VERSION,
+                                        LLOG_ORIGIN_HANDLE_NEXT_BLOCK);
+        if (req == NULL)
+                GOTO(err_exit, rc =-ENOMEM);
 
-        body = lustre_msg_buf(req->rq_reqmsg, REQ_REC_OFF, sizeof(*body));
-        body->lgd_logid = loghandle->lgh_id;
-        body->lgd_llh_flags = loghandle->lgh_hdr->llh_flags;
-
-        ptlrpc_req_set_repsize(req, 2, size);
-        rc = ptlrpc_queue_wait(req);
-        
-        ptlrpc_req_finished(req);
-        RETURN(rc);
-}
-
-
-static int llog_client_next_block(struct llog_handle *loghandle,
-                                  int *cur_idx, int next_idx,
-                                  __u64 *cur_offset, void *buf, int len)
-{
-        struct obd_import *imp = loghandle->lgh_ctxt->loc_imp;
-        struct ptlrpc_request *req = NULL;
-        struct llogd_body *body;
-        void * ptr;
-        int size[3] = { sizeof(struct ptlrpc_body), sizeof(*body) };
-        int rc;
-        ENTRY;
-
-        req = ptlrpc_prep_req(imp, LUSTRE_LOG_VERSION,
-                              LLOG_ORIGIN_HANDLE_NEXT_BLOCK, 2, size, NULL);
-        if (!req)
-                GOTO(out, rc = -ENOMEM);
-
-        body = lustre_msg_buf(req->rq_reqmsg, REQ_REC_OFF, sizeof(*body));
+        body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
         body->lgd_logid = loghandle->lgh_id;
         body->lgd_ctxt_idx = loghandle->lgh_ctxt->loc_idx - 1;
         body->lgd_llh_flags = loghandle->lgh_hdr->llh_flags;
@@ -166,145 +164,163 @@ static int llog_client_next_block(struct llog_handle *loghandle,
         body->lgd_len = len;
         body->lgd_cur_offset = *cur_offset;
 
-        size[REPLY_REC_OFF + 1] = len;
-        ptlrpc_req_set_repsize(req, 3, size);
+        req_capsule_set_size(&req->rq_pill, &RMF_EADATA, RCL_SERVER, len);
+        ptlrpc_request_set_replen(req);
         rc = ptlrpc_queue_wait(req);
-        if (rc)
-                GOTO(out, rc);
-
-        body = lustre_swab_repbuf(req, REPLY_REC_OFF, sizeof(*body),
-                                 lustre_swab_llogd_body);
-        if (body == NULL) {
-                CERROR ("Can't unpack llogd_body\n");
-                GOTO(out, rc =-EFAULT);
-        }
+       /* -EIO has a special meaning here. If llog_osd_next_block()
+        * reaches the end of the log without finding the desired
+        * record then it updates *cur_offset and *cur_idx and returns
+        * -EIO. In llog_process_thread() we use this to detect
+        * EOF. But we must be careful to distinguish between -EIO
+        * coming from llog_osd_next_block() and -EIO coming from
+        * ptlrpc or below. */
+       if (rc == -EIO) {
+               if (req->rq_repmsg == NULL ||
+                   lustre_msg_get_status(req->rq_repmsg) != -EIO)
+                       GOTO(out, rc);
+       } else if (rc < 0) {
+               GOTO(out, rc);
+       }
+
+       body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
+       if (body == NULL)
+               GOTO(out, rc = -EFAULT);
+
+       *cur_idx = body->lgd_saved_index;
+       *cur_offset = body->lgd_cur_offset;
+
+       if (rc < 0)
+               GOTO(out, rc);
 
         /* The log records are swabbed as they are processed */
-        ptr = lustre_msg_buf(req->rq_repmsg, REPLY_REC_OFF + 1, len);
-        if (ptr == NULL) {
-                CERROR ("Can't unpack bitmap\n");
+        ptr = req_capsule_server_get(&req->rq_pill, &RMF_EADATA);
+        if (ptr == NULL)
                 GOTO(out, rc =-EFAULT);
-        }
-
-        *cur_idx = body->lgd_saved_index;
-        *cur_offset = body->lgd_cur_offset;
 
         memcpy(buf, ptr, len);
-
+        EXIT;
 out:
-        if (req)
-                ptlrpc_req_finished(req);
-        RETURN(rc);
+        ptlrpc_req_finished(req);
+err_exit:
+        LLOG_CLIENT_EXIT(loghandle->lgh_ctxt, imp);
+        return rc;
 }
 
-static int llog_client_prev_block(struct llog_handle *loghandle,
-                                  int prev_idx, void *buf, int len)
+static int llog_client_prev_block(const struct lu_env *env,
+                                 struct llog_handle *loghandle,
+                                 int prev_idx, void *buf, int len)
 {
-        struct obd_import *imp = loghandle->lgh_ctxt->loc_imp;
+        struct obd_import     *imp;
         struct ptlrpc_request *req = NULL;
-        struct llogd_body *body;
-        void * ptr;
-        int size[3] = { sizeof(struct ptlrpc_body), sizeof(*body) };
-        int rc;
+        struct llogd_body     *body;
+        void                  *ptr;
+        int                    rc;
         ENTRY;
 
-        req = ptlrpc_prep_req(imp, LUSTRE_LOG_VERSION,
-                              LLOG_ORIGIN_HANDLE_PREV_BLOCK, 2, size, NULL);
-        if (!req)
-                GOTO(out, rc = -ENOMEM);
+        LLOG_CLIENT_ENTRY(loghandle->lgh_ctxt, imp);
+        req = ptlrpc_request_alloc_pack(imp, &RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK,
+                                        LUSTRE_LOG_VERSION,
+                                        LLOG_ORIGIN_HANDLE_PREV_BLOCK);
+        if (req == NULL)
+                GOTO(err_exit, rc = -ENOMEM);
 
-        body = lustre_msg_buf(req->rq_reqmsg, REQ_REC_OFF, sizeof(*body));
+        body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
         body->lgd_logid = loghandle->lgh_id;
         body->lgd_ctxt_idx = loghandle->lgh_ctxt->loc_idx - 1;
         body->lgd_llh_flags = loghandle->lgh_hdr->llh_flags;
         body->lgd_index = prev_idx;
         body->lgd_len = len;
 
-        size[REPLY_REC_OFF + 1] = len;
-        ptlrpc_req_set_repsize(req, 3, size);
+        req_capsule_set_size(&req->rq_pill, &RMF_EADATA, RCL_SERVER, len);
+        ptlrpc_request_set_replen(req);
+
         rc = ptlrpc_queue_wait(req);
         if (rc)
                 GOTO(out, rc);
 
-        body = lustre_swab_repbuf(req, REPLY_REC_OFF, sizeof(*body),
-                                 lustre_swab_llogd_body);
-        if (body == NULL) {
-                CERROR ("Can't unpack llogd_body\n");
+        body = req_capsule_server_get(&req->rq_pill, &RMF_LLOGD_BODY);
+        if (body == NULL)
                 GOTO(out, rc =-EFAULT);
-        }
 
-        ptr = lustre_msg_buf(req->rq_repmsg, REPLY_REC_OFF + 1, len);
-        if (ptr == NULL) {
-                CERROR ("Can't unpack bitmap\n");
+        ptr = req_capsule_server_get(&req->rq_pill, &RMF_EADATA);
+        if (ptr == NULL)
                 GOTO(out, rc =-EFAULT);
-        }
 
         memcpy(buf, ptr, len);
-
+        EXIT;
 out:
-        if (req)
-                ptlrpc_req_finished(req);
-        RETURN(rc);
+        ptlrpc_req_finished(req);
+err_exit:
+        LLOG_CLIENT_EXIT(loghandle->lgh_ctxt, imp);
+        return rc;
 }
 
-static int llog_client_read_header(struct llog_handle *handle)
+static int llog_client_read_header(const struct lu_env *env,
+                                  struct llog_handle *handle)
 {
-        struct obd_import *imp = handle->lgh_ctxt->loc_imp;
+        struct obd_import     *imp;
         struct ptlrpc_request *req = NULL;
-        struct llogd_body *body;
-        struct llog_log_hdr *hdr;
-        struct llog_rec_hdr *llh_hdr;
-        int size[2] = { sizeof(struct ptlrpc_body), sizeof(*body) };
-        int repsize[2] = { sizeof(struct ptlrpc_body), sizeof(*hdr) };
-        int rc;
+        struct llogd_body     *body;
+        struct llog_log_hdr   *hdr;
+        struct llog_rec_hdr   *llh_hdr;
+        int                    rc;
         ENTRY;
 
-        req = ptlrpc_prep_req(imp, LUSTRE_LOG_VERSION,
-                              LLOG_ORIGIN_HANDLE_READ_HEADER, 2, size, NULL);
-        if (!req)
-                GOTO(out, rc = -ENOMEM);
+        LLOG_CLIENT_ENTRY(handle->lgh_ctxt, imp);
+        req = ptlrpc_request_alloc_pack(imp,&RQF_LLOG_ORIGIN_HANDLE_READ_HEADER,
+                                        LUSTRE_LOG_VERSION,
+                                        LLOG_ORIGIN_HANDLE_READ_HEADER);
+        if (req == NULL)
+                GOTO(err_exit, rc = -ENOMEM);
 
-        body = lustre_msg_buf(req->rq_reqmsg, REQ_REC_OFF, sizeof(*body));
+        body = req_capsule_client_get(&req->rq_pill, &RMF_LLOGD_BODY);
         body->lgd_logid = handle->lgh_id;
         body->lgd_ctxt_idx = handle->lgh_ctxt->loc_idx - 1;
         body->lgd_llh_flags = handle->lgh_hdr->llh_flags;
 
-        ptlrpc_req_set_repsize(req, 2, repsize);
+        ptlrpc_request_set_replen(req);
         rc = ptlrpc_queue_wait(req);
         if (rc)
                 GOTO(out, rc);
 
-        hdr = lustre_swab_repbuf(req, REPLY_REC_OFF, sizeof(*hdr),
-                                 lustre_swab_llog_hdr);
-        if (hdr == NULL) {
-                CERROR ("Can't unpack llog_hdr\n");
+        hdr = req_capsule_server_get(&req->rq_pill, &RMF_LLOG_LOG_HDR);
+        if (hdr == NULL)
                 GOTO(out, rc =-EFAULT);
-        }
-
-        memcpy(handle->lgh_hdr, hdr, sizeof (*hdr));
-        handle->lgh_last_idx = handle->lgh_hdr->llh_tail.lrt_index;
-
-        /* sanity checks */
-        llh_hdr = &handle->lgh_hdr->llh_hdr;
-        if (llh_hdr->lrh_type != LLOG_HDR_MAGIC) {
-                CERROR("bad log header magic: %#x (expecting %#x)\n",
-                       llh_hdr->lrh_type, LLOG_HDR_MAGIC);
-                rc = -EIO;
-        } else if (llh_hdr->lrh_len != LLOG_CHUNK_SIZE) {
-                CERROR("incorrectly sized log header: %#x "
-                       "(expecting %#x)\n",
-                       llh_hdr->lrh_len, LLOG_CHUNK_SIZE);
-                CERROR("you may need to re-run lconf --write_conf.\n");
-                rc = -EIO;
-        }
 
+       if (handle->lgh_hdr_size < hdr->llh_hdr.lrh_len)
+               GOTO(out, rc = -EFAULT);
+
+       memcpy(handle->lgh_hdr, hdr, hdr->llh_hdr.lrh_len);
+       handle->lgh_last_idx = LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_index;
+
+       /* sanity checks */
+       llh_hdr = &handle->lgh_hdr->llh_hdr;
+       if (llh_hdr->lrh_type != LLOG_HDR_MAGIC) {
+               CERROR("bad log header magic: %#x (expecting %#x)\n",
+                      llh_hdr->lrh_type, LLOG_HDR_MAGIC);
+               rc = -EIO;
+       } else if (llh_hdr->lrh_len !=
+                  LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_len ||
+                  (llh_hdr->lrh_len & (llh_hdr->lrh_len - 1)) != 0 ||
+                  llh_hdr->lrh_len < LLOG_MIN_CHUNK_SIZE ||
+                  llh_hdr->lrh_len > handle->lgh_hdr_size) {
+               CERROR("incorrectly sized log header: %#x, "
+                      "expecting %#x (power of two > 8192)\n",
+                      llh_hdr->lrh_len,
+                      LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_len);
+               CERROR("you may need to re-run lconf --write_conf.\n");
+               rc = -EIO;
+       }
+       EXIT;
 out:
-        if (req)
-                ptlrpc_req_finished(req);
-        RETURN(rc);
+        ptlrpc_req_finished(req);
+err_exit:
+        LLOG_CLIENT_EXIT(handle->lgh_ctxt, imp);
+        return rc;
 }
 
-static int llog_client_close(struct llog_handle *handle)
+static int llog_client_close(const struct lu_env *env,
+                            struct llog_handle *handle)
 {
         /* this doesn't call LLOG_ORIGIN_HANDLE_CLOSE because
            the servers all close the file at the end of every
@@ -312,12 +328,11 @@ static int llog_client_close(struct llog_handle *handle)
         return(0);
 }
 
-
 struct llog_operations llog_client_ops = {
-        lop_next_block:  llog_client_next_block,
-        lop_prev_block:  llog_client_prev_block,
-        lop_read_header: llog_client_read_header,
-        lop_create:      llog_client_create,
-        lop_destroy:     llog_client_destroy,
-        lop_close:       llog_client_close,
+       .lop_next_block         = llog_client_next_block,
+       .lop_prev_block         = llog_client_prev_block,
+       .lop_read_header        = llog_client_read_header,
+       .lop_open               = llog_client_open,
+       .lop_close              = llog_client_close,
 };
+EXPORT_SYMBOL(llog_client_ops);