2 * Copyright (c) 2002-2006 Sam Leffler. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 #include <sys/cdefs.h>
26 __FBSDID("$FreeBSD$");
29 * Cryptographic Subsystem.
31 * This code is derived from the Openbsd Cryptographic Framework (OCF)
32 * that has the copyright shown below. Very little of the original
37 * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu)
39 * This code was written by Angelos D. Keromytis in Athens, Greece, in
40 * February 2000. Network Security Technologies Inc. (NSTI) kindly
41 * supported the development of this code.
43 * Copyright (c) 2000, 2001 Angelos D. Keromytis
45 * Permission to use, copy, and modify this software with or without fee
46 * is hereby granted, provided that this entire notice is included in
47 * all source code copies of any software which is or includes a copy or
48 * modification of this software.
50 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
51 * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
52 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
53 * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
57 #define CRYPTO_TIMING /* enable timing support */
61 #include <sys/param.h>
62 #include <sys/systm.h>
63 #include <sys/eventhandler.h>
64 #include <sys/kernel.h>
65 #include <sys/kthread.h>
66 #include <sys/linker.h>
68 #include <sys/module.h>
69 #include <sys/mutex.h>
70 #include <sys/malloc.h>
73 #include <sys/sysctl.h>
78 #include <crypto/intake.h>
79 #include <opencrypto/cryptodev.h>
80 #include <opencrypto/xform.h> /* XXX for M_XDATA */
84 #include "cryptodev_if.h"
86 #if defined(__i386__) || defined(__amd64__)
87 #include <machine/pcb.h>
89 #include <machine/metadata.h>
91 SDT_PROVIDER_DEFINE(opencrypto);
94 * Crypto drivers register themselves by allocating a slot in the
95 * crypto_drivers table with crypto_get_driverid() and then registering
96 * each algorithm they support with crypto_register() and crypto_kregister().
98 static struct mtx crypto_drivers_mtx; /* lock on driver table */
99 #define CRYPTO_DRIVER_LOCK() mtx_lock(&crypto_drivers_mtx)
100 #define CRYPTO_DRIVER_UNLOCK() mtx_unlock(&crypto_drivers_mtx)
101 #define CRYPTO_DRIVER_ASSERT() mtx_assert(&crypto_drivers_mtx, MA_OWNED)
104 * Crypto device/driver capabilities structure.
107 * (d) - protected by CRYPTO_DRIVER_LOCK()
108 * (q) - protected by CRYPTO_Q_LOCK()
109 * Not tagged fields are read-only.
112 device_t cc_dev; /* (d) device/driver */
113 u_int32_t cc_sessions; /* (d) # of sessions */
114 u_int32_t cc_koperations; /* (d) # os asym operations */
116 * Largest possible operator length (in bits) for each type of
117 * encryption algorithm. XXX not used
119 u_int16_t cc_max_op_len[CRYPTO_ALGORITHM_MAX + 1];
120 u_int8_t cc_alg[CRYPTO_ALGORITHM_MAX + 1];
121 u_int8_t cc_kalg[CRK_ALGORITHM_MAX + 1];
123 int cc_flags; /* (d) flags */
124 #define CRYPTOCAP_F_CLEANUP 0x80000000 /* needs resource cleanup */
125 int cc_qblocked; /* (q) symmetric q blocked */
126 int cc_kqblocked; /* (q) asymmetric q blocked */
128 static struct cryptocap *crypto_drivers = NULL;
129 static int crypto_drivers_num = 0;
132 * There are two queues for crypto requests; one for symmetric (e.g.
133 * cipher) operations and one for asymmetric (e.g. MOD)operations.
134 * A single mutex is used to lock access to both queues. We could
135 * have one per-queue but having one simplifies handling of block/unblock
138 static int crp_sleep = 0;
139 static TAILQ_HEAD(,cryptop) crp_q; /* request queues */
140 static TAILQ_HEAD(,cryptkop) crp_kq;
141 static struct mtx crypto_q_mtx;
142 #define CRYPTO_Q_LOCK() mtx_lock(&crypto_q_mtx)
143 #define CRYPTO_Q_UNLOCK() mtx_unlock(&crypto_q_mtx)
146 * There are two queues for processing completed crypto requests; one
147 * for the symmetric and one for the asymmetric ops. We only need one
148 * but have two to avoid type futzing (cryptop vs. cryptkop). A single
149 * mutex is used to lock access to both queues. Note that this lock
150 * must be separate from the lock on request queues to insure driver
151 * callbacks don't generate lock order reversals.
153 static TAILQ_HEAD(,cryptop) crp_ret_q; /* callback queues */
154 static TAILQ_HEAD(,cryptkop) crp_ret_kq;
155 static struct mtx crypto_ret_q_mtx;
156 #define CRYPTO_RETQ_LOCK() mtx_lock(&crypto_ret_q_mtx)
157 #define CRYPTO_RETQ_UNLOCK() mtx_unlock(&crypto_ret_q_mtx)
158 #define CRYPTO_RETQ_EMPTY() (TAILQ_EMPTY(&crp_ret_q) && TAILQ_EMPTY(&crp_ret_kq))
160 static uma_zone_t cryptop_zone;
161 static uma_zone_t cryptodesc_zone;
163 int crypto_userasymcrypto = 1; /* userland may do asym crypto reqs */
164 SYSCTL_INT(_kern, OID_AUTO, userasymcrypto, CTLFLAG_RW,
165 &crypto_userasymcrypto, 0,
166 "Enable/disable user-mode access to asymmetric crypto support");
167 int crypto_devallowsoft = 0; /* only use hardware crypto */
168 SYSCTL_INT(_kern, OID_AUTO, cryptodevallowsoft, CTLFLAG_RW,
169 &crypto_devallowsoft, 0,
170 "Enable/disable use of software crypto by /dev/crypto");
172 MALLOC_DEFINE(M_CRYPTO_DATA, "crypto", "crypto session records");
174 static void crypto_proc(void);
175 static struct proc *cryptoproc;
176 static void crypto_ret_proc(void);
177 static struct proc *cryptoretproc;
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");
192 /* Try to avoid directly exposing the key buffer as a symbol */
193 static struct keybuf *keybuf;
195 static struct keybuf empty_keybuf = {
199 /* Obtain the key buffer from boot metadata */
205 kmdp = preload_search_by_type("elf kernel");
208 kmdp = preload_search_by_type("elf64 kernel");
210 keybuf = (struct keybuf *)preload_search_info(kmdp,
211 MODINFO_METADATA | MODINFOMD_KEYBUF);
214 keybuf = &empty_keybuf;
217 /* It'd be nice if we could store these in some kind of secure memory... */
218 struct keybuf * get_keybuf(void) {
228 mtx_init(&crypto_drivers_mtx, "crypto", "crypto driver table",
233 mtx_init(&crypto_q_mtx, "crypto", "crypto op queues", MTX_DEF);
235 TAILQ_INIT(&crp_ret_q);
236 TAILQ_INIT(&crp_ret_kq);
237 mtx_init(&crypto_ret_q_mtx, "crypto", "crypto return queues", MTX_DEF);
239 cryptop_zone = uma_zcreate("cryptop", sizeof (struct cryptop),
241 UMA_ALIGN_PTR, UMA_ZONE_ZINIT);
242 cryptodesc_zone = uma_zcreate("cryptodesc", sizeof (struct cryptodesc),
244 UMA_ALIGN_PTR, UMA_ZONE_ZINIT);
245 if (cryptodesc_zone == NULL || cryptop_zone == NULL) {
246 printf("crypto_init: cannot setup crypto zones\n");
251 crypto_drivers_num = CRYPTO_DRIVERS_INITIAL;
252 crypto_drivers = malloc(crypto_drivers_num *
253 sizeof(struct cryptocap), M_CRYPTO_DATA, M_NOWAIT | M_ZERO);
254 if (crypto_drivers == NULL) {
255 printf("crypto_init: cannot setup crypto drivers\n");
260 error = kproc_create((void (*)(void *)) crypto_proc, NULL,
261 &cryptoproc, 0, 0, "crypto");
263 printf("crypto_init: cannot start crypto thread; error %d",
268 error = kproc_create((void (*)(void *)) crypto_ret_proc, NULL,
269 &cryptoretproc, 0, 0, "crypto returns");
271 printf("crypto_init: cannot start cryptoret thread; error %d",
285 * Signal a crypto thread to terminate. We use the driver
286 * table lock to synchronize the sleep/wakeups so that we
287 * are sure the threads have terminated before we release
288 * the data structures they use. See crypto_finis below
289 * for the other half of this song-and-dance.
292 crypto_terminate(struct proc **pp, void *q)
296 mtx_assert(&crypto_drivers_mtx, MA_OWNED);
301 PROC_LOCK(p); /* NB: insure we don't miss wakeup */
302 CRYPTO_DRIVER_UNLOCK(); /* let crypto_finis progress */
303 msleep(p, &p->p_mtx, PWAIT, "crypto_destroy", 0);
305 CRYPTO_DRIVER_LOCK();
313 * Terminate any crypto threads.
315 CRYPTO_DRIVER_LOCK();
316 crypto_terminate(&cryptoproc, &crp_q);
317 crypto_terminate(&cryptoretproc, &crp_ret_q);
318 CRYPTO_DRIVER_UNLOCK();
320 /* XXX flush queues??? */
323 * Reclaim dynamically allocated resources.
325 if (crypto_drivers != NULL)
326 free(crypto_drivers, M_CRYPTO_DATA);
328 if (cryptodesc_zone != NULL)
329 uma_zdestroy(cryptodesc_zone);
330 if (cryptop_zone != NULL)
331 uma_zdestroy(cryptop_zone);
332 mtx_destroy(&crypto_q_mtx);
333 mtx_destroy(&crypto_ret_q_mtx);
334 mtx_destroy(&crypto_drivers_mtx);
337 static struct cryptocap *
338 crypto_checkdriver(u_int32_t hid)
340 if (crypto_drivers == NULL)
342 return (hid >= crypto_drivers_num ? NULL : &crypto_drivers[hid]);
346 * Compare a driver's list of supported algorithms against another
347 * list; return non-zero if all algorithms are supported.
350 driver_suitable(const struct cryptocap *cap, const struct cryptoini *cri)
352 const struct cryptoini *cr;
354 /* See if all the algorithms are supported. */
355 for (cr = cri; cr; cr = cr->cri_next)
356 if (cap->cc_alg[cr->cri_alg] == 0)
362 * Select a driver for a new session that supports the specified
363 * algorithms and, optionally, is constrained according to the flags.
364 * The algorithm we use here is pretty stupid; just use the
365 * first driver that supports all the algorithms we need. If there
366 * are multiple drivers we choose the driver with the fewest active
367 * sessions. We prefer hardware-backed drivers to software ones.
369 * XXX We need more smarts here (in real life too, but that's
370 * XXX another story altogether).
372 static struct cryptocap *
373 crypto_select_driver(const struct cryptoini *cri, int flags)
375 struct cryptocap *cap, *best;
378 CRYPTO_DRIVER_ASSERT();
381 * Look first for hardware crypto devices if permitted.
383 if (flags & CRYPTOCAP_F_HARDWARE)
384 match = CRYPTOCAP_F_HARDWARE;
386 match = CRYPTOCAP_F_SOFTWARE;
389 for (hid = 0; hid < crypto_drivers_num; hid++) {
390 cap = &crypto_drivers[hid];
392 * If it's not initialized, is in the process of
393 * going away, or is not appropriate (hardware
394 * or software based on match), then skip.
396 if (cap->cc_dev == NULL ||
397 (cap->cc_flags & CRYPTOCAP_F_CLEANUP) ||
398 (cap->cc_flags & match) == 0)
401 /* verify all the algorithms are supported. */
402 if (driver_suitable(cap, cri)) {
404 cap->cc_sessions < best->cc_sessions)
408 if (best == NULL && match == CRYPTOCAP_F_HARDWARE &&
409 (flags & CRYPTOCAP_F_SOFTWARE)) {
410 /* sort of an Algol 68-style for loop */
411 match = CRYPTOCAP_F_SOFTWARE;
418 * Create a new session. The crid argument specifies a crypto
419 * driver to use or constraints on a driver to select (hardware
420 * only, software only, either). Whatever driver is selected
421 * must be capable of the requested crypto algorithms.
424 crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int crid)
426 struct cryptocap *cap;
430 CRYPTO_DRIVER_LOCK();
431 if ((crid & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) {
433 * Use specified driver; verify it is capable.
435 cap = crypto_checkdriver(crid);
436 if (cap != NULL && !driver_suitable(cap, cri))
440 * No requested driver; select based on crid flags.
442 cap = crypto_select_driver(cri, crid);
444 * if NULL then can't do everything in one session.
445 * XXX Fix this. We need to inject a "virtual" session
446 * XXX layer right about here.
450 /* Call the driver initialization routine. */
451 hid = cap - crypto_drivers;
452 lid = hid; /* Pass the driver ID. */
453 err = CRYPTODEV_NEWSESSION(cap->cc_dev, &lid, cri);
455 (*sid) = (cap->cc_flags & 0xff000000)
456 | (hid & 0x00ffffff);
458 (*sid) |= (lid & 0xffffffff);
461 CRYPTDEB("dev newsession failed");
463 CRYPTDEB("no driver");
466 CRYPTO_DRIVER_UNLOCK();
471 crypto_remove(struct cryptocap *cap)
474 mtx_assert(&crypto_drivers_mtx, MA_OWNED);
475 if (cap->cc_sessions == 0 && cap->cc_koperations == 0)
476 bzero(cap, sizeof(*cap));
480 * Delete an existing session (or a reserved session on an unregistered
484 crypto_freesession(u_int64_t sid)
486 struct cryptocap *cap;
490 CRYPTO_DRIVER_LOCK();
492 if (crypto_drivers == NULL) {
497 /* Determine two IDs. */
498 hid = CRYPTO_SESID2HID(sid);
500 if (hid >= crypto_drivers_num) {
504 cap = &crypto_drivers[hid];
506 if (cap->cc_sessions)
509 /* Call the driver cleanup routine, if available. */
510 err = CRYPTODEV_FREESESSION(cap->cc_dev, sid);
512 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP)
516 CRYPTO_DRIVER_UNLOCK();
521 * Return an unused driver id. Used by drivers prior to registering
522 * support for the algorithms they handle.
525 crypto_get_driverid(device_t dev, int flags)
527 struct cryptocap *newdrv;
530 if ((flags & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) {
531 printf("%s: no flags specified when registering driver\n",
532 device_get_nameunit(dev));
536 CRYPTO_DRIVER_LOCK();
538 for (i = 0; i < crypto_drivers_num; i++) {
539 if (crypto_drivers[i].cc_dev == NULL &&
540 (crypto_drivers[i].cc_flags & CRYPTOCAP_F_CLEANUP) == 0) {
545 /* Out of entries, allocate some more. */
546 if (i == crypto_drivers_num) {
547 /* Be careful about wrap-around. */
548 if (2 * crypto_drivers_num <= crypto_drivers_num) {
549 CRYPTO_DRIVER_UNLOCK();
550 printf("crypto: driver count wraparound!\n");
554 newdrv = malloc(2 * crypto_drivers_num *
555 sizeof(struct cryptocap), M_CRYPTO_DATA, M_NOWAIT|M_ZERO);
556 if (newdrv == NULL) {
557 CRYPTO_DRIVER_UNLOCK();
558 printf("crypto: no space to expand driver table!\n");
562 bcopy(crypto_drivers, newdrv,
563 crypto_drivers_num * sizeof(struct cryptocap));
565 crypto_drivers_num *= 2;
567 free(crypto_drivers, M_CRYPTO_DATA);
568 crypto_drivers = newdrv;
571 /* NB: state is zero'd on free */
572 crypto_drivers[i].cc_sessions = 1; /* Mark */
573 crypto_drivers[i].cc_dev = dev;
574 crypto_drivers[i].cc_flags = flags;
576 printf("crypto: assign %s driver id %u, flags %u\n",
577 device_get_nameunit(dev), i, flags);
579 CRYPTO_DRIVER_UNLOCK();
585 * Lookup a driver by name. We match against the full device
586 * name and unit, and against just the name. The latter gives
587 * us a simple widlcarding by device name. On success return the
588 * driver/hardware identifier; otherwise return -1.
591 crypto_find_driver(const char *match)
593 int i, len = strlen(match);
595 CRYPTO_DRIVER_LOCK();
596 for (i = 0; i < crypto_drivers_num; i++) {
597 device_t dev = crypto_drivers[i].cc_dev;
599 (crypto_drivers[i].cc_flags & CRYPTOCAP_F_CLEANUP))
601 if (strncmp(match, device_get_nameunit(dev), len) == 0 ||
602 strncmp(match, device_get_name(dev), len) == 0)
605 CRYPTO_DRIVER_UNLOCK();
606 return i < crypto_drivers_num ? i : -1;
610 * Return the device_t for the specified driver or NULL
611 * if the driver identifier is invalid.
614 crypto_find_device_byhid(int hid)
616 struct cryptocap *cap = crypto_checkdriver(hid);
617 return cap != NULL ? cap->cc_dev : NULL;
621 * Return the device/driver capabilities.
624 crypto_getcaps(int hid)
626 struct cryptocap *cap = crypto_checkdriver(hid);
627 return cap != NULL ? cap->cc_flags : 0;
631 * Register support for a key-related algorithm. This routine
632 * is called once for each algorithm supported a driver.
635 crypto_kregister(u_int32_t driverid, int kalg, u_int32_t flags)
637 struct cryptocap *cap;
640 CRYPTO_DRIVER_LOCK();
642 cap = crypto_checkdriver(driverid);
644 (CRK_ALGORITM_MIN <= kalg && kalg <= CRK_ALGORITHM_MAX)) {
646 * XXX Do some performance testing to determine placing.
647 * XXX We probably need an auxiliary data structure that
648 * XXX describes relative performances.
651 cap->cc_kalg[kalg] = flags | CRYPTO_ALG_FLAG_SUPPORTED;
653 printf("crypto: %s registers key alg %u flags %u\n"
654 , device_get_nameunit(cap->cc_dev)
662 CRYPTO_DRIVER_UNLOCK();
667 * Register support for a non-key-related algorithm. This routine
668 * is called once for each such algorithm supported by a driver.
671 crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen,
674 struct cryptocap *cap;
677 CRYPTO_DRIVER_LOCK();
679 cap = crypto_checkdriver(driverid);
680 /* NB: algorithms are in the range [1..max] */
682 (CRYPTO_ALGORITHM_MIN <= alg && alg <= CRYPTO_ALGORITHM_MAX)) {
684 * XXX Do some performance testing to determine placing.
685 * XXX We probably need an auxiliary data structure that
686 * XXX describes relative performances.
689 cap->cc_alg[alg] = flags | CRYPTO_ALG_FLAG_SUPPORTED;
690 cap->cc_max_op_len[alg] = maxoplen;
692 printf("crypto: %s registers alg %u flags %u maxoplen %u\n"
693 , device_get_nameunit(cap->cc_dev)
698 cap->cc_sessions = 0; /* Unmark */
703 CRYPTO_DRIVER_UNLOCK();
708 driver_finis(struct cryptocap *cap)
712 CRYPTO_DRIVER_ASSERT();
714 ses = cap->cc_sessions;
715 kops = cap->cc_koperations;
716 bzero(cap, sizeof(*cap));
717 if (ses != 0 || kops != 0) {
719 * If there are pending sessions,
720 * just mark as invalid.
722 cap->cc_flags |= CRYPTOCAP_F_CLEANUP;
723 cap->cc_sessions = ses;
724 cap->cc_koperations = kops;
729 * Unregister a crypto driver. If there are pending sessions using it,
730 * leave enough information around so that subsequent calls using those
731 * sessions will correctly detect the driver has been unregistered and
735 crypto_unregister(u_int32_t driverid, int alg)
737 struct cryptocap *cap;
740 CRYPTO_DRIVER_LOCK();
741 cap = crypto_checkdriver(driverid);
743 (CRYPTO_ALGORITHM_MIN <= alg && alg <= CRYPTO_ALGORITHM_MAX) &&
744 cap->cc_alg[alg] != 0) {
745 cap->cc_alg[alg] = 0;
746 cap->cc_max_op_len[alg] = 0;
748 /* Was this the last algorithm ? */
749 for (i = 1; i <= CRYPTO_ALGORITHM_MAX; i++)
750 if (cap->cc_alg[i] != 0)
753 if (i == CRYPTO_ALGORITHM_MAX + 1)
758 CRYPTO_DRIVER_UNLOCK();
764 * Unregister all algorithms associated with a crypto driver.
765 * If there are pending sessions using it, leave enough information
766 * around so that subsequent calls using those sessions will
767 * correctly detect the driver has been unregistered and reroute
771 crypto_unregister_all(u_int32_t driverid)
773 struct cryptocap *cap;
776 CRYPTO_DRIVER_LOCK();
777 cap = crypto_checkdriver(driverid);
783 CRYPTO_DRIVER_UNLOCK();
789 * Clear blockage on a driver. The what parameter indicates whether
790 * the driver is now ready for cryptop's and/or cryptokop's.
793 crypto_unblock(u_int32_t driverid, int what)
795 struct cryptocap *cap;
799 cap = crypto_checkdriver(driverid);
801 if (what & CRYPTO_SYMQ)
802 cap->cc_qblocked = 0;
803 if (what & CRYPTO_ASYMQ)
804 cap->cc_kqblocked = 0;
816 * Add a crypto request to a queue, to be processed by the kernel thread.
819 crypto_dispatch(struct cryptop *crp)
821 struct cryptocap *cap;
825 cryptostats.cs_ops++;
829 binuptime(&crp->crp_tstamp);
832 hid = CRYPTO_SESID2HID(crp->crp_sid);
834 if ((crp->crp_flags & CRYPTO_F_BATCH) == 0) {
836 * Caller marked the request to be processed
837 * immediately; dispatch it directly to the
838 * driver unless the driver is currently blocked.
840 cap = crypto_checkdriver(hid);
841 /* Driver cannot disappeared when there is an active session. */
842 KASSERT(cap != NULL, ("%s: Driver disappeared.", __func__));
843 if (!cap->cc_qblocked) {
844 result = crypto_invoke(cap, crp, 0);
845 if (result != ERESTART)
848 * The driver ran out of resources, put the request on
854 TAILQ_INSERT_TAIL(&crp_q, crp, crp_next);
862 * Add an asymetric crypto request to a queue,
863 * to be processed by the kernel thread.
866 crypto_kdispatch(struct cryptkop *krp)
870 cryptostats.cs_kops++;
872 error = crypto_kinvoke(krp, krp->krp_crid);
873 if (error == ERESTART) {
875 TAILQ_INSERT_TAIL(&crp_kq, krp, krp_next);
885 * Verify a driver is suitable for the specified operation.
888 kdriver_suitable(const struct cryptocap *cap, const struct cryptkop *krp)
890 return (cap->cc_kalg[krp->krp_op] & CRYPTO_ALG_FLAG_SUPPORTED) != 0;
894 * Select a driver for an asym operation. The driver must
895 * support the necessary algorithm. The caller can constrain
896 * which device is selected with the flags parameter. The
897 * algorithm we use here is pretty stupid; just use the first
898 * driver that supports the algorithms we need. If there are
899 * multiple suitable drivers we choose the driver with the
900 * fewest active operations. We prefer hardware-backed
901 * drivers to software ones when either may be used.
903 static struct cryptocap *
904 crypto_select_kdriver(const struct cryptkop *krp, int flags)
906 struct cryptocap *cap, *best, *blocked;
909 CRYPTO_DRIVER_ASSERT();
912 * Look first for hardware crypto devices if permitted.
914 if (flags & CRYPTOCAP_F_HARDWARE)
915 match = CRYPTOCAP_F_HARDWARE;
917 match = CRYPTOCAP_F_SOFTWARE;
921 for (hid = 0; hid < crypto_drivers_num; hid++) {
922 cap = &crypto_drivers[hid];
924 * If it's not initialized, is in the process of
925 * going away, or is not appropriate (hardware
926 * or software based on match), then skip.
928 if (cap->cc_dev == NULL ||
929 (cap->cc_flags & CRYPTOCAP_F_CLEANUP) ||
930 (cap->cc_flags & match) == 0)
933 /* verify all the algorithms are supported. */
934 if (kdriver_suitable(cap, krp)) {
936 cap->cc_koperations < best->cc_koperations)
942 if (match == CRYPTOCAP_F_HARDWARE && (flags & CRYPTOCAP_F_SOFTWARE)) {
943 /* sort of an Algol 68-style for loop */
944 match = CRYPTOCAP_F_SOFTWARE;
951 * Dispatch an asymmetric crypto request.
954 crypto_kinvoke(struct cryptkop *krp, int crid)
956 struct cryptocap *cap = NULL;
959 KASSERT(krp != NULL, ("%s: krp == NULL", __func__));
960 KASSERT(krp->krp_callback != NULL,
961 ("%s: krp->crp_callback == NULL", __func__));
963 CRYPTO_DRIVER_LOCK();
964 if ((crid & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) {
965 cap = crypto_checkdriver(crid);
968 * Driver present, it must support the necessary
969 * algorithm and, if s/w drivers are excluded,
970 * it must be registered as hardware-backed.
972 if (!kdriver_suitable(cap, krp) ||
973 (!crypto_devallowsoft &&
974 (cap->cc_flags & CRYPTOCAP_F_HARDWARE) == 0))
979 * No requested driver; select based on crid flags.
981 if (!crypto_devallowsoft) /* NB: disallow s/w drivers */
982 crid &= ~CRYPTOCAP_F_SOFTWARE;
983 cap = crypto_select_kdriver(krp, crid);
985 if (cap != NULL && !cap->cc_kqblocked) {
986 krp->krp_hid = cap - crypto_drivers;
987 cap->cc_koperations++;
988 CRYPTO_DRIVER_UNLOCK();
989 error = CRYPTODEV_KPROCESS(cap->cc_dev, krp, 0);
990 CRYPTO_DRIVER_LOCK();
991 if (error == ERESTART) {
992 cap->cc_koperations--;
993 CRYPTO_DRIVER_UNLOCK();
998 * NB: cap is !NULL if device is blocked; in
999 * that case return ERESTART so the operation
1000 * is resubmitted if possible.
1002 error = (cap == NULL) ? ENODEV : ERESTART;
1004 CRYPTO_DRIVER_UNLOCK();
1007 krp->krp_status = error;
1013 #ifdef CRYPTO_TIMING
1015 crypto_tstat(struct cryptotstat *ts, struct bintime *bt)
1017 struct bintime now, delta;
1023 delta.frac = now.frac - bt->frac;
1024 delta.sec = now.sec - bt->sec;
1027 bintime2timespec(&delta, &t);
1028 timespecadd(&ts->acc, &t);
1029 if (timespeccmp(&t, &ts->min, <))
1031 if (timespeccmp(&t, &ts->max, >))
1040 * Dispatch a crypto request to the appropriate crypto devices.
1043 crypto_invoke(struct cryptocap *cap, struct cryptop *crp, int hint)
1046 KASSERT(crp != NULL, ("%s: crp == NULL", __func__));
1047 KASSERT(crp->crp_callback != NULL,
1048 ("%s: crp->crp_callback == NULL", __func__));
1049 KASSERT(crp->crp_desc != NULL, ("%s: crp->crp_desc == NULL", __func__));
1051 #ifdef CRYPTO_TIMING
1053 crypto_tstat(&cryptostats.cs_invoke, &crp->crp_tstamp);
1055 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP) {
1056 struct cryptodesc *crd;
1060 * Driver has unregistered; migrate the session and return
1061 * an error to the caller so they'll resubmit the op.
1063 * XXX: What if there are more already queued requests for this
1066 crypto_freesession(crp->crp_sid);
1068 for (crd = crp->crp_desc; crd->crd_next; crd = crd->crd_next)
1069 crd->CRD_INI.cri_next = &(crd->crd_next->CRD_INI);
1071 /* XXX propagate flags from initial session? */
1072 if (crypto_newsession(&nid, &(crp->crp_desc->CRD_INI),
1073 CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE) == 0)
1076 crp->crp_etype = EAGAIN;
1081 * Invoke the driver to process the request.
1083 return CRYPTODEV_PROCESS(cap->cc_dev, crp, hint);
1088 * Release a set of crypto descriptors.
1091 crypto_freereq(struct cryptop *crp)
1093 struct cryptodesc *crd;
1100 struct cryptop *crp2;
1103 TAILQ_FOREACH(crp2, &crp_q, crp_next) {
1104 KASSERT(crp2 != crp,
1105 ("Freeing cryptop from the crypto queue (%p).",
1110 TAILQ_FOREACH(crp2, &crp_ret_q, crp_next) {
1111 KASSERT(crp2 != crp,
1112 ("Freeing cryptop from the return queue (%p).",
1115 CRYPTO_RETQ_UNLOCK();
1119 while ((crd = crp->crp_desc) != NULL) {
1120 crp->crp_desc = crd->crd_next;
1121 uma_zfree(cryptodesc_zone, crd);
1123 uma_zfree(cryptop_zone, crp);
1127 * Acquire a set of crypto descriptors.
1130 crypto_getreq(int num)
1132 struct cryptodesc *crd;
1133 struct cryptop *crp;
1135 crp = uma_zalloc(cryptop_zone, M_NOWAIT|M_ZERO);
1138 crd = uma_zalloc(cryptodesc_zone, M_NOWAIT|M_ZERO);
1140 crypto_freereq(crp);
1144 crd->crd_next = crp->crp_desc;
1145 crp->crp_desc = crd;
1152 * Invoke the callback on behalf of the driver.
1155 crypto_done(struct cryptop *crp)
1157 KASSERT((crp->crp_flags & CRYPTO_F_DONE) == 0,
1158 ("crypto_done: op already done, flags 0x%x", crp->crp_flags));
1159 crp->crp_flags |= CRYPTO_F_DONE;
1160 if (crp->crp_etype != 0)
1161 cryptostats.cs_errs++;
1162 #ifdef CRYPTO_TIMING
1164 crypto_tstat(&cryptostats.cs_done, &crp->crp_tstamp);
1167 * CBIMM means unconditionally do the callback immediately;
1168 * CBIFSYNC means do the callback immediately only if the
1169 * operation was done synchronously. Both are used to avoid
1170 * doing extraneous context switches; the latter is mostly
1171 * used with the software crypto driver.
1173 if ((crp->crp_flags & CRYPTO_F_CBIMM) ||
1174 ((crp->crp_flags & CRYPTO_F_CBIFSYNC) &&
1175 (CRYPTO_SESID2CAPS(crp->crp_sid) & CRYPTOCAP_F_SYNC))) {
1177 * Do the callback directly. This is ok when the
1178 * callback routine does very little (e.g. the
1179 * /dev/crypto callback method just does a wakeup).
1181 #ifdef CRYPTO_TIMING
1182 if (crypto_timing) {
1184 * NB: We must copy the timestamp before
1185 * doing the callback as the cryptop is
1186 * likely to be reclaimed.
1188 struct bintime t = crp->crp_tstamp;
1189 crypto_tstat(&cryptostats.cs_cb, &t);
1190 crp->crp_callback(crp);
1191 crypto_tstat(&cryptostats.cs_finis, &t);
1194 crp->crp_callback(crp);
1197 * Normal case; queue the callback for the thread.
1200 if (CRYPTO_RETQ_EMPTY())
1201 wakeup_one(&crp_ret_q); /* shared wait channel */
1202 TAILQ_INSERT_TAIL(&crp_ret_q, crp, crp_next);
1203 CRYPTO_RETQ_UNLOCK();
1208 * Invoke the callback on behalf of the driver.
1211 crypto_kdone(struct cryptkop *krp)
1213 struct cryptocap *cap;
1215 if (krp->krp_status != 0)
1216 cryptostats.cs_kerrs++;
1217 CRYPTO_DRIVER_LOCK();
1218 /* XXX: What if driver is loaded in the meantime? */
1219 if (krp->krp_hid < crypto_drivers_num) {
1220 cap = &crypto_drivers[krp->krp_hid];
1221 KASSERT(cap->cc_koperations > 0, ("cc_koperations == 0"));
1222 cap->cc_koperations--;
1223 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP)
1226 CRYPTO_DRIVER_UNLOCK();
1228 if (CRYPTO_RETQ_EMPTY())
1229 wakeup_one(&crp_ret_q); /* shared wait channel */
1230 TAILQ_INSERT_TAIL(&crp_ret_kq, krp, krp_next);
1231 CRYPTO_RETQ_UNLOCK();
1235 crypto_getfeat(int *featp)
1237 int hid, kalg, feat = 0;
1239 CRYPTO_DRIVER_LOCK();
1240 for (hid = 0; hid < crypto_drivers_num; hid++) {
1241 const struct cryptocap *cap = &crypto_drivers[hid];
1243 if ((cap->cc_flags & CRYPTOCAP_F_SOFTWARE) &&
1244 !crypto_devallowsoft) {
1247 for (kalg = 0; kalg < CRK_ALGORITHM_MAX; kalg++)
1248 if (cap->cc_kalg[kalg] & CRYPTO_ALG_FLAG_SUPPORTED)
1251 CRYPTO_DRIVER_UNLOCK();
1257 * Terminate a thread at module unload. The process that
1258 * initiated this is waiting for us to signal that we're gone;
1259 * wake it up and exit. We use the driver table lock to insure
1260 * we don't do the wakeup before they're waiting. There is no
1261 * race here because the waiter sleeps on the proc lock for the
1262 * thread so it gets notified at the right time because of an
1263 * extra wakeup that's done in exit1().
1266 crypto_finis(void *chan)
1268 CRYPTO_DRIVER_LOCK();
1270 CRYPTO_DRIVER_UNLOCK();
1275 * Crypto thread, dispatches crypto requests.
1280 struct cryptop *crp, *submit;
1281 struct cryptkop *krp;
1282 struct cryptocap *cap;
1286 #if defined(__i386__) || defined(__amd64__)
1287 fpu_kern_thread(FPU_KERN_NORMAL);
1293 * Find the first element in the queue that can be
1294 * processed and look-ahead to see if multiple ops
1295 * are ready for the same driver.
1299 TAILQ_FOREACH(crp, &crp_q, crp_next) {
1300 hid = CRYPTO_SESID2HID(crp->crp_sid);
1301 cap = crypto_checkdriver(hid);
1303 * Driver cannot disappeared when there is an active
1306 KASSERT(cap != NULL, ("%s:%u Driver disappeared.",
1307 __func__, __LINE__));
1308 if (cap == NULL || cap->cc_dev == NULL) {
1309 /* Op needs to be migrated, process it. */
1314 if (!cap->cc_qblocked) {
1315 if (submit != NULL) {
1317 * We stop on finding another op,
1318 * regardless whether its for the same
1319 * driver or not. We could keep
1320 * searching the queue but it might be
1321 * better to just use a per-driver
1324 if (CRYPTO_SESID2HID(submit->crp_sid) == hid)
1325 hint = CRYPTO_HINT_MORE;
1329 if ((submit->crp_flags & CRYPTO_F_BATCH) == 0)
1331 /* keep scanning for more are q'd */
1335 if (submit != NULL) {
1336 TAILQ_REMOVE(&crp_q, submit, crp_next);
1337 hid = CRYPTO_SESID2HID(submit->crp_sid);
1338 cap = crypto_checkdriver(hid);
1339 KASSERT(cap != NULL, ("%s:%u Driver disappeared.",
1340 __func__, __LINE__));
1341 result = crypto_invoke(cap, submit, hint);
1342 if (result == ERESTART) {
1344 * The driver ran out of resources, mark the
1345 * driver ``blocked'' for cryptop's and put
1346 * the request back in the queue. It would
1347 * best to put the request back where we got
1348 * it but that's hard so for now we put it
1349 * at the front. This should be ok; putting
1350 * it at the end does not work.
1352 /* XXX validate sid again? */
1353 crypto_drivers[CRYPTO_SESID2HID(submit->crp_sid)].cc_qblocked = 1;
1354 TAILQ_INSERT_HEAD(&crp_q, submit, crp_next);
1355 cryptostats.cs_blocks++;
1359 /* As above, but for key ops */
1360 TAILQ_FOREACH(krp, &crp_kq, krp_next) {
1361 cap = crypto_checkdriver(krp->krp_hid);
1362 if (cap == NULL || cap->cc_dev == NULL) {
1364 * Operation needs to be migrated, invalidate
1365 * the assigned device so it will reselect a
1366 * new one below. Propagate the original
1367 * crid selection flags if supplied.
1369 krp->krp_hid = krp->krp_crid &
1370 (CRYPTOCAP_F_SOFTWARE|CRYPTOCAP_F_HARDWARE);
1371 if (krp->krp_hid == 0)
1373 CRYPTOCAP_F_SOFTWARE|CRYPTOCAP_F_HARDWARE;
1376 if (!cap->cc_kqblocked)
1380 TAILQ_REMOVE(&crp_kq, krp, krp_next);
1381 result = crypto_kinvoke(krp, krp->krp_hid);
1382 if (result == ERESTART) {
1384 * The driver ran out of resources, mark the
1385 * driver ``blocked'' for cryptkop's and put
1386 * the request back in the queue. It would
1387 * best to put the request back where we got
1388 * it but that's hard so for now we put it
1389 * at the front. This should be ok; putting
1390 * it at the end does not work.
1392 /* XXX validate sid again? */
1393 crypto_drivers[krp->krp_hid].cc_kqblocked = 1;
1394 TAILQ_INSERT_HEAD(&crp_kq, krp, krp_next);
1395 cryptostats.cs_kblocks++;
1399 if (submit == NULL && krp == NULL) {
1401 * Nothing more to be processed. Sleep until we're
1402 * woken because there are more ops to process.
1403 * This happens either by submission or by a driver
1404 * becoming unblocked and notifying us through
1405 * crypto_unblock. Note that when we wakeup we
1406 * start processing each queue again from the
1407 * front. It's not clear that it's important to
1408 * preserve this ordering since ops may finish
1409 * out of order if dispatched to different devices
1410 * and some become blocked while others do not.
1413 msleep(&crp_q, &crypto_q_mtx, PWAIT, "crypto_wait", 0);
1415 if (cryptoproc == NULL)
1417 cryptostats.cs_intrs++;
1422 crypto_finis(&crp_q);
1426 * Crypto returns thread, does callbacks for processed crypto requests.
1427 * Callbacks are done here, rather than in the crypto drivers, because
1428 * callbacks typically are expensive and would slow interrupt handling.
1431 crypto_ret_proc(void)
1433 struct cryptop *crpt;
1434 struct cryptkop *krpt;
1438 /* Harvest return q's for completed ops */
1439 crpt = TAILQ_FIRST(&crp_ret_q);
1441 TAILQ_REMOVE(&crp_ret_q, crpt, crp_next);
1443 krpt = TAILQ_FIRST(&crp_ret_kq);
1445 TAILQ_REMOVE(&crp_ret_kq, krpt, krp_next);
1447 if (crpt != NULL || krpt != NULL) {
1448 CRYPTO_RETQ_UNLOCK();
1450 * Run callbacks unlocked.
1453 #ifdef CRYPTO_TIMING
1454 if (crypto_timing) {
1456 * NB: We must copy the timestamp before
1457 * doing the callback as the cryptop is
1458 * likely to be reclaimed.
1460 struct bintime t = crpt->crp_tstamp;
1461 crypto_tstat(&cryptostats.cs_cb, &t);
1462 crpt->crp_callback(crpt);
1463 crypto_tstat(&cryptostats.cs_finis, &t);
1466 crpt->crp_callback(crpt);
1469 krpt->krp_callback(krpt);
1473 * Nothing more to be processed. Sleep until we're
1474 * woken because there are more returns to process.
1476 msleep(&crp_ret_q, &crypto_ret_q_mtx, PWAIT,
1477 "crypto_ret_wait", 0);
1478 if (cryptoretproc == NULL)
1480 cryptostats.cs_rets++;
1483 CRYPTO_RETQ_UNLOCK();
1485 crypto_finis(&crp_ret_q);
1490 db_show_drivers(void)
1494 db_printf("%12s %4s %4s %8s %2s %2s\n"
1502 for (hid = 0; hid < crypto_drivers_num; hid++) {
1503 const struct cryptocap *cap = &crypto_drivers[hid];
1504 if (cap->cc_dev == NULL)
1506 db_printf("%-12s %4u %4u %08x %2u %2u\n"
1507 , device_get_nameunit(cap->cc_dev)
1509 , cap->cc_koperations
1517 DB_SHOW_COMMAND(crypto, db_show_crypto)
1519 struct cryptop *crp;
1524 db_printf("%4s %8s %4s %4s %4s %4s %8s %8s\n",
1525 "HID", "Caps", "Ilen", "Olen", "Etype", "Flags",
1526 "Desc", "Callback");
1527 TAILQ_FOREACH(crp, &crp_q, crp_next) {
1528 db_printf("%4u %08x %4u %4u %4u %04x %8p %8p\n"
1529 , (int) CRYPTO_SESID2HID(crp->crp_sid)
1530 , (int) CRYPTO_SESID2CAPS(crp->crp_sid)
1531 , crp->crp_ilen, crp->crp_olen
1538 if (!TAILQ_EMPTY(&crp_ret_q)) {
1539 db_printf("\n%4s %4s %4s %8s\n",
1540 "HID", "Etype", "Flags", "Callback");
1541 TAILQ_FOREACH(crp, &crp_ret_q, crp_next) {
1542 db_printf("%4u %4u %04x %8p\n"
1543 , (int) CRYPTO_SESID2HID(crp->crp_sid)
1552 DB_SHOW_COMMAND(kcrypto, db_show_kcrypto)
1554 struct cryptkop *krp;
1559 db_printf("%4s %5s %4s %4s %8s %4s %8s\n",
1560 "Op", "Status", "#IP", "#OP", "CRID", "HID", "Callback");
1561 TAILQ_FOREACH(krp, &crp_kq, krp_next) {
1562 db_printf("%4u %5u %4u %4u %08x %4u %8p\n"
1565 , krp->krp_iparams, krp->krp_oparams
1566 , krp->krp_crid, krp->krp_hid
1570 if (!TAILQ_EMPTY(&crp_ret_q)) {
1571 db_printf("%4s %5s %8s %4s %8s\n",
1572 "Op", "Status", "CRID", "HID", "Callback");
1573 TAILQ_FOREACH(krp, &crp_ret_kq, krp_next) {
1574 db_printf("%4u %5u %08x %4u %8p\n"
1577 , krp->krp_crid, krp->krp_hid
1585 int crypto_modevent(module_t mod, int type, void *unused);
1588 * Initialization code, both for static and dynamic loading.
1589 * Note this is not invoked with the usual MODULE_DECLARE
1590 * mechanism but instead is listed as a dependency by the
1591 * cryptosoft driver. This guarantees proper ordering of
1592 * calls on module load/unload.
1595 crypto_modevent(module_t mod, int type, void *unused)
1601 error = crypto_init();
1602 if (error == 0 && bootverbose)
1603 printf("crypto: <crypto core>\n");
1606 /*XXX disallow if active sessions */
1613 MODULE_VERSION(crypto, 1);
1614 MODULE_DEPEND(crypto, zlib, 1, 1, 1);