1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/sec_bulk.c
38 * Author: Eric Mei <ericm@clusterfs.com>
44 #define DEBUG_SUBSYSTEM S_SEC
46 #include <libcfs/libcfs.h>
48 #include <liblustre.h>
49 #include <libcfs/list.h>
51 #include <linux/crypto.h>
55 #include <obd_cksum.h>
56 #include <obd_class.h>
57 #include <obd_support.h>
58 #include <lustre_net.h>
59 #include <lustre_import.h>
60 #include <lustre_dlm.h>
61 #include <lustre_sec.h>
63 #include "ptlrpc_internal.h"
65 /****************************************
66 * bulk encryption page pools *
67 ****************************************/
71 #define PTRS_PER_PAGE (CFS_PAGE_SIZE / sizeof(void *))
72 #define PAGES_PER_POOL (PTRS_PER_PAGE)
74 #define IDLE_IDX_MAX (100)
75 #define IDLE_IDX_WEIGHT (3)
77 #define CACHE_QUIESCENT_PERIOD (20)
79 static struct ptlrpc_enc_page_pool {
83 unsigned long epp_max_pages; /* maximum pages can hold, const */
84 unsigned int epp_max_pools; /* number of pools, const */
87 * wait queue in case of not enough free pages.
89 cfs_waitq_t epp_waitq; /* waiting threads */
90 unsigned int epp_waitqlen; /* wait queue length */
91 unsigned long epp_pages_short; /* # of pages wanted of in-q users */
92 unsigned int epp_growing:1; /* during adding pages */
95 * indicating how idle the pools are, from 0 to MAX_IDLE_IDX
96 * this is counted based on each time when getting pages from
97 * the pools, not based on time. which means in case that system
98 * is idled for a while but the idle_idx might still be low if no
99 * activities happened in the pools.
101 unsigned long epp_idle_idx;
103 /* last shrink time due to mem tight */
104 long epp_last_shrink;
105 long epp_last_access;
108 * in-pool pages bookkeeping
110 cfs_spinlock_t epp_lock; /* protect following fields */
111 unsigned long epp_total_pages; /* total pages in pools */
112 unsigned long epp_free_pages; /* current pages available */
117 unsigned long epp_st_max_pages; /* # of pages ever reached */
118 unsigned int epp_st_grows; /* # of grows */
119 unsigned int epp_st_grow_fails; /* # of add pages failures */
120 unsigned int epp_st_shrinks; /* # of shrinks */
121 unsigned long epp_st_access; /* # of access */
122 unsigned long epp_st_missings; /* # of cache missing */
123 unsigned long epp_st_lowfree; /* lowest free pages reached */
124 unsigned int epp_st_max_wqlen; /* highest waitqueue length */
125 cfs_time_t epp_st_max_wait; /* in jeffies */
129 cfs_page_t ***epp_pools;
135 const int pools_shrinker_seeks = CFS_DEFAULT_SEEKS;
136 static struct cfs_shrinker *pools_shrinker = NULL;
140 * /proc/fs/lustre/sptlrpc/encrypt_page_pools
142 int sptlrpc_proc_read_enc_pool(char *page, char **start, off_t off, int count,
143 int *eof, void *data)
147 cfs_spin_lock(&page_pools.epp_lock);
149 rc = snprintf(page, count,
150 "physical pages: %lu\n"
151 "pages per pool: %lu\n"
156 "idle index: %lu/100\n"
157 "last shrink: %lds\n"
158 "last access: %lds\n"
159 "max pages reached: %lu\n"
161 "grows failure: %u\n"
163 "cache access: %lu\n"
164 "cache missing: %lu\n"
165 "low free mark: %lu\n"
166 "max waitqueue depth: %u\n"
167 "max wait time: "CFS_TIME_T"/%u\n"
171 page_pools.epp_max_pages,
172 page_pools.epp_max_pools,
173 page_pools.epp_total_pages,
174 page_pools.epp_free_pages,
175 page_pools.epp_idle_idx,
176 cfs_time_current_sec() - page_pools.epp_last_shrink,
177 cfs_time_current_sec() - page_pools.epp_last_access,
178 page_pools.epp_st_max_pages,
179 page_pools.epp_st_grows,
180 page_pools.epp_st_grow_fails,
181 page_pools.epp_st_shrinks,
182 page_pools.epp_st_access,
183 page_pools.epp_st_missings,
184 page_pools.epp_st_lowfree,
185 page_pools.epp_st_max_wqlen,
186 page_pools.epp_st_max_wait, CFS_HZ
189 cfs_spin_unlock(&page_pools.epp_lock);
193 static void enc_pools_release_free_pages(long npages)
196 int p_idx_max1, p_idx_max2;
199 LASSERT(npages <= page_pools.epp_free_pages);
200 LASSERT(page_pools.epp_free_pages <= page_pools.epp_total_pages);
202 /* max pool index before the release */
203 p_idx_max2 = (page_pools.epp_total_pages - 1) / PAGES_PER_POOL;
205 page_pools.epp_free_pages -= npages;
206 page_pools.epp_total_pages -= npages;
208 /* max pool index after the release */
209 p_idx_max1 = page_pools.epp_total_pages == 0 ? -1 :
210 ((page_pools.epp_total_pages - 1) / PAGES_PER_POOL);
212 p_idx = page_pools.epp_free_pages / PAGES_PER_POOL;
213 g_idx = page_pools.epp_free_pages % PAGES_PER_POOL;
214 LASSERT(page_pools.epp_pools[p_idx]);
217 LASSERT(page_pools.epp_pools[p_idx]);
218 LASSERT(page_pools.epp_pools[p_idx][g_idx] != NULL);
220 cfs_free_page(page_pools.epp_pools[p_idx][g_idx]);
221 page_pools.epp_pools[p_idx][g_idx] = NULL;
223 if (++g_idx == PAGES_PER_POOL) {
229 /* free unused pools */
230 while (p_idx_max1 < p_idx_max2) {
231 LASSERT(page_pools.epp_pools[p_idx_max2]);
232 OBD_FREE(page_pools.epp_pools[p_idx_max2], CFS_PAGE_SIZE);
233 page_pools.epp_pools[p_idx_max2] = NULL;
239 * could be called frequently for query (@nr_to_scan == 0).
240 * we try to keep at least PTLRPC_MAX_BRW_PAGES pages in the pool.
242 static int enc_pools_shrink(SHRINKER_ARGS(sc, nr_to_scan, gfp_mask))
244 if (unlikely(shrink_param(sc, nr_to_scan) != 0)) {
245 cfs_spin_lock(&page_pools.epp_lock);
246 shrink_param(sc, nr_to_scan) = min_t(unsigned long,
247 shrink_param(sc, nr_to_scan),
248 page_pools.epp_free_pages -
249 PTLRPC_MAX_BRW_PAGES);
250 if (shrink_param(sc, nr_to_scan) > 0) {
251 enc_pools_release_free_pages(shrink_param(sc,
253 CDEBUG(D_SEC, "released %ld pages, %ld left\n",
254 (long)shrink_param(sc, nr_to_scan),
255 page_pools.epp_free_pages);
257 page_pools.epp_st_shrinks++;
258 page_pools.epp_last_shrink = cfs_time_current_sec();
260 cfs_spin_unlock(&page_pools.epp_lock);
264 * if no pool access for a long time, we consider it's fully idle.
265 * a little race here is fine.
267 if (unlikely(cfs_time_current_sec() - page_pools.epp_last_access >
268 CACHE_QUIESCENT_PERIOD)) {
269 cfs_spin_lock(&page_pools.epp_lock);
270 page_pools.epp_idle_idx = IDLE_IDX_MAX;
271 cfs_spin_unlock(&page_pools.epp_lock);
274 LASSERT(page_pools.epp_idle_idx <= IDLE_IDX_MAX);
275 return max((int) page_pools.epp_free_pages - PTLRPC_MAX_BRW_PAGES, 0) *
276 (IDLE_IDX_MAX - page_pools.epp_idle_idx) / IDLE_IDX_MAX;
280 int npages_to_npools(unsigned long npages)
282 return (int) ((npages + PAGES_PER_POOL - 1) / PAGES_PER_POOL);
286 * return how many pages cleaned up.
288 static unsigned long enc_pools_cleanup(cfs_page_t ***pools, int npools)
290 unsigned long cleaned = 0;
293 for (i = 0; i < npools; i++) {
295 for (j = 0; j < PAGES_PER_POOL; j++) {
297 cfs_free_page(pools[i][j]);
301 OBD_FREE(pools[i], CFS_PAGE_SIZE);
310 * merge @npools pointed by @pools which contains @npages new pages
311 * into current pools.
313 * we have options to avoid most memory copy with some tricks. but we choose
314 * the simplest way to avoid complexity. It's not frequently called.
316 static void enc_pools_insert(cfs_page_t ***pools, int npools, int npages)
319 int op_idx, np_idx, og_idx, ng_idx;
320 int cur_npools, end_npools;
323 LASSERT(page_pools.epp_total_pages+npages <= page_pools.epp_max_pages);
324 LASSERT(npages_to_npools(npages) == npools);
325 LASSERT(page_pools.epp_growing);
327 cfs_spin_lock(&page_pools.epp_lock);
330 * (1) fill all the free slots of current pools.
332 /* free slots are those left by rent pages, and the extra ones with
333 * index >= total_pages, locate at the tail of last pool. */
334 freeslot = page_pools.epp_total_pages % PAGES_PER_POOL;
336 freeslot = PAGES_PER_POOL - freeslot;
337 freeslot += page_pools.epp_total_pages - page_pools.epp_free_pages;
339 op_idx = page_pools.epp_free_pages / PAGES_PER_POOL;
340 og_idx = page_pools.epp_free_pages % PAGES_PER_POOL;
342 ng_idx = (npages - 1) % PAGES_PER_POOL;
345 LASSERT(page_pools.epp_pools[op_idx][og_idx] == NULL);
346 LASSERT(pools[np_idx][ng_idx] != NULL);
348 page_pools.epp_pools[op_idx][og_idx] = pools[np_idx][ng_idx];
349 pools[np_idx][ng_idx] = NULL;
353 if (++og_idx == PAGES_PER_POOL) {
361 ng_idx = PAGES_PER_POOL - 1;
366 * (2) add pools if needed.
368 cur_npools = (page_pools.epp_total_pages + PAGES_PER_POOL - 1) /
370 end_npools = (page_pools.epp_total_pages + npages + PAGES_PER_POOL -1) /
372 LASSERT(end_npools <= page_pools.epp_max_pools);
375 while (cur_npools < end_npools) {
376 LASSERT(page_pools.epp_pools[cur_npools] == NULL);
377 LASSERT(np_idx < npools);
378 LASSERT(pools[np_idx] != NULL);
380 page_pools.epp_pools[cur_npools++] = pools[np_idx];
381 pools[np_idx++] = NULL;
384 page_pools.epp_total_pages += npages;
385 page_pools.epp_free_pages += npages;
386 page_pools.epp_st_lowfree = page_pools.epp_free_pages;
388 if (page_pools.epp_total_pages > page_pools.epp_st_max_pages)
389 page_pools.epp_st_max_pages = page_pools.epp_total_pages;
391 CDEBUG(D_SEC, "add %d pages to total %lu\n", npages,
392 page_pools.epp_total_pages);
394 cfs_spin_unlock(&page_pools.epp_lock);
397 static int enc_pools_add_pages(int npages)
399 static CFS_DECLARE_MUTEX(sem_add_pages);
401 int npools, alloced = 0;
402 int i, j, rc = -ENOMEM;
404 if (npages < PTLRPC_MAX_BRW_PAGES)
405 npages = PTLRPC_MAX_BRW_PAGES;
407 cfs_down(&sem_add_pages);
409 if (npages + page_pools.epp_total_pages > page_pools.epp_max_pages)
410 npages = page_pools.epp_max_pages - page_pools.epp_total_pages;
413 page_pools.epp_st_grows++;
415 npools = npages_to_npools(npages);
416 OBD_ALLOC(pools, npools * sizeof(*pools));
420 for (i = 0; i < npools; i++) {
421 OBD_ALLOC(pools[i], CFS_PAGE_SIZE);
422 if (pools[i] == NULL)
425 for (j = 0; j < PAGES_PER_POOL && alloced < npages; j++) {
426 pools[i][j] = cfs_alloc_page(CFS_ALLOC_IO |
428 if (pools[i][j] == NULL)
434 LASSERT(alloced == npages);
436 enc_pools_insert(pools, npools, npages);
437 CDEBUG(D_SEC, "added %d pages into pools\n", npages);
441 enc_pools_cleanup(pools, npools);
442 OBD_FREE(pools, npools * sizeof(*pools));
445 page_pools.epp_st_grow_fails++;
446 CERROR("Failed to allocate %d enc pages\n", npages);
449 cfs_up(&sem_add_pages);
453 static inline void enc_pools_wakeup(void)
455 LASSERT_SPIN_LOCKED(&page_pools.epp_lock);
456 LASSERT(page_pools.epp_waitqlen >= 0);
458 if (unlikely(page_pools.epp_waitqlen)) {
459 LASSERT(cfs_waitq_active(&page_pools.epp_waitq));
460 cfs_waitq_broadcast(&page_pools.epp_waitq);
464 static int enc_pools_should_grow(int page_needed, long now)
466 /* don't grow if someone else is growing the pools right now,
467 * or the pools has reached its full capacity
469 if (page_pools.epp_growing ||
470 page_pools.epp_total_pages == page_pools.epp_max_pages)
473 /* if total pages is not enough, we need to grow */
474 if (page_pools.epp_total_pages < page_needed)
478 * we wanted to return 0 here if there was a shrink just happened
479 * moment ago, but this may cause deadlock if both client and ost
480 * live on single node.
483 if (now - page_pools.epp_last_shrink < 2)
488 * here we perhaps need consider other factors like wait queue
489 * length, idle index, etc. ?
492 /* grow the pools in any other cases */
497 * we allocate the requested pages atomically.
499 int sptlrpc_enc_pool_get_pages(struct ptlrpc_bulk_desc *desc)
501 cfs_waitlink_t waitlink;
502 unsigned long this_idle = -1;
508 LASSERT(desc->bd_iov_count > 0);
509 LASSERT(desc->bd_iov_count <= page_pools.epp_max_pages);
511 /* resent bulk, enc iov might have been allocated previously */
512 if (desc->bd_enc_iov != NULL)
515 OBD_ALLOC(desc->bd_enc_iov,
516 desc->bd_iov_count * sizeof(*desc->bd_enc_iov));
517 if (desc->bd_enc_iov == NULL)
520 cfs_spin_lock(&page_pools.epp_lock);
522 page_pools.epp_st_access++;
524 if (unlikely(page_pools.epp_free_pages < desc->bd_iov_count)) {
526 tick = cfs_time_current();
528 now = cfs_time_current_sec();
530 page_pools.epp_st_missings++;
531 page_pools.epp_pages_short += desc->bd_iov_count;
533 if (enc_pools_should_grow(desc->bd_iov_count, now)) {
534 page_pools.epp_growing = 1;
536 cfs_spin_unlock(&page_pools.epp_lock);
537 enc_pools_add_pages(page_pools.epp_pages_short / 2);
538 cfs_spin_lock(&page_pools.epp_lock);
540 page_pools.epp_growing = 0;
544 if (++page_pools.epp_waitqlen >
545 page_pools.epp_st_max_wqlen)
546 page_pools.epp_st_max_wqlen =
547 page_pools.epp_waitqlen;
549 cfs_set_current_state(CFS_TASK_UNINT);
550 cfs_waitlink_init(&waitlink);
551 cfs_waitq_add(&page_pools.epp_waitq, &waitlink);
553 cfs_spin_unlock(&page_pools.epp_lock);
554 cfs_waitq_wait(&waitlink, CFS_TASK_UNINT);
555 cfs_waitq_del(&page_pools.epp_waitq, &waitlink);
556 LASSERT(page_pools.epp_waitqlen > 0);
557 cfs_spin_lock(&page_pools.epp_lock);
558 page_pools.epp_waitqlen--;
561 LASSERT(page_pools.epp_pages_short >= desc->bd_iov_count);
562 page_pools.epp_pages_short -= desc->bd_iov_count;
568 /* record max wait time */
569 if (unlikely(tick != 0)) {
570 tick = cfs_time_current() - tick;
571 if (tick > page_pools.epp_st_max_wait)
572 page_pools.epp_st_max_wait = tick;
575 /* proceed with rest of allocation */
576 page_pools.epp_free_pages -= desc->bd_iov_count;
578 p_idx = page_pools.epp_free_pages / PAGES_PER_POOL;
579 g_idx = page_pools.epp_free_pages % PAGES_PER_POOL;
581 for (i = 0; i < desc->bd_iov_count; i++) {
582 LASSERT(page_pools.epp_pools[p_idx][g_idx] != NULL);
583 desc->bd_enc_iov[i].kiov_page =
584 page_pools.epp_pools[p_idx][g_idx];
585 page_pools.epp_pools[p_idx][g_idx] = NULL;
587 if (++g_idx == PAGES_PER_POOL) {
593 if (page_pools.epp_free_pages < page_pools.epp_st_lowfree)
594 page_pools.epp_st_lowfree = page_pools.epp_free_pages;
597 * new idle index = (old * weight + new) / (weight + 1)
599 if (this_idle == -1) {
600 this_idle = page_pools.epp_free_pages * IDLE_IDX_MAX /
601 page_pools.epp_total_pages;
603 page_pools.epp_idle_idx = (page_pools.epp_idle_idx * IDLE_IDX_WEIGHT +
605 (IDLE_IDX_WEIGHT + 1);
607 page_pools.epp_last_access = cfs_time_current_sec();
609 cfs_spin_unlock(&page_pools.epp_lock);
612 EXPORT_SYMBOL(sptlrpc_enc_pool_get_pages);
614 void sptlrpc_enc_pool_put_pages(struct ptlrpc_bulk_desc *desc)
619 if (desc->bd_enc_iov == NULL)
622 LASSERT(desc->bd_iov_count > 0);
624 cfs_spin_lock(&page_pools.epp_lock);
626 p_idx = page_pools.epp_free_pages / PAGES_PER_POOL;
627 g_idx = page_pools.epp_free_pages % PAGES_PER_POOL;
629 LASSERT(page_pools.epp_free_pages + desc->bd_iov_count <=
630 page_pools.epp_total_pages);
631 LASSERT(page_pools.epp_pools[p_idx]);
633 for (i = 0; i < desc->bd_iov_count; i++) {
634 LASSERT(desc->bd_enc_iov[i].kiov_page != NULL);
635 LASSERT(g_idx != 0 || page_pools.epp_pools[p_idx]);
636 LASSERT(page_pools.epp_pools[p_idx][g_idx] == NULL);
638 page_pools.epp_pools[p_idx][g_idx] =
639 desc->bd_enc_iov[i].kiov_page;
641 if (++g_idx == PAGES_PER_POOL) {
647 page_pools.epp_free_pages += desc->bd_iov_count;
651 cfs_spin_unlock(&page_pools.epp_lock);
653 OBD_FREE(desc->bd_enc_iov,
654 desc->bd_iov_count * sizeof(*desc->bd_enc_iov));
655 desc->bd_enc_iov = NULL;
657 EXPORT_SYMBOL(sptlrpc_enc_pool_put_pages);
660 * we don't do much stuff for add_user/del_user anymore, except adding some
661 * initial pages in add_user() if current pools are empty, rest would be
662 * handled by the pools's self-adaption.
664 int sptlrpc_enc_pool_add_user(void)
668 cfs_spin_lock(&page_pools.epp_lock);
669 if (page_pools.epp_growing == 0 && page_pools.epp_total_pages == 0) {
670 page_pools.epp_growing = 1;
673 cfs_spin_unlock(&page_pools.epp_lock);
676 enc_pools_add_pages(PTLRPC_MAX_BRW_PAGES +
677 PTLRPC_MAX_BRW_PAGES);
679 cfs_spin_lock(&page_pools.epp_lock);
680 page_pools.epp_growing = 0;
682 cfs_spin_unlock(&page_pools.epp_lock);
686 EXPORT_SYMBOL(sptlrpc_enc_pool_add_user);
688 int sptlrpc_enc_pool_del_user(void)
692 EXPORT_SYMBOL(sptlrpc_enc_pool_del_user);
694 static inline void enc_pools_alloc(void)
696 LASSERT(page_pools.epp_max_pools);
697 OBD_ALLOC_LARGE(page_pools.epp_pools,
698 page_pools.epp_max_pools *
699 sizeof(*page_pools.epp_pools));
702 static inline void enc_pools_free(void)
704 LASSERT(page_pools.epp_max_pools);
705 LASSERT(page_pools.epp_pools);
707 OBD_FREE_LARGE(page_pools.epp_pools,
708 page_pools.epp_max_pools *
709 sizeof(*page_pools.epp_pools));
712 int sptlrpc_enc_pool_init(void)
715 * maximum capacity is 1/8 of total physical memory.
716 * is the 1/8 a good number?
718 page_pools.epp_max_pages = cfs_num_physpages / 8;
719 page_pools.epp_max_pools = npages_to_npools(page_pools.epp_max_pages);
721 cfs_waitq_init(&page_pools.epp_waitq);
722 page_pools.epp_waitqlen = 0;
723 page_pools.epp_pages_short = 0;
725 page_pools.epp_growing = 0;
727 page_pools.epp_idle_idx = 0;
728 page_pools.epp_last_shrink = cfs_time_current_sec();
729 page_pools.epp_last_access = cfs_time_current_sec();
731 cfs_spin_lock_init(&page_pools.epp_lock);
732 page_pools.epp_total_pages = 0;
733 page_pools.epp_free_pages = 0;
735 page_pools.epp_st_max_pages = 0;
736 page_pools.epp_st_grows = 0;
737 page_pools.epp_st_grow_fails = 0;
738 page_pools.epp_st_shrinks = 0;
739 page_pools.epp_st_access = 0;
740 page_pools.epp_st_missings = 0;
741 page_pools.epp_st_lowfree = 0;
742 page_pools.epp_st_max_wqlen = 0;
743 page_pools.epp_st_max_wait = 0;
746 if (page_pools.epp_pools == NULL)
749 pools_shrinker = cfs_set_shrinker(pools_shrinker_seeks,
751 if (pools_shrinker == NULL) {
759 void sptlrpc_enc_pool_fini(void)
761 unsigned long cleaned, npools;
763 LASSERT(pools_shrinker);
764 LASSERT(page_pools.epp_pools);
765 LASSERT(page_pools.epp_total_pages == page_pools.epp_free_pages);
767 cfs_remove_shrinker(pools_shrinker);
769 npools = npages_to_npools(page_pools.epp_total_pages);
770 cleaned = enc_pools_cleanup(page_pools.epp_pools, npools);
771 LASSERT(cleaned == page_pools.epp_total_pages);
775 if (page_pools.epp_st_access > 0) {
776 CWARN("max pages %lu, grows %u, grow fails %u, shrinks %u, "
777 "access %lu, missing %lu, max qlen %u, max wait "
779 page_pools.epp_st_max_pages, page_pools.epp_st_grows,
780 page_pools.epp_st_grow_fails,
781 page_pools.epp_st_shrinks, page_pools.epp_st_access,
782 page_pools.epp_st_missings, page_pools.epp_st_max_wqlen,
783 page_pools.epp_st_max_wait, CFS_HZ);
787 #else /* !__KERNEL__ */
789 int sptlrpc_enc_pool_get_pages(struct ptlrpc_bulk_desc *desc)
794 void sptlrpc_enc_pool_put_pages(struct ptlrpc_bulk_desc *desc)
798 int sptlrpc_enc_pool_init(void)
803 void sptlrpc_enc_pool_fini(void)
808 /****************************************
809 * Helpers to assist policy modules to *
810 * implement checksum funcationality *
811 ****************************************/
813 static struct sptlrpc_hash_type hash_types[] = {
814 [BULK_HASH_ALG_NULL] = { "null", "null", 0 },
815 [BULK_HASH_ALG_ADLER32] = { "adler32", "adler32", 4 },
816 [BULK_HASH_ALG_CRC32] = { "crc32", "crc32", 4 },
817 [BULK_HASH_ALG_MD5] = { "md5", "md5", 16 },
818 [BULK_HASH_ALG_SHA1] = { "sha1", "sha1", 20 },
819 [BULK_HASH_ALG_SHA256] = { "sha256", "sha256", 32 },
820 [BULK_HASH_ALG_SHA384] = { "sha384", "sha384", 48 },
821 [BULK_HASH_ALG_SHA512] = { "sha512", "sha512", 64 },
824 const struct sptlrpc_hash_type *sptlrpc_get_hash_type(__u8 hash_alg)
826 struct sptlrpc_hash_type *ht;
828 if (hash_alg < BULK_HASH_ALG_MAX) {
829 ht = &hash_types[hash_alg];
830 if (ht->sht_tfm_name)
835 EXPORT_SYMBOL(sptlrpc_get_hash_type);
837 const char * sptlrpc_get_hash_name(__u8 hash_alg)
839 const struct sptlrpc_hash_type *ht;
841 ht = sptlrpc_get_hash_type(hash_alg);
847 EXPORT_SYMBOL(sptlrpc_get_hash_name);
849 __u8 sptlrpc_get_hash_alg(const char *algname)
853 for (i = 0; i < BULK_HASH_ALG_MAX; i++)
854 if (!strcmp(hash_types[i].sht_name, algname))
858 EXPORT_SYMBOL(sptlrpc_get_hash_alg);
860 int bulk_sec_desc_unpack(struct lustre_msg *msg, int offset, int swabbed)
862 struct ptlrpc_bulk_sec_desc *bsd;
863 int size = msg->lm_buflens[offset];
865 bsd = lustre_msg_buf(msg, offset, sizeof(*bsd));
867 CERROR("Invalid bulk sec desc: size %d\n", size);
872 __swab32s(&bsd->bsd_nob);
875 if (unlikely(bsd->bsd_version != 0)) {
876 CERROR("Unexpected version %u\n", bsd->bsd_version);
880 if (unlikely(bsd->bsd_type >= SPTLRPC_BULK_MAX)) {
881 CERROR("Invalid type %u\n", bsd->bsd_type);
885 /* FIXME more sanity check here */
887 if (unlikely(bsd->bsd_svc != SPTLRPC_BULK_SVC_NULL &&
888 bsd->bsd_svc != SPTLRPC_BULK_SVC_INTG &&
889 bsd->bsd_svc != SPTLRPC_BULK_SVC_PRIV)) {
890 CERROR("Invalid svc %u\n", bsd->bsd_svc);
896 EXPORT_SYMBOL(bulk_sec_desc_unpack);
901 static int do_bulk_checksum_adler32(struct ptlrpc_bulk_desc *desc, void *buf)
909 for (i = 0; i < desc->bd_iov_count; i++) {
910 page = desc->bd_iov[i].kiov_page;
911 off = desc->bd_iov[i].kiov_offset & ~CFS_PAGE_MASK;
912 ptr = cfs_kmap(page) + off;
913 len = desc->bd_iov[i].kiov_len;
915 adler32 = adler32(adler32, ptr, len);
920 adler32 = cpu_to_le32(adler32);
921 memcpy(buf, &adler32, sizeof(adler32));
926 static int do_bulk_checksum_crc32(struct ptlrpc_bulk_desc *desc, void *buf)
934 for (i = 0; i < desc->bd_iov_count; i++) {
935 page = desc->bd_iov[i].kiov_page;
936 off = desc->bd_iov[i].kiov_offset & ~CFS_PAGE_MASK;
937 ptr = cfs_kmap(page) + off;
938 len = desc->bd_iov[i].kiov_len;
940 crc32 = crc32_le(crc32, ptr, len);
945 crc32 = cpu_to_le32(crc32);
946 memcpy(buf, &crc32, sizeof(crc32));
950 int sptlrpc_get_bulk_checksum(struct ptlrpc_bulk_desc *desc, __u8 alg,
951 void *buf, int buflen)
953 struct hash_desc hdesc;
956 struct scatterlist sl;
959 LASSERT(alg > BULK_HASH_ALG_NULL && alg < BULK_HASH_ALG_MAX);
960 LASSERT(buflen >= 4);
963 case BULK_HASH_ALG_ADLER32:
965 return do_bulk_checksum_adler32(desc, buf);
967 CERROR("Adler32 not supported\n");
970 case BULK_HASH_ALG_CRC32:
971 return do_bulk_checksum_crc32(desc, buf);
974 hdesc.tfm = ll_crypto_alloc_hash(hash_types[alg].sht_tfm_name, 0, 0);
975 if (hdesc.tfm == NULL) {
976 CERROR("Unable to allocate TFM %s\n", hash_types[alg].sht_name);
981 ll_crypto_hash_init(&hdesc);
983 hashsize = ll_crypto_hash_digestsize(hdesc.tfm);
985 for (i = 0; i < desc->bd_iov_count; i++) {
986 sg_set_page(&sl, desc->bd_iov[i].kiov_page,
987 desc->bd_iov[i].kiov_len,
988 desc->bd_iov[i].kiov_offset & ~CFS_PAGE_MASK);
989 ll_crypto_hash_update(&hdesc, &sl, sl.length);
992 if (hashsize > buflen) {
993 ll_crypto_hash_final(&hdesc, hashbuf);
994 memcpy(buf, hashbuf, buflen);
996 ll_crypto_hash_final(&hdesc, buf);
999 ll_crypto_free_hash(hdesc.tfm);
1002 EXPORT_SYMBOL(sptlrpc_get_bulk_checksum);
1004 #else /* !__KERNEL__ */
1006 int sptlrpc_get_bulk_checksum(struct ptlrpc_bulk_desc *desc, __u8 alg,
1007 void *buf, int buflen)
1012 LASSERT(alg == BULK_HASH_ALG_ADLER32 || alg == BULK_HASH_ALG_CRC32);
1014 if (alg == BULK_HASH_ALG_ADLER32)
1019 for (i = 0; i < desc->bd_iov_count; i++) {
1020 unsigned char *ptr = desc->bd_iov[i].iov_base;
1021 int len = desc->bd_iov[i].iov_len;
1024 case BULK_HASH_ALG_ADLER32:
1026 csum32 = adler32(csum32, ptr, len);
1028 CERROR("Adler32 not supported\n");
1032 case BULK_HASH_ALG_CRC32:
1033 csum32 = crc32_le(csum32, ptr, len);
1038 csum32 = cpu_to_le32(csum32);
1039 memcpy(buf, &csum32, sizeof(csum32));
1043 #endif /* __KERNEL__ */