1 /* $FreeBSD: src/sys/opencrypto/crypto.c,v 1.28 2007/10/20 23:23:22 julian Exp $ */
3 * Copyright (c) 2002-2006 Sam Leffler. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 * Cryptographic Subsystem.
29 * This code is derived from the Openbsd Cryptographic Framework (OCF)
30 * that has the copyright shown below. Very little of the original
35 * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu)
37 * This code was written by Angelos D. Keromytis in Athens, Greece, in
38 * February 2000. Network Security Technologies Inc. (NSTI) kindly
39 * supported the development of this code.
41 * Copyright (c) 2000, 2001 Angelos D. Keromytis
43 * Permission to use, copy, and modify this software with or without fee
44 * is hereby granted, provided that this entire notice is included in
45 * all source code copies of any software which is or includes a copy or
46 * modification of this software.
48 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
49 * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
50 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
51 * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
55 #define CRYPTO_TIMING /* enable timing support */
59 #include <sys/param.h>
60 #include <sys/systm.h>
61 #include <sys/eventhandler.h>
62 #include <sys/kernel.h>
63 #include <sys/kthread.h>
65 #include <sys/module.h>
66 #include <sys/malloc.h>
68 #include <sys/sysctl.h>
69 #include <sys/thread2.h>
70 #include <sys/mplock2.h>
72 #include <vm/vm_zone.h>
76 #include <opencrypto/cryptodev.h>
77 #include <opencrypto/xform.h> /* XXX for M_XDATA */
81 #include "cryptodev_if.h"
84 * Crypto drivers register themselves by allocating a slot in the
85 * crypto_drivers table with crypto_get_driverid() and then registering
86 * each algorithm they support with crypto_register() and crypto_kregister().
88 static struct lock crypto_drivers_lock; /* lock on driver table */
89 #define CRYPTO_DRIVER_LOCK() lockmgr(&crypto_drivers_lock, LK_EXCLUSIVE)
90 #define CRYPTO_DRIVER_UNLOCK() lockmgr(&crypto_drivers_lock, LK_RELEASE)
91 #define CRYPTO_DRIVER_ASSERT() KKASSERT(lockstatus(&crypto_drivers_lock, curthread) != 0)
94 * Crypto device/driver capabilities structure.
97 * (d) - protected by CRYPTO_DRIVER_LOCK()
98 * (q) - protected by CRYPTO_Q_LOCK()
99 * Not tagged fields are read-only.
102 device_t cc_dev; /* (d) device/driver */
103 u_int32_t cc_sessions; /* (d) # of sessions */
104 u_int32_t cc_koperations; /* (d) # os asym operations */
106 * Largest possible operator length (in bits) for each type of
107 * encryption algorithm. XXX not used
109 u_int16_t cc_max_op_len[CRYPTO_ALGORITHM_MAX + 1];
110 u_int8_t cc_alg[CRYPTO_ALGORITHM_MAX + 1];
111 u_int8_t cc_kalg[CRK_ALGORITHM_MAX + 1];
113 int cc_flags; /* (d) flags */
114 #define CRYPTOCAP_F_CLEANUP 0x80000000 /* needs resource cleanup */
115 int cc_qblocked; /* (q) symmetric q blocked */
116 int cc_kqblocked; /* (q) asymmetric q blocked */
118 static struct cryptocap *crypto_drivers = NULL;
119 static int crypto_drivers_num = 0;
121 typedef struct crypto_tdinfo {
122 TAILQ_HEAD(,cryptop) crp_q; /* request queues */
123 TAILQ_HEAD(,cryptkop) crp_kq;
125 struct lock crp_lock;
130 * There are two queues for crypto requests; one for symmetric (e.g.
131 * cipher) operations and one for asymmetric (e.g. MOD) operations.
132 * See below for how synchronization is handled.
133 * A single lock is used to lock access to both queues. We could
134 * have one per-queue but having one simplifies handling of block/unblock
137 static struct crypto_tdinfo tdinfo_array[MAXCPU];
139 #define CRYPTO_Q_LOCK(tdinfo) lockmgr(&tdinfo->crp_lock, LK_EXCLUSIVE)
140 #define CRYPTO_Q_UNLOCK(tdinfo) lockmgr(&tdinfo->crp_lock, LK_RELEASE)
143 * There are two queues for processing completed crypto requests; one
144 * for the symmetric and one for the asymmetric ops. We only need one
145 * but have two to avoid type futzing (cryptop vs. cryptkop). A single
146 * lock is used to lock access to both queues. Note that this lock
147 * must be separate from the lock on request queues to insure driver
148 * callbacks don't generate lock order reversals.
150 static TAILQ_HEAD(,cryptop) crp_ret_q; /* callback queues */
151 static TAILQ_HEAD(,cryptkop) crp_ret_kq;
152 static struct lock crypto_ret_q_lock;
153 #define CRYPTO_RETQ_LOCK() lockmgr(&crypto_ret_q_lock, LK_EXCLUSIVE)
154 #define CRYPTO_RETQ_UNLOCK() lockmgr(&crypto_ret_q_lock, LK_RELEASE)
155 #define CRYPTO_RETQ_EMPTY() (TAILQ_EMPTY(&crp_ret_q) && TAILQ_EMPTY(&crp_ret_kq))
158 * Crypto op and desciptor data structures are allocated
159 * from separate private zones.
161 static vm_zone_t cryptop_zone;
162 static vm_zone_t cryptodesc_zone;
164 int crypto_userasymcrypto = 1; /* userland may do asym crypto reqs */
165 SYSCTL_INT(_kern, OID_AUTO, userasymcrypto, CTLFLAG_RW,
166 &crypto_userasymcrypto, 0,
167 "Enable/disable user-mode access to asymmetric crypto support");
168 int crypto_devallowsoft = 0; /* only use hardware crypto for asym */
169 SYSCTL_INT(_kern, OID_AUTO, cryptodevallowsoft, CTLFLAG_RW,
170 &crypto_devallowsoft, 0,
171 "Enable/disable use of software asym crypto support");
173 MALLOC_DEFINE(M_CRYPTO_DATA, "crypto", "crypto session records");
175 static void crypto_proc(void *dummy);
176 static void crypto_ret_proc(void *dummy);
177 static struct thread *cryptoretthread;
178 static void crypto_destroy(void);
179 static int crypto_invoke(struct cryptocap *cap, struct cryptop *crp, int hint);
180 static int crypto_kinvoke(struct cryptkop *krp, int flags);
182 static struct cryptostats cryptostats;
183 SYSCTL_STRUCT(_kern, OID_AUTO, crypto_stats, CTLFLAG_RW, &cryptostats,
184 cryptostats, "Crypto system statistics");
187 static int crypto_timing = 0;
188 SYSCTL_INT(_debug, OID_AUTO, crypto_timing, CTLFLAG_RW,
189 &crypto_timing, 0, "Enable/disable crypto timing support");
195 crypto_tdinfo_t tdinfo;
199 lockinit(&crypto_drivers_lock, "crypto driver table", 0, LK_CANRECURSE);
201 TAILQ_INIT(&crp_ret_q);
202 TAILQ_INIT(&crp_ret_kq);
203 lockinit(&crypto_ret_q_lock, "crypto return queues", 0, LK_CANRECURSE);
205 cryptop_zone = zinit("cryptop", sizeof (struct cryptop), 0, 0, 1);
206 cryptodesc_zone = zinit("cryptodesc", sizeof (struct cryptodesc),
208 if (cryptodesc_zone == NULL || cryptop_zone == NULL) {
209 kprintf("crypto_init: cannot setup crypto zones\n");
214 crypto_drivers_num = CRYPTO_DRIVERS_INITIAL;
215 crypto_drivers = kmalloc(crypto_drivers_num * sizeof(struct cryptocap),
216 M_CRYPTO_DATA, M_WAITOK | M_ZERO);
217 if (crypto_drivers == NULL) {
218 kprintf("crypto_init: cannot malloc driver table\n");
223 for (n = 0; n < ncpus; ++n) {
224 tdinfo = &tdinfo_array[n];
225 TAILQ_INIT(&tdinfo->crp_q);
226 TAILQ_INIT(&tdinfo->crp_kq);
227 lockinit(&tdinfo->crp_lock, "crypto op queues",
229 kthread_create_cpu(crypto_proc, tdinfo, &tdinfo->crp_td,
232 kthread_create(crypto_ret_proc, NULL,
233 &cryptoretthread, "crypto returns");
241 * Signal a crypto thread to terminate. We use the driver
242 * table lock to synchronize the sleep/wakeups so that we
243 * are sure the threads have terminated before we release
244 * the data structures they use. See crypto_finis below
245 * for the other half of this song-and-dance.
248 crypto_terminate(struct thread **tp, void *q)
252 KKASSERT(lockstatus(&crypto_drivers_lock, curthread) != 0);
256 kprintf("crypto_terminate: start\n");
259 tsleep_interlock(t, 0);
260 CRYPTO_DRIVER_UNLOCK(); /* let crypto_finis progress */
262 tsleep(t, PINTERLOCKED, "crypto_destroy", 0);
263 CRYPTO_DRIVER_LOCK();
264 kprintf("crypto_terminate: end\n");
271 crypto_tdinfo_t tdinfo;
275 * Terminate any crypto threads.
277 CRYPTO_DRIVER_LOCK();
278 for (n = 0; n < ncpus; ++n) {
279 tdinfo = &tdinfo_array[n];
280 crypto_terminate(&tdinfo->crp_td, &tdinfo->crp_q);
281 lockuninit(&tdinfo->crp_lock);
283 crypto_terminate(&cryptoretthread, &crp_ret_q);
284 CRYPTO_DRIVER_UNLOCK();
286 /* XXX flush queues??? */
289 * Reclaim dynamically allocated resources.
291 if (crypto_drivers != NULL)
292 kfree(crypto_drivers, M_CRYPTO_DATA);
294 if (cryptodesc_zone != NULL)
295 zdestroy(cryptodesc_zone);
296 if (cryptop_zone != NULL)
297 zdestroy(cryptop_zone);
298 lockuninit(&crypto_ret_q_lock);
299 lockuninit(&crypto_drivers_lock);
302 static struct cryptocap *
303 crypto_checkdriver(u_int32_t hid)
305 if (crypto_drivers == NULL)
307 return (hid >= crypto_drivers_num ? NULL : &crypto_drivers[hid]);
311 * Compare a driver's list of supported algorithms against another
312 * list; return non-zero if all algorithms are supported.
315 driver_suitable(const struct cryptocap *cap, const struct cryptoini *cri)
317 const struct cryptoini *cr;
319 /* See if all the algorithms are supported. */
320 for (cr = cri; cr; cr = cr->cri_next)
321 if (cap->cc_alg[cr->cri_alg] == 0)
327 * Select a driver for a new session that supports the specified
328 * algorithms and, optionally, is constrained according to the flags.
329 * The algorithm we use here is pretty stupid; just use the
330 * first driver that supports all the algorithms we need. If there
331 * are multiple drivers we choose the driver with the fewest active
332 * sessions. We prefer hardware-backed drivers to software ones.
334 * XXX We need more smarts here (in real life too, but that's
335 * XXX another story altogether).
337 static struct cryptocap *
338 crypto_select_driver(const struct cryptoini *cri, int flags)
340 struct cryptocap *cap, *best;
343 CRYPTO_DRIVER_ASSERT();
346 * Look first for hardware crypto devices if permitted.
348 if (flags & CRYPTOCAP_F_HARDWARE)
349 match = CRYPTOCAP_F_HARDWARE;
351 match = CRYPTOCAP_F_SOFTWARE;
354 for (hid = 0; hid < crypto_drivers_num; hid++) {
355 cap = &crypto_drivers[hid];
357 * If it's not initialized, is in the process of
358 * going away, or is not appropriate (hardware
359 * or software based on match), then skip.
361 if (cap->cc_dev == NULL ||
362 (cap->cc_flags & CRYPTOCAP_F_CLEANUP) ||
363 (cap->cc_flags & match) == 0)
366 /* verify all the algorithms are supported. */
367 if (driver_suitable(cap, cri)) {
369 cap->cc_sessions < best->cc_sessions)
375 if (match == CRYPTOCAP_F_HARDWARE && (flags & CRYPTOCAP_F_SOFTWARE)) {
376 /* sort of an Algol 68-style for loop */
377 match = CRYPTOCAP_F_SOFTWARE;
384 * Create a new session. The crid argument specifies a crypto
385 * driver to use or constraints on a driver to select (hardware
386 * only, software only, either). Whatever driver is selected
387 * must be capable of the requested crypto algorithms.
390 crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int crid)
392 struct cryptocap *cap;
396 CRYPTO_DRIVER_LOCK();
397 if ((crid & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) {
399 * Use specified driver; verify it is capable.
401 cap = crypto_checkdriver(crid);
402 if (cap != NULL && !driver_suitable(cap, cri))
406 * No requested driver; select based on crid flags.
408 cap = crypto_select_driver(cri, crid);
410 * if NULL then can't do everything in one session.
411 * XXX Fix this. We need to inject a "virtual" session
412 * XXX layer right about here.
416 /* Call the driver initialization routine. */
417 hid = cap - crypto_drivers;
418 lid = hid; /* Pass the driver ID. */
419 err = CRYPTODEV_NEWSESSION(cap->cc_dev, &lid, cri);
421 (*sid) = (cap->cc_flags & 0xff000000)
422 | (hid & 0x00ffffff);
424 (*sid) |= (lid & 0xffffffff);
429 CRYPTO_DRIVER_UNLOCK();
434 crypto_remove(struct cryptocap *cap)
437 KKASSERT(lockstatus(&crypto_drivers_lock, curthread) != 0);
438 if (cap->cc_sessions == 0 && cap->cc_koperations == 0)
439 bzero(cap, sizeof(*cap));
443 * Delete an existing session (or a reserved session on an unregistered
447 crypto_freesession(u_int64_t sid)
449 struct cryptocap *cap;
453 CRYPTO_DRIVER_LOCK();
455 if (crypto_drivers == NULL) {
460 /* Determine two IDs. */
461 hid = CRYPTO_SESID2HID(sid);
463 if (hid >= crypto_drivers_num) {
467 cap = &crypto_drivers[hid];
469 if (cap->cc_sessions)
472 /* Call the driver cleanup routine, if available. */
473 err = CRYPTODEV_FREESESSION(cap->cc_dev, sid);
475 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP)
479 CRYPTO_DRIVER_UNLOCK();
484 * Return an unused driver id. Used by drivers prior to registering
485 * support for the algorithms they handle.
488 crypto_get_driverid(device_t dev, int flags)
490 struct cryptocap *newdrv;
493 if ((flags & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) {
494 kprintf("%s: no flags specified when registering driver\n",
495 device_get_nameunit(dev));
499 CRYPTO_DRIVER_LOCK();
501 for (i = 0; i < crypto_drivers_num; i++) {
502 if (crypto_drivers[i].cc_dev == NULL &&
503 (crypto_drivers[i].cc_flags & CRYPTOCAP_F_CLEANUP) == 0) {
508 /* Out of entries, allocate some more. */
509 if (i == crypto_drivers_num) {
510 /* Be careful about wrap-around. */
511 if (2 * crypto_drivers_num <= crypto_drivers_num) {
512 CRYPTO_DRIVER_UNLOCK();
513 kprintf("crypto: driver count wraparound!\n");
517 newdrv = kmalloc(2 * crypto_drivers_num *
518 sizeof(struct cryptocap),
519 M_CRYPTO_DATA, M_WAITOK|M_ZERO);
520 if (newdrv == NULL) {
521 CRYPTO_DRIVER_UNLOCK();
522 kprintf("crypto: no space to expand driver table!\n");
526 bcopy(crypto_drivers, newdrv,
527 crypto_drivers_num * sizeof(struct cryptocap));
529 crypto_drivers_num *= 2;
531 kfree(crypto_drivers, M_CRYPTO_DATA);
532 crypto_drivers = newdrv;
535 /* NB: state is zero'd on free */
536 crypto_drivers[i].cc_sessions = 1; /* Mark */
537 crypto_drivers[i].cc_dev = dev;
538 crypto_drivers[i].cc_flags = flags;
540 kprintf("crypto: assign %s driver id %u, flags %u\n",
541 device_get_nameunit(dev), i, flags);
543 CRYPTO_DRIVER_UNLOCK();
549 * Lookup a driver by name. We match against the full device
550 * name and unit, and against just the name. The latter gives
551 * us a simple widlcarding by device name. On success return the
552 * driver/hardware identifier; otherwise return -1.
555 crypto_find_driver(const char *match)
557 int i, len = strlen(match);
559 CRYPTO_DRIVER_LOCK();
560 for (i = 0; i < crypto_drivers_num; i++) {
561 device_t dev = crypto_drivers[i].cc_dev;
563 (crypto_drivers[i].cc_flags & CRYPTOCAP_F_CLEANUP))
565 if (strncmp(match, device_get_nameunit(dev), len) == 0 ||
566 strncmp(match, device_get_name(dev), len) == 0)
569 CRYPTO_DRIVER_UNLOCK();
570 return i < crypto_drivers_num ? i : -1;
574 * Return the device_t for the specified driver or NULL
575 * if the driver identifier is invalid.
578 crypto_find_device_byhid(int hid)
580 struct cryptocap *cap = crypto_checkdriver(hid);
581 return cap != NULL ? cap->cc_dev : NULL;
585 * Return the device/driver capabilities.
588 crypto_getcaps(int hid)
590 struct cryptocap *cap = crypto_checkdriver(hid);
591 return cap != NULL ? cap->cc_flags : 0;
595 * Register support for a key-related algorithm. This routine
596 * is called once for each algorithm supported a driver.
599 crypto_kregister(u_int32_t driverid, int kalg, u_int32_t flags)
601 struct cryptocap *cap;
604 CRYPTO_DRIVER_LOCK();
606 cap = crypto_checkdriver(driverid);
608 (CRK_ALGORITM_MIN <= kalg && kalg <= CRK_ALGORITHM_MAX)) {
610 * XXX Do some performance testing to determine placing.
611 * XXX We probably need an auxiliary data structure that
612 * XXX describes relative performances.
615 cap->cc_kalg[kalg] = flags | CRYPTO_ALG_FLAG_SUPPORTED;
617 kprintf("crypto: %s registers key alg %u flags %u\n"
618 , device_get_nameunit(cap->cc_dev)
627 CRYPTO_DRIVER_UNLOCK();
632 * Register support for a non-key-related algorithm. This routine
633 * is called once for each such algorithm supported by a driver.
636 crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen,
639 struct cryptocap *cap;
642 CRYPTO_DRIVER_LOCK();
644 cap = crypto_checkdriver(driverid);
645 /* NB: algorithms are in the range [1..max] */
647 (CRYPTO_ALGORITHM_MIN <= alg && alg <= CRYPTO_ALGORITHM_MAX)) {
649 * XXX Do some performance testing to determine placing.
650 * XXX We probably need an auxiliary data structure that
651 * XXX describes relative performances.
654 cap->cc_alg[alg] = flags | CRYPTO_ALG_FLAG_SUPPORTED;
655 cap->cc_max_op_len[alg] = maxoplen;
657 kprintf("crypto: %s registers alg %u flags %u maxoplen %u\n"
658 , device_get_nameunit(cap->cc_dev)
663 cap->cc_sessions = 0; /* Unmark */
668 CRYPTO_DRIVER_UNLOCK();
673 driver_finis(struct cryptocap *cap)
677 CRYPTO_DRIVER_ASSERT();
679 ses = cap->cc_sessions;
680 kops = cap->cc_koperations;
681 bzero(cap, sizeof(*cap));
682 if (ses != 0 || kops != 0) {
684 * If there are pending sessions,
685 * just mark as invalid.
687 cap->cc_flags |= CRYPTOCAP_F_CLEANUP;
688 cap->cc_sessions = ses;
689 cap->cc_koperations = kops;
694 * Unregister a crypto driver. If there are pending sessions using it,
695 * leave enough information around so that subsequent calls using those
696 * sessions will correctly detect the driver has been unregistered and
700 crypto_unregister(u_int32_t driverid, int alg)
702 struct cryptocap *cap;
705 CRYPTO_DRIVER_LOCK();
706 cap = crypto_checkdriver(driverid);
708 (CRYPTO_ALGORITHM_MIN <= alg && alg <= CRYPTO_ALGORITHM_MAX) &&
709 cap->cc_alg[alg] != 0) {
710 cap->cc_alg[alg] = 0;
711 cap->cc_max_op_len[alg] = 0;
713 /* Was this the last algorithm ? */
714 for (i = 1; i <= CRYPTO_ALGORITHM_MAX; i++) {
715 if (cap->cc_alg[i] != 0)
719 if (i == CRYPTO_ALGORITHM_MAX + 1)
725 CRYPTO_DRIVER_UNLOCK();
731 * Unregister all algorithms associated with a crypto driver.
732 * If there are pending sessions using it, leave enough information
733 * around so that subsequent calls using those sessions will
734 * correctly detect the driver has been unregistered and reroute
738 crypto_unregister_all(u_int32_t driverid)
740 struct cryptocap *cap;
743 CRYPTO_DRIVER_LOCK();
744 cap = crypto_checkdriver(driverid);
751 CRYPTO_DRIVER_UNLOCK();
757 * Clear blockage on a driver. The what parameter indicates whether
758 * the driver is now ready for cryptop's and/or cryptokop's.
761 crypto_unblock(u_int32_t driverid, int what)
763 crypto_tdinfo_t tdinfo;
764 struct cryptocap *cap;
768 CRYPTO_DRIVER_LOCK();
769 cap = crypto_checkdriver(driverid);
771 if (what & CRYPTO_SYMQ)
772 cap->cc_qblocked = 0;
773 if (what & CRYPTO_ASYMQ)
774 cap->cc_kqblocked = 0;
775 for (n = 0; n < ncpus; ++n) {
776 tdinfo = &tdinfo_array[n];
777 CRYPTO_Q_LOCK(tdinfo);
778 if (tdinfo[n].crp_sleep)
779 wakeup_one(&tdinfo->crp_q);
780 CRYPTO_Q_UNLOCK(tdinfo);
786 CRYPTO_DRIVER_UNLOCK();
791 static volatile int dispatch_rover;
794 * Add a crypto request to a queue, to be processed by the kernel thread.
797 crypto_dispatch(struct cryptop *crp)
799 crypto_tdinfo_t tdinfo;
800 struct cryptocap *cap;
805 cryptostats.cs_ops++;
809 nanouptime(&crp->crp_tstamp);
812 hid = CRYPTO_SESID2HID(crp->crp_sid);
814 if ((crp->crp_flags & CRYPTO_F_BATCH) == 0) {
816 * Caller marked the request to be processed
817 * immediately; dispatch it directly to the
818 * driver unless the driver is currently blocked.
820 cap = crypto_checkdriver(hid);
821 /* Driver cannot disappeared when there is an active session. */
822 KASSERT(cap != NULL, ("%s: Driver disappeared.", __func__));
823 if (!cap->cc_qblocked) {
824 result = crypto_invoke(cap, crp, 0);
825 if (result != ERESTART)
828 * The driver ran out of resources, put the request on
835 * Dispatch to a cpu for action if possible
837 if (CRYPTO_SESID2CAPS(crp->crp_sid) & CRYPTOCAP_F_SMP) {
838 n = atomic_fetchadd_int(&dispatch_rover, 1) & 255;
843 tdinfo = &tdinfo_array[n];
845 CRYPTO_Q_LOCK(tdinfo);
846 TAILQ_INSERT_TAIL(&tdinfo->crp_q, crp, crp_next);
847 if (tdinfo->crp_sleep)
848 wakeup_one(&tdinfo->crp_q);
849 CRYPTO_Q_UNLOCK(tdinfo);
854 * Add an asymetric crypto request to a queue,
855 * to be processed by the kernel thread.
858 crypto_kdispatch(struct cryptkop *krp)
860 crypto_tdinfo_t tdinfo;
864 cryptostats.cs_kops++;
867 /* not sure how to test F_SMP here */
868 n = atomic_fetchadd_int(&dispatch_rover, 1) & 255;
872 tdinfo = &tdinfo_array[n];
874 error = crypto_kinvoke(krp, krp->krp_crid);
876 if (error == ERESTART) {
877 CRYPTO_Q_LOCK(tdinfo);
878 TAILQ_INSERT_TAIL(&tdinfo->crp_kq, krp, krp_next);
879 if (tdinfo->crp_sleep)
880 wakeup_one(&tdinfo->crp_q);
881 CRYPTO_Q_UNLOCK(tdinfo);
888 * Verify a driver is suitable for the specified operation.
891 kdriver_suitable(const struct cryptocap *cap, const struct cryptkop *krp)
893 return (cap->cc_kalg[krp->krp_op] & CRYPTO_ALG_FLAG_SUPPORTED) != 0;
897 * Select a driver for an asym operation. The driver must
898 * support the necessary algorithm. The caller can constrain
899 * which device is selected with the flags parameter. The
900 * algorithm we use here is pretty stupid; just use the first
901 * driver that supports the algorithms we need. If there are
902 * multiple suitable drivers we choose the driver with the
903 * fewest active operations. We prefer hardware-backed
904 * drivers to software ones when either may be used.
906 static struct cryptocap *
907 crypto_select_kdriver(const struct cryptkop *krp, int flags)
909 struct cryptocap *cap, *best, *blocked;
912 CRYPTO_DRIVER_ASSERT();
915 * Look first for hardware crypto devices if permitted.
917 if (flags & CRYPTOCAP_F_HARDWARE)
918 match = CRYPTOCAP_F_HARDWARE;
920 match = CRYPTOCAP_F_SOFTWARE;
924 for (hid = 0; hid < crypto_drivers_num; hid++) {
925 cap = &crypto_drivers[hid];
927 * If it's not initialized, is in the process of
928 * going away, or is not appropriate (hardware
929 * or software based on match), then skip.
931 if (cap->cc_dev == NULL ||
932 (cap->cc_flags & CRYPTOCAP_F_CLEANUP) ||
933 (cap->cc_flags & match) == 0)
936 /* verify all the algorithms are supported. */
937 if (kdriver_suitable(cap, krp)) {
939 cap->cc_koperations < best->cc_koperations)
945 if (match == CRYPTOCAP_F_HARDWARE && (flags & CRYPTOCAP_F_SOFTWARE)) {
946 /* sort of an Algol 68-style for loop */
947 match = CRYPTOCAP_F_SOFTWARE;
954 * Dispatch an assymetric crypto request.
957 crypto_kinvoke(struct cryptkop *krp, int crid)
959 struct cryptocap *cap = NULL;
962 KASSERT(krp != NULL, ("%s: krp == NULL", __func__));
963 KASSERT(krp->krp_callback != NULL,
964 ("%s: krp->crp_callback == NULL", __func__));
966 CRYPTO_DRIVER_LOCK();
967 if ((crid & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) {
968 cap = crypto_checkdriver(crid);
971 * Driver present, it must support the necessary
972 * algorithm and, if s/w drivers are excluded,
973 * it must be registered as hardware-backed.
975 if (!kdriver_suitable(cap, krp) ||
976 (!crypto_devallowsoft &&
977 (cap->cc_flags & CRYPTOCAP_F_HARDWARE) == 0))
982 * No requested driver; select based on crid flags.
984 if (!crypto_devallowsoft) /* NB: disallow s/w drivers */
985 crid &= ~CRYPTOCAP_F_SOFTWARE;
986 cap = crypto_select_kdriver(krp, crid);
988 if (cap != NULL && !cap->cc_kqblocked) {
989 krp->krp_hid = cap - crypto_drivers;
990 cap->cc_koperations++;
991 CRYPTO_DRIVER_UNLOCK();
992 error = CRYPTODEV_KPROCESS(cap->cc_dev, krp, 0);
993 CRYPTO_DRIVER_LOCK();
994 if (error == ERESTART) {
995 cap->cc_koperations--;
996 CRYPTO_DRIVER_UNLOCK();
1001 * NB: cap is !NULL if device is blocked; in
1002 * that case return ERESTART so the operation
1003 * is resubmitted if possible.
1005 error = (cap == NULL) ? ENODEV : ERESTART;
1007 CRYPTO_DRIVER_UNLOCK();
1010 krp->krp_status = error;
1016 #ifdef CRYPTO_TIMING
1018 crypto_tstat(struct cryptotstat *ts, struct timespec *tv)
1020 struct timespec now, t;
1023 t.tv_sec = now.tv_sec - tv->tv_sec;
1024 t.tv_nsec = now.tv_nsec - tv->tv_nsec;
1025 if (t.tv_nsec < 0) {
1027 t.tv_nsec += 1000000000;
1029 timespecadd(&ts->acc, &t);
1030 if (timespeccmp(&t, &ts->min, <))
1032 if (timespeccmp(&t, &ts->max, >))
1041 * Dispatch a crypto request to the appropriate crypto devices.
1044 crypto_invoke(struct cryptocap *cap, struct cryptop *crp, int hint)
1047 KASSERT(crp != NULL, ("%s: crp == NULL", __func__));
1048 KASSERT(crp->crp_callback != NULL,
1049 ("%s: crp->crp_callback == NULL", __func__));
1050 KASSERT(crp->crp_desc != NULL, ("%s: crp->crp_desc == NULL", __func__));
1052 #ifdef CRYPTO_TIMING
1054 crypto_tstat(&cryptostats.cs_invoke, &crp->crp_tstamp);
1056 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP) {
1057 struct cryptodesc *crd;
1061 * Driver has unregistered; migrate the session and return
1062 * an error to the caller so they'll resubmit the op.
1064 * XXX: What if there are more already queued requests for this
1067 crypto_freesession(crp->crp_sid);
1069 for (crd = crp->crp_desc; crd->crd_next; crd = crd->crd_next)
1070 crd->CRD_INI.cri_next = &(crd->crd_next->CRD_INI);
1072 /* XXX propagate flags from initial session? */
1073 if (crypto_newsession(&nid, &(crp->crp_desc->CRD_INI),
1074 CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE) == 0)
1077 crp->crp_etype = EAGAIN;
1082 * Invoke the driver to process the request.
1084 return CRYPTODEV_PROCESS(cap->cc_dev, crp, hint);
1089 * Release a set of crypto descriptors.
1092 crypto_freereq(struct cryptop *crp)
1094 struct cryptodesc *crd;
1096 crypto_tdinfo_t tdinfo;
1104 for (n = 0; n < ncpus; ++n) {
1105 struct cryptop *crp2;
1107 tdinfo = &tdinfo_array[n];
1109 CRYPTO_Q_LOCK(tdinfo);
1110 TAILQ_FOREACH(crp2, &tdinfo->crp_q, crp_next) {
1111 KASSERT(crp2 != crp,
1112 ("Freeing cryptop from the crypto queue (%p).",
1115 CRYPTO_Q_UNLOCK(tdinfo);
1118 TAILQ_FOREACH(crp2, &crp_ret_q, crp_next) {
1119 KASSERT(crp2 != crp,
1120 ("Freeing cryptop from the return queue (%p).",
1123 CRYPTO_RETQ_UNLOCK();
1126 while ((crd = crp->crp_desc) != NULL) {
1127 crp->crp_desc = crd->crd_next;
1128 zfree(cryptodesc_zone, crd);
1130 zfree(cryptop_zone, crp);
1134 * Acquire a set of crypto descriptors.
1137 crypto_getreq(int num)
1139 struct cryptodesc *crd;
1140 struct cryptop *crp;
1142 crp = zalloc(cryptop_zone);
1144 bzero(crp, sizeof (*crp));
1146 crd = zalloc(cryptodesc_zone);
1148 crypto_freereq(crp);
1151 bzero(crd, sizeof (*crd));
1153 crd->crd_next = crp->crp_desc;
1154 crp->crp_desc = crd;
1161 * Invoke the callback on behalf of the driver.
1164 crypto_done(struct cryptop *crp)
1166 KASSERT((crp->crp_flags & CRYPTO_F_DONE) == 0,
1167 ("crypto_done: op already done, flags 0x%x", crp->crp_flags));
1168 crp->crp_flags |= CRYPTO_F_DONE;
1169 if (crp->crp_etype != 0)
1170 cryptostats.cs_errs++;
1171 #ifdef CRYPTO_TIMING
1173 crypto_tstat(&cryptostats.cs_done, &crp->crp_tstamp);
1176 * CBIMM means unconditionally do the callback immediately;
1177 * CBIFSYNC means do the callback immediately only if the
1178 * operation was done synchronously. Both are used to avoid
1179 * doing extraneous context switches; the latter is mostly
1180 * used with the software crypto driver.
1182 if ((crp->crp_flags & CRYPTO_F_CBIMM) ||
1183 ((crp->crp_flags & CRYPTO_F_CBIFSYNC) &&
1184 (CRYPTO_SESID2CAPS(crp->crp_sid) & CRYPTOCAP_F_SYNC))) {
1186 * Do the callback directly. This is ok when the
1187 * callback routine does very little (e.g. the
1188 * /dev/crypto callback method just does a wakeup).
1190 #ifdef CRYPTO_TIMING
1191 if (crypto_timing) {
1193 * NB: We must copy the timestamp before
1194 * doing the callback as the cryptop is
1195 * likely to be reclaimed.
1197 struct timespec t = crp->crp_tstamp;
1198 crypto_tstat(&cryptostats.cs_cb, &t);
1199 crp->crp_callback(crp);
1200 crypto_tstat(&cryptostats.cs_finis, &t);
1203 crp->crp_callback(crp);
1206 * Normal case; queue the callback for the thread.
1209 if (CRYPTO_RETQ_EMPTY())
1210 wakeup_one(&crp_ret_q); /* shared wait channel */
1211 TAILQ_INSERT_TAIL(&crp_ret_q, crp, crp_next);
1212 CRYPTO_RETQ_UNLOCK();
1217 * Invoke the callback on behalf of the driver.
1220 crypto_kdone(struct cryptkop *krp)
1222 struct cryptocap *cap;
1224 if (krp->krp_status != 0)
1225 cryptostats.cs_kerrs++;
1226 CRYPTO_DRIVER_LOCK();
1227 /* XXX: What if driver is loaded in the meantime? */
1228 if (krp->krp_hid < crypto_drivers_num) {
1229 cap = &crypto_drivers[krp->krp_hid];
1230 cap->cc_koperations--;
1231 KASSERT(cap->cc_koperations >= 0, ("cc_koperations < 0"));
1232 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP)
1235 CRYPTO_DRIVER_UNLOCK();
1237 if (CRYPTO_RETQ_EMPTY())
1238 wakeup_one(&crp_ret_q); /* shared wait channel */
1239 TAILQ_INSERT_TAIL(&crp_ret_kq, krp, krp_next);
1240 CRYPTO_RETQ_UNLOCK();
1244 crypto_getfeat(int *featp)
1246 int hid, kalg, feat = 0;
1248 CRYPTO_DRIVER_LOCK();
1249 for (hid = 0; hid < crypto_drivers_num; hid++) {
1250 const struct cryptocap *cap = &crypto_drivers[hid];
1252 if ((cap->cc_flags & CRYPTOCAP_F_SOFTWARE) &&
1253 !crypto_devallowsoft) {
1256 for (kalg = 0; kalg < CRK_ALGORITHM_MAX; kalg++)
1257 if (cap->cc_kalg[kalg] & CRYPTO_ALG_FLAG_SUPPORTED)
1260 CRYPTO_DRIVER_UNLOCK();
1266 * Terminate a thread at module unload. The process that
1267 * initiated this is waiting for us to signal that we're gone;
1268 * wake it up and exit. We use the driver table lock to insure
1269 * we don't do the wakeup before they're waiting. There is no
1270 * race here because the waiter sleeps on the proc lock for the
1271 * thread so it gets notified at the right time because of an
1272 * extra wakeup that's done in exit1().
1275 crypto_finis(void *chan)
1277 CRYPTO_DRIVER_LOCK();
1279 CRYPTO_DRIVER_UNLOCK();
1284 * Crypto thread, dispatches crypto requests.
1287 crypto_proc(void *arg)
1289 crypto_tdinfo_t tdinfo = arg;
1290 struct cryptop *crp, *submit;
1291 struct cryptkop *krp;
1292 struct cryptocap *cap;
1296 rel_mplock(); /* release the mplock held on startup */
1298 CRYPTO_Q_LOCK(tdinfo);
1302 * Find the first element in the queue that can be
1303 * processed and look-ahead to see if multiple ops
1304 * are ready for the same driver.
1308 TAILQ_FOREACH(crp, &tdinfo->crp_q, crp_next) {
1309 hid = CRYPTO_SESID2HID(crp->crp_sid);
1310 cap = crypto_checkdriver(hid);
1312 * Driver cannot disappeared when there is an active
1315 KASSERT(cap != NULL, ("%s:%u Driver disappeared.",
1316 __func__, __LINE__));
1317 if (cap == NULL || cap->cc_dev == NULL) {
1318 /* Op needs to be migrated, process it. */
1323 if (!cap->cc_qblocked) {
1324 if (submit != NULL) {
1326 * We stop on finding another op,
1327 * regardless whether its for the same
1328 * driver or not. We could keep
1329 * searching the queue but it might be
1330 * better to just use a per-driver
1333 if (CRYPTO_SESID2HID(submit->crp_sid) == hid)
1334 hint = CRYPTO_HINT_MORE;
1338 if ((submit->crp_flags & CRYPTO_F_BATCH) == 0)
1340 /* keep scanning for more are q'd */
1344 if (submit != NULL) {
1345 TAILQ_REMOVE(&tdinfo->crp_q, submit, crp_next);
1346 hid = CRYPTO_SESID2HID(submit->crp_sid);
1347 cap = crypto_checkdriver(hid);
1348 KASSERT(cap != NULL, ("%s:%u Driver disappeared.",
1349 __func__, __LINE__));
1351 CRYPTO_Q_UNLOCK(tdinfo);
1352 result = crypto_invoke(cap, submit, hint);
1353 CRYPTO_Q_LOCK(tdinfo);
1355 if (result == ERESTART) {
1357 * The driver ran out of resources, mark the
1358 * driver ``blocked'' for cryptop's and put
1359 * the request back in the queue. It would
1360 * best to put the request back where we got
1361 * it but that's hard so for now we put it
1362 * at the front. This should be ok; putting
1363 * it at the end does not work.
1365 /* XXX validate sid again? */
1366 crypto_drivers[CRYPTO_SESID2HID(submit->crp_sid)].cc_qblocked = 1;
1367 TAILQ_INSERT_HEAD(&tdinfo->crp_q,
1369 cryptostats.cs_blocks++;
1373 /* As above, but for key ops */
1374 TAILQ_FOREACH(krp, &tdinfo->crp_kq, krp_next) {
1375 cap = crypto_checkdriver(krp->krp_hid);
1376 if (cap == NULL || cap->cc_dev == NULL) {
1378 * Operation needs to be migrated, invalidate
1379 * the assigned device so it will reselect a
1380 * new one below. Propagate the original
1381 * crid selection flags if supplied.
1383 krp->krp_hid = krp->krp_crid &
1384 (CRYPTOCAP_F_SOFTWARE|CRYPTOCAP_F_HARDWARE);
1385 if (krp->krp_hid == 0)
1387 CRYPTOCAP_F_SOFTWARE|CRYPTOCAP_F_HARDWARE;
1390 if (!cap->cc_kqblocked)
1394 TAILQ_REMOVE(&tdinfo->crp_kq, krp, krp_next);
1396 CRYPTO_Q_UNLOCK(tdinfo);
1397 result = crypto_kinvoke(krp, krp->krp_hid);
1398 CRYPTO_Q_LOCK(tdinfo);
1400 if (result == ERESTART) {
1402 * The driver ran out of resources, mark the
1403 * driver ``blocked'' for cryptkop's and put
1404 * the request back in the queue. It would
1405 * best to put the request back where we got
1406 * it but that's hard so for now we put it
1407 * at the front. This should be ok; putting
1408 * it at the end does not work.
1410 /* XXX validate sid again? */
1411 crypto_drivers[krp->krp_hid].cc_kqblocked = 1;
1412 TAILQ_INSERT_HEAD(&tdinfo->crp_kq,
1414 cryptostats.cs_kblocks++;
1418 if (submit == NULL && krp == NULL) {
1420 * Nothing more to be processed. Sleep until we're
1421 * woken because there are more ops to process.
1422 * This happens either by submission or by a driver
1423 * becoming unblocked and notifying us through
1424 * crypto_unblock. Note that when we wakeup we
1425 * start processing each queue again from the
1426 * front. It's not clear that it's important to
1427 * preserve this ordering since ops may finish
1428 * out of order if dispatched to different devices
1429 * and some become blocked while others do not.
1431 tdinfo->crp_sleep = 1;
1432 lksleep (&tdinfo->crp_q, &tdinfo->crp_lock,
1433 0, "crypto_wait", 0);
1434 tdinfo->crp_sleep = 0;
1435 if (tdinfo->crp_td == NULL)
1437 cryptostats.cs_intrs++;
1440 CRYPTO_Q_UNLOCK(tdinfo);
1442 crypto_finis(&tdinfo->crp_q);
1446 * Crypto returns thread, does callbacks for processed crypto requests.
1447 * Callbacks are done here, rather than in the crypto drivers, because
1448 * callbacks typically are expensive and would slow interrupt handling.
1451 crypto_ret_proc(void *dummy __unused)
1453 struct cryptop *crpt;
1454 struct cryptkop *krpt;
1458 /* Harvest return q's for completed ops */
1459 crpt = TAILQ_FIRST(&crp_ret_q);
1461 TAILQ_REMOVE(&crp_ret_q, crpt, crp_next);
1463 krpt = TAILQ_FIRST(&crp_ret_kq);
1465 TAILQ_REMOVE(&crp_ret_kq, krpt, krp_next);
1467 if (crpt != NULL || krpt != NULL) {
1468 CRYPTO_RETQ_UNLOCK();
1470 * Run callbacks unlocked.
1473 #ifdef CRYPTO_TIMING
1474 if (crypto_timing) {
1476 * NB: We must copy the timestamp before
1477 * doing the callback as the cryptop is
1478 * likely to be reclaimed.
1480 struct timespec t = crpt->crp_tstamp;
1481 crypto_tstat(&cryptostats.cs_cb, &t);
1482 crpt->crp_callback(crpt);
1483 crypto_tstat(&cryptostats.cs_finis, &t);
1486 crpt->crp_callback(crpt);
1489 krpt->krp_callback(krpt);
1493 * Nothing more to be processed. Sleep until we're
1494 * woken because there are more returns to process.
1496 lksleep (&crp_ret_q, &crypto_ret_q_lock,
1497 0, "crypto_ret_wait", 0);
1498 if (cryptoretthread == NULL)
1500 cryptostats.cs_rets++;
1503 CRYPTO_RETQ_UNLOCK();
1505 crypto_finis(&crp_ret_q);
1510 db_show_drivers(void)
1514 db_printf("%12s %4s %4s %8s %2s %2s\n"
1522 for (hid = 0; hid < crypto_drivers_num; hid++) {
1523 const struct cryptocap *cap = &crypto_drivers[hid];
1524 if (cap->cc_dev == NULL)
1526 db_printf("%-12s %4u %4u %08x %2u %2u\n"
1527 , device_get_nameunit(cap->cc_dev)
1529 , cap->cc_koperations
1537 DB_SHOW_COMMAND(crypto, db_show_crypto)
1539 crypto_tdinfo_t tdinfo;
1540 struct cryptop *crp;
1546 db_printf("%4s %8s %4s %4s %4s %4s %8s %8s\n",
1547 "HID", "Caps", "Ilen", "Olen", "Etype", "Flags",
1548 "Desc", "Callback");
1550 for (n = 0; n < ncpus; ++n) {
1551 tdinfo = &tdinfo_array[n];
1553 TAILQ_FOREACH(crp, &tdinfo->crp_q, crp_next) {
1554 db_printf("%4u %08x %4u %4u %4u %04x %8p %8p\n"
1555 , (int) CRYPTO_SESID2HID(crp->crp_sid)
1556 , (int) CRYPTO_SESID2CAPS(crp->crp_sid)
1557 , crp->crp_ilen, crp->crp_olen
1565 if (!TAILQ_EMPTY(&crp_ret_q)) {
1566 db_printf("\n%4s %4s %4s %8s\n",
1567 "HID", "Etype", "Flags", "Callback");
1568 TAILQ_FOREACH(crp, &crp_ret_q, crp_next) {
1569 db_printf("%4u %4u %04x %8p\n"
1570 , (int) CRYPTO_SESID2HID(crp->crp_sid)
1579 DB_SHOW_COMMAND(kcrypto, db_show_kcrypto)
1581 crypto_tdinfo_t tdinfo;
1582 struct cryptkop *krp;
1588 db_printf("%4s %5s %4s %4s %8s %4s %8s\n",
1589 "Op", "Status", "#IP", "#OP", "CRID", "HID", "Callback");
1591 for (n = 0; n < ncpus; ++n) {
1592 tdinfo = &tdinfo_array[n];
1594 TAILQ_FOREACH(krp, &tdinfo->crp_kq, krp_next) {
1595 db_printf("%4u %5u %4u %4u %08x %4u %8p\n"
1598 , krp->krp_iparams, krp->krp_oparams
1599 , krp->krp_crid, krp->krp_hid
1604 if (!TAILQ_EMPTY(&crp_ret_q)) {
1605 db_printf("%4s %5s %8s %4s %8s\n",
1606 "Op", "Status", "CRID", "HID", "Callback");
1607 TAILQ_FOREACH(krp, &crp_ret_kq, krp_next) {
1608 db_printf("%4u %5u %08x %4u %8p\n"
1611 , krp->krp_crid, krp->krp_hid
1619 int crypto_modevent(module_t mod, int type, void *unused);
1622 * Initialization code, both for static and dynamic loading.
1623 * Note this is not invoked with the usual MODULE_DECLARE
1624 * mechanism but instead is listed as a dependency by the
1625 * cryptosoft driver. This guarantees proper ordering of
1626 * calls on module load/unload.
1629 crypto_modevent(module_t mod, int type, void *unused)
1635 error = crypto_init();
1636 if (error == 0 && bootverbose)
1637 kprintf("crypto: <crypto core>\n");
1640 /*XXX disallow if active sessions */
1647 MODULE_VERSION(crypto, 1);
1648 MODULE_DEPEND(crypto, zlib, 1, 1, 1);