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>
67 #include <sys/module.h>
68 #include <sys/mutex.h>
69 #include <sys/malloc.h>
72 #include <sys/sysctl.h>
77 #include <opencrypto/cryptodev.h>
78 #include <opencrypto/xform.h> /* XXX for M_XDATA */
82 #include "cryptodev_if.h"
84 #if defined(__i386__) || defined(__amd64__)
85 #include <machine/pcb.h>
88 SDT_PROVIDER_DEFINE(opencrypto);
91 * Crypto drivers register themselves by allocating a slot in the
92 * crypto_drivers table with crypto_get_driverid() and then registering
93 * each algorithm they support with crypto_register() and crypto_kregister().
95 static struct mtx crypto_drivers_mtx; /* lock on driver table */
96 #define CRYPTO_DRIVER_LOCK() mtx_lock(&crypto_drivers_mtx)
97 #define CRYPTO_DRIVER_UNLOCK() mtx_unlock(&crypto_drivers_mtx)
98 #define CRYPTO_DRIVER_ASSERT() mtx_assert(&crypto_drivers_mtx, MA_OWNED)
101 * Crypto device/driver capabilities structure.
104 * (d) - protected by CRYPTO_DRIVER_LOCK()
105 * (q) - protected by CRYPTO_Q_LOCK()
106 * Not tagged fields are read-only.
109 device_t cc_dev; /* (d) device/driver */
110 u_int32_t cc_sessions; /* (d) # of sessions */
111 u_int32_t cc_koperations; /* (d) # os asym operations */
113 * Largest possible operator length (in bits) for each type of
114 * encryption algorithm. XXX not used
116 u_int16_t cc_max_op_len[CRYPTO_ALGORITHM_MAX + 1];
117 u_int8_t cc_alg[CRYPTO_ALGORITHM_MAX + 1];
118 u_int8_t cc_kalg[CRK_ALGORITHM_MAX + 1];
120 int cc_flags; /* (d) flags */
121 #define CRYPTOCAP_F_CLEANUP 0x80000000 /* needs resource cleanup */
122 int cc_qblocked; /* (q) symmetric q blocked */
123 int cc_kqblocked; /* (q) asymmetric q blocked */
125 static struct cryptocap *crypto_drivers = NULL;
126 static int crypto_drivers_num = 0;
129 * There are two queues for crypto requests; one for symmetric (e.g.
130 * cipher) operations and one for asymmetric (e.g. MOD)operations.
131 * A single mutex is used to lock access to both queues. We could
132 * have one per-queue but having one simplifies handling of block/unblock
135 static int crp_sleep = 0;
136 static TAILQ_HEAD(,cryptop) crp_q; /* request queues */
137 static TAILQ_HEAD(,cryptkop) crp_kq;
138 static struct mtx crypto_q_mtx;
139 #define CRYPTO_Q_LOCK() mtx_lock(&crypto_q_mtx)
140 #define CRYPTO_Q_UNLOCK() mtx_unlock(&crypto_q_mtx)
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 * mutex 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 mtx crypto_ret_q_mtx;
153 #define CRYPTO_RETQ_LOCK() mtx_lock(&crypto_ret_q_mtx)
154 #define CRYPTO_RETQ_UNLOCK() mtx_unlock(&crypto_ret_q_mtx)
155 #define CRYPTO_RETQ_EMPTY() (TAILQ_EMPTY(&crp_ret_q) && TAILQ_EMPTY(&crp_ret_kq))
157 static uma_zone_t cryptop_zone;
158 static uma_zone_t cryptodesc_zone;
160 int crypto_userasymcrypto = 1; /* userland may do asym crypto reqs */
161 SYSCTL_INT(_kern, OID_AUTO, userasymcrypto, CTLFLAG_RW,
162 &crypto_userasymcrypto, 0,
163 "Enable/disable user-mode access to asymmetric crypto support");
164 int crypto_devallowsoft = 0; /* only use hardware crypto */
165 SYSCTL_INT(_kern, OID_AUTO, cryptodevallowsoft, CTLFLAG_RW,
166 &crypto_devallowsoft, 0,
167 "Enable/disable use of software crypto by /dev/crypto");
169 MALLOC_DEFINE(M_CRYPTO_DATA, "crypto", "crypto session records");
171 static void crypto_proc(void);
172 static struct proc *cryptoproc;
173 static void crypto_ret_proc(void);
174 static struct proc *cryptoretproc;
175 static void crypto_destroy(void);
176 static int crypto_invoke(struct cryptocap *cap, struct cryptop *crp, int hint);
177 static int crypto_kinvoke(struct cryptkop *krp, int flags);
179 static struct cryptostats cryptostats;
180 SYSCTL_STRUCT(_kern, OID_AUTO, crypto_stats, CTLFLAG_RW, &cryptostats,
181 cryptostats, "Crypto system statistics");
184 static int crypto_timing = 0;
185 SYSCTL_INT(_debug, OID_AUTO, crypto_timing, CTLFLAG_RW,
186 &crypto_timing, 0, "Enable/disable crypto timing support");
194 mtx_init(&crypto_drivers_mtx, "crypto", "crypto driver table",
199 mtx_init(&crypto_q_mtx, "crypto", "crypto op queues", MTX_DEF);
201 TAILQ_INIT(&crp_ret_q);
202 TAILQ_INIT(&crp_ret_kq);
203 mtx_init(&crypto_ret_q_mtx, "crypto", "crypto return queues", MTX_DEF);
205 cryptop_zone = uma_zcreate("cryptop", sizeof (struct cryptop),
207 UMA_ALIGN_PTR, UMA_ZONE_ZINIT);
208 cryptodesc_zone = uma_zcreate("cryptodesc", sizeof (struct cryptodesc),
210 UMA_ALIGN_PTR, UMA_ZONE_ZINIT);
211 if (cryptodesc_zone == NULL || cryptop_zone == NULL) {
212 printf("crypto_init: cannot setup crypto zones\n");
217 crypto_drivers_num = CRYPTO_DRIVERS_INITIAL;
218 crypto_drivers = malloc(crypto_drivers_num *
219 sizeof(struct cryptocap), M_CRYPTO_DATA, M_NOWAIT | M_ZERO);
220 if (crypto_drivers == NULL) {
221 printf("crypto_init: cannot setup crypto drivers\n");
226 error = kproc_create((void (*)(void *)) crypto_proc, NULL,
227 &cryptoproc, 0, 0, "crypto");
229 printf("crypto_init: cannot start crypto thread; error %d",
234 error = kproc_create((void (*)(void *)) crypto_ret_proc, NULL,
235 &cryptoretproc, 0, 0, "crypto returns");
237 printf("crypto_init: cannot start cryptoret thread; error %d",
248 * Signal a crypto thread to terminate. We use the driver
249 * table lock to synchronize the sleep/wakeups so that we
250 * are sure the threads have terminated before we release
251 * the data structures they use. See crypto_finis below
252 * for the other half of this song-and-dance.
255 crypto_terminate(struct proc **pp, void *q)
259 mtx_assert(&crypto_drivers_mtx, MA_OWNED);
264 PROC_LOCK(p); /* NB: insure we don't miss wakeup */
265 CRYPTO_DRIVER_UNLOCK(); /* let crypto_finis progress */
266 msleep(p, &p->p_mtx, PWAIT, "crypto_destroy", 0);
268 CRYPTO_DRIVER_LOCK();
276 * Terminate any crypto threads.
278 CRYPTO_DRIVER_LOCK();
279 crypto_terminate(&cryptoproc, &crp_q);
280 crypto_terminate(&cryptoretproc, &crp_ret_q);
281 CRYPTO_DRIVER_UNLOCK();
283 /* XXX flush queues??? */
286 * Reclaim dynamically allocated resources.
288 if (crypto_drivers != NULL)
289 free(crypto_drivers, M_CRYPTO_DATA);
291 if (cryptodesc_zone != NULL)
292 uma_zdestroy(cryptodesc_zone);
293 if (cryptop_zone != NULL)
294 uma_zdestroy(cryptop_zone);
295 mtx_destroy(&crypto_q_mtx);
296 mtx_destroy(&crypto_ret_q_mtx);
297 mtx_destroy(&crypto_drivers_mtx);
300 static struct cryptocap *
301 crypto_checkdriver(u_int32_t hid)
303 if (crypto_drivers == NULL)
305 return (hid >= crypto_drivers_num ? NULL : &crypto_drivers[hid]);
309 * Compare a driver's list of supported algorithms against another
310 * list; return non-zero if all algorithms are supported.
313 driver_suitable(const struct cryptocap *cap, const struct cryptoini *cri)
315 const struct cryptoini *cr;
317 /* See if all the algorithms are supported. */
318 for (cr = cri; cr; cr = cr->cri_next)
319 if (cap->cc_alg[cr->cri_alg] == 0)
325 * Select a driver for a new session that supports the specified
326 * algorithms and, optionally, is constrained according to the flags.
327 * The algorithm we use here is pretty stupid; just use the
328 * first driver that supports all the algorithms we need. If there
329 * are multiple drivers we choose the driver with the fewest active
330 * sessions. We prefer hardware-backed drivers to software ones.
332 * XXX We need more smarts here (in real life too, but that's
333 * XXX another story altogether).
335 static struct cryptocap *
336 crypto_select_driver(const struct cryptoini *cri, int flags)
338 struct cryptocap *cap, *best;
341 CRYPTO_DRIVER_ASSERT();
344 * Look first for hardware crypto devices if permitted.
346 if (flags & CRYPTOCAP_F_HARDWARE)
347 match = CRYPTOCAP_F_HARDWARE;
349 match = CRYPTOCAP_F_SOFTWARE;
352 for (hid = 0; hid < crypto_drivers_num; hid++) {
353 cap = &crypto_drivers[hid];
355 * If it's not initialized, is in the process of
356 * going away, or is not appropriate (hardware
357 * or software based on match), then skip.
359 if (cap->cc_dev == NULL ||
360 (cap->cc_flags & CRYPTOCAP_F_CLEANUP) ||
361 (cap->cc_flags & match) == 0)
364 /* verify all the algorithms are supported. */
365 if (driver_suitable(cap, cri)) {
367 cap->cc_sessions < best->cc_sessions)
371 if (best == NULL && match == CRYPTOCAP_F_HARDWARE &&
372 (flags & CRYPTOCAP_F_SOFTWARE)) {
373 /* sort of an Algol 68-style for loop */
374 match = CRYPTOCAP_F_SOFTWARE;
381 * Create a new session. The crid argument specifies a crypto
382 * driver to use or constraints on a driver to select (hardware
383 * only, software only, either). Whatever driver is selected
384 * must be capable of the requested crypto algorithms.
387 crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int crid)
389 struct cryptocap *cap;
393 CRYPTO_DRIVER_LOCK();
394 if ((crid & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) {
396 * Use specified driver; verify it is capable.
398 cap = crypto_checkdriver(crid);
399 if (cap != NULL && !driver_suitable(cap, cri))
403 * No requested driver; select based on crid flags.
405 cap = crypto_select_driver(cri, crid);
407 * if NULL then can't do everything in one session.
408 * XXX Fix this. We need to inject a "virtual" session
409 * XXX layer right about here.
413 /* Call the driver initialization routine. */
414 hid = cap - crypto_drivers;
415 lid = hid; /* Pass the driver ID. */
416 err = CRYPTODEV_NEWSESSION(cap->cc_dev, &lid, cri);
418 (*sid) = (cap->cc_flags & 0xff000000)
419 | (hid & 0x00ffffff);
421 (*sid) |= (lid & 0xffffffff);
424 CRYPTDEB("dev newsession failed");
426 CRYPTDEB("no driver");
429 CRYPTO_DRIVER_UNLOCK();
434 crypto_remove(struct cryptocap *cap)
437 mtx_assert(&crypto_drivers_mtx, MA_OWNED);
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 printf("%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 printf("crypto: driver count wraparound!\n");
517 newdrv = malloc(2 * crypto_drivers_num *
518 sizeof(struct cryptocap), M_CRYPTO_DATA, M_NOWAIT|M_ZERO);
519 if (newdrv == NULL) {
520 CRYPTO_DRIVER_UNLOCK();
521 printf("crypto: no space to expand driver table!\n");
525 bcopy(crypto_drivers, newdrv,
526 crypto_drivers_num * sizeof(struct cryptocap));
528 crypto_drivers_num *= 2;
530 free(crypto_drivers, M_CRYPTO_DATA);
531 crypto_drivers = newdrv;
534 /* NB: state is zero'd on free */
535 crypto_drivers[i].cc_sessions = 1; /* Mark */
536 crypto_drivers[i].cc_dev = dev;
537 crypto_drivers[i].cc_flags = flags;
539 printf("crypto: assign %s driver id %u, flags %u\n",
540 device_get_nameunit(dev), i, flags);
542 CRYPTO_DRIVER_UNLOCK();
548 * Lookup a driver by name. We match against the full device
549 * name and unit, and against just the name. The latter gives
550 * us a simple widlcarding by device name. On success return the
551 * driver/hardware identifier; otherwise return -1.
554 crypto_find_driver(const char *match)
556 int i, len = strlen(match);
558 CRYPTO_DRIVER_LOCK();
559 for (i = 0; i < crypto_drivers_num; i++) {
560 device_t dev = crypto_drivers[i].cc_dev;
562 (crypto_drivers[i].cc_flags & CRYPTOCAP_F_CLEANUP))
564 if (strncmp(match, device_get_nameunit(dev), len) == 0 ||
565 strncmp(match, device_get_name(dev), len) == 0)
568 CRYPTO_DRIVER_UNLOCK();
569 return i < crypto_drivers_num ? i : -1;
573 * Return the device_t for the specified driver or NULL
574 * if the driver identifier is invalid.
577 crypto_find_device_byhid(int hid)
579 struct cryptocap *cap = crypto_checkdriver(hid);
580 return cap != NULL ? cap->cc_dev : NULL;
584 * Return the device/driver capabilities.
587 crypto_getcaps(int hid)
589 struct cryptocap *cap = crypto_checkdriver(hid);
590 return cap != NULL ? cap->cc_flags : 0;
594 * Register support for a key-related algorithm. This routine
595 * is called once for each algorithm supported a driver.
598 crypto_kregister(u_int32_t driverid, int kalg, u_int32_t flags)
600 struct cryptocap *cap;
603 CRYPTO_DRIVER_LOCK();
605 cap = crypto_checkdriver(driverid);
607 (CRK_ALGORITM_MIN <= kalg && kalg <= CRK_ALGORITHM_MAX)) {
609 * XXX Do some performance testing to determine placing.
610 * XXX We probably need an auxiliary data structure that
611 * XXX describes relative performances.
614 cap->cc_kalg[kalg] = flags | CRYPTO_ALG_FLAG_SUPPORTED;
616 printf("crypto: %s registers key alg %u flags %u\n"
617 , device_get_nameunit(cap->cc_dev)
625 CRYPTO_DRIVER_UNLOCK();
630 * Register support for a non-key-related algorithm. This routine
631 * is called once for each such algorithm supported by a driver.
634 crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen,
637 struct cryptocap *cap;
640 CRYPTO_DRIVER_LOCK();
642 cap = crypto_checkdriver(driverid);
643 /* NB: algorithms are in the range [1..max] */
645 (CRYPTO_ALGORITHM_MIN <= alg && alg <= CRYPTO_ALGORITHM_MAX)) {
647 * XXX Do some performance testing to determine placing.
648 * XXX We probably need an auxiliary data structure that
649 * XXX describes relative performances.
652 cap->cc_alg[alg] = flags | CRYPTO_ALG_FLAG_SUPPORTED;
653 cap->cc_max_op_len[alg] = maxoplen;
655 printf("crypto: %s registers alg %u flags %u maxoplen %u\n"
656 , device_get_nameunit(cap->cc_dev)
661 cap->cc_sessions = 0; /* Unmark */
666 CRYPTO_DRIVER_UNLOCK();
671 driver_finis(struct cryptocap *cap)
675 CRYPTO_DRIVER_ASSERT();
677 ses = cap->cc_sessions;
678 kops = cap->cc_koperations;
679 bzero(cap, sizeof(*cap));
680 if (ses != 0 || kops != 0) {
682 * If there are pending sessions,
683 * just mark as invalid.
685 cap->cc_flags |= CRYPTOCAP_F_CLEANUP;
686 cap->cc_sessions = ses;
687 cap->cc_koperations = kops;
692 * Unregister a crypto driver. If there are pending sessions using it,
693 * leave enough information around so that subsequent calls using those
694 * sessions will correctly detect the driver has been unregistered and
698 crypto_unregister(u_int32_t driverid, int alg)
700 struct cryptocap *cap;
703 CRYPTO_DRIVER_LOCK();
704 cap = crypto_checkdriver(driverid);
706 (CRYPTO_ALGORITHM_MIN <= alg && alg <= CRYPTO_ALGORITHM_MAX) &&
707 cap->cc_alg[alg] != 0) {
708 cap->cc_alg[alg] = 0;
709 cap->cc_max_op_len[alg] = 0;
711 /* Was this the last algorithm ? */
712 for (i = 1; i <= CRYPTO_ALGORITHM_MAX; i++)
713 if (cap->cc_alg[i] != 0)
716 if (i == CRYPTO_ALGORITHM_MAX + 1)
721 CRYPTO_DRIVER_UNLOCK();
727 * Unregister all algorithms associated with a crypto driver.
728 * If there are pending sessions using it, leave enough information
729 * around so that subsequent calls using those sessions will
730 * correctly detect the driver has been unregistered and reroute
734 crypto_unregister_all(u_int32_t driverid)
736 struct cryptocap *cap;
739 CRYPTO_DRIVER_LOCK();
740 cap = crypto_checkdriver(driverid);
746 CRYPTO_DRIVER_UNLOCK();
752 * Clear blockage on a driver. The what parameter indicates whether
753 * the driver is now ready for cryptop's and/or cryptokop's.
756 crypto_unblock(u_int32_t driverid, int what)
758 struct cryptocap *cap;
762 cap = crypto_checkdriver(driverid);
764 if (what & CRYPTO_SYMQ)
765 cap->cc_qblocked = 0;
766 if (what & CRYPTO_ASYMQ)
767 cap->cc_kqblocked = 0;
779 * Add a crypto request to a queue, to be processed by the kernel thread.
782 crypto_dispatch(struct cryptop *crp)
784 struct cryptocap *cap;
788 cryptostats.cs_ops++;
792 binuptime(&crp->crp_tstamp);
795 hid = CRYPTO_SESID2HID(crp->crp_sid);
797 if ((crp->crp_flags & CRYPTO_F_BATCH) == 0) {
799 * Caller marked the request to be processed
800 * immediately; dispatch it directly to the
801 * driver unless the driver is currently blocked.
803 cap = crypto_checkdriver(hid);
804 /* Driver cannot disappeared when there is an active session. */
805 KASSERT(cap != NULL, ("%s: Driver disappeared.", __func__));
806 if (!cap->cc_qblocked) {
807 result = crypto_invoke(cap, crp, 0);
808 if (result != ERESTART)
811 * The driver ran out of resources, put the request on
817 TAILQ_INSERT_TAIL(&crp_q, crp, crp_next);
825 * Add an asymetric crypto request to a queue,
826 * to be processed by the kernel thread.
829 crypto_kdispatch(struct cryptkop *krp)
833 cryptostats.cs_kops++;
835 error = crypto_kinvoke(krp, krp->krp_crid);
836 if (error == ERESTART) {
838 TAILQ_INSERT_TAIL(&crp_kq, krp, krp_next);
848 * Verify a driver is suitable for the specified operation.
851 kdriver_suitable(const struct cryptocap *cap, const struct cryptkop *krp)
853 return (cap->cc_kalg[krp->krp_op] & CRYPTO_ALG_FLAG_SUPPORTED) != 0;
857 * Select a driver for an asym operation. The driver must
858 * support the necessary algorithm. The caller can constrain
859 * which device is selected with the flags parameter. The
860 * algorithm we use here is pretty stupid; just use the first
861 * driver that supports the algorithms we need. If there are
862 * multiple suitable drivers we choose the driver with the
863 * fewest active operations. We prefer hardware-backed
864 * drivers to software ones when either may be used.
866 static struct cryptocap *
867 crypto_select_kdriver(const struct cryptkop *krp, int flags)
869 struct cryptocap *cap, *best, *blocked;
872 CRYPTO_DRIVER_ASSERT();
875 * Look first for hardware crypto devices if permitted.
877 if (flags & CRYPTOCAP_F_HARDWARE)
878 match = CRYPTOCAP_F_HARDWARE;
880 match = CRYPTOCAP_F_SOFTWARE;
884 for (hid = 0; hid < crypto_drivers_num; hid++) {
885 cap = &crypto_drivers[hid];
887 * If it's not initialized, is in the process of
888 * going away, or is not appropriate (hardware
889 * or software based on match), then skip.
891 if (cap->cc_dev == NULL ||
892 (cap->cc_flags & CRYPTOCAP_F_CLEANUP) ||
893 (cap->cc_flags & match) == 0)
896 /* verify all the algorithms are supported. */
897 if (kdriver_suitable(cap, krp)) {
899 cap->cc_koperations < best->cc_koperations)
905 if (match == CRYPTOCAP_F_HARDWARE && (flags & CRYPTOCAP_F_SOFTWARE)) {
906 /* sort of an Algol 68-style for loop */
907 match = CRYPTOCAP_F_SOFTWARE;
914 * Dispatch an asymmetric crypto request.
917 crypto_kinvoke(struct cryptkop *krp, int crid)
919 struct cryptocap *cap = NULL;
922 KASSERT(krp != NULL, ("%s: krp == NULL", __func__));
923 KASSERT(krp->krp_callback != NULL,
924 ("%s: krp->crp_callback == NULL", __func__));
926 CRYPTO_DRIVER_LOCK();
927 if ((crid & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) {
928 cap = crypto_checkdriver(crid);
931 * Driver present, it must support the necessary
932 * algorithm and, if s/w drivers are excluded,
933 * it must be registered as hardware-backed.
935 if (!kdriver_suitable(cap, krp) ||
936 (!crypto_devallowsoft &&
937 (cap->cc_flags & CRYPTOCAP_F_HARDWARE) == 0))
942 * No requested driver; select based on crid flags.
944 if (!crypto_devallowsoft) /* NB: disallow s/w drivers */
945 crid &= ~CRYPTOCAP_F_SOFTWARE;
946 cap = crypto_select_kdriver(krp, crid);
948 if (cap != NULL && !cap->cc_kqblocked) {
949 krp->krp_hid = cap - crypto_drivers;
950 cap->cc_koperations++;
951 CRYPTO_DRIVER_UNLOCK();
952 error = CRYPTODEV_KPROCESS(cap->cc_dev, krp, 0);
953 CRYPTO_DRIVER_LOCK();
954 if (error == ERESTART) {
955 cap->cc_koperations--;
956 CRYPTO_DRIVER_UNLOCK();
961 * NB: cap is !NULL if device is blocked; in
962 * that case return ERESTART so the operation
963 * is resubmitted if possible.
965 error = (cap == NULL) ? ENODEV : ERESTART;
967 CRYPTO_DRIVER_UNLOCK();
970 krp->krp_status = error;
978 crypto_tstat(struct cryptotstat *ts, struct bintime *bt)
980 struct bintime now, delta;
986 delta.frac = now.frac - bt->frac;
987 delta.sec = now.sec - bt->sec;
990 bintime2timespec(&delta, &t);
991 timespecadd(&ts->acc, &t);
992 if (timespeccmp(&t, &ts->min, <))
994 if (timespeccmp(&t, &ts->max, >))
1003 * Dispatch a crypto request to the appropriate crypto devices.
1006 crypto_invoke(struct cryptocap *cap, struct cryptop *crp, int hint)
1009 KASSERT(crp != NULL, ("%s: crp == NULL", __func__));
1010 KASSERT(crp->crp_callback != NULL,
1011 ("%s: crp->crp_callback == NULL", __func__));
1012 KASSERT(crp->crp_desc != NULL, ("%s: crp->crp_desc == NULL", __func__));
1014 #ifdef CRYPTO_TIMING
1016 crypto_tstat(&cryptostats.cs_invoke, &crp->crp_tstamp);
1018 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP) {
1019 struct cryptodesc *crd;
1023 * Driver has unregistered; migrate the session and return
1024 * an error to the caller so they'll resubmit the op.
1026 * XXX: What if there are more already queued requests for this
1029 crypto_freesession(crp->crp_sid);
1031 for (crd = crp->crp_desc; crd->crd_next; crd = crd->crd_next)
1032 crd->CRD_INI.cri_next = &(crd->crd_next->CRD_INI);
1034 /* XXX propagate flags from initial session? */
1035 if (crypto_newsession(&nid, &(crp->crp_desc->CRD_INI),
1036 CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE) == 0)
1039 crp->crp_etype = EAGAIN;
1044 * Invoke the driver to process the request.
1046 return CRYPTODEV_PROCESS(cap->cc_dev, crp, hint);
1051 * Release a set of crypto descriptors.
1054 crypto_freereq(struct cryptop *crp)
1056 struct cryptodesc *crd;
1063 struct cryptop *crp2;
1066 TAILQ_FOREACH(crp2, &crp_q, crp_next) {
1067 KASSERT(crp2 != crp,
1068 ("Freeing cryptop from the crypto queue (%p).",
1073 TAILQ_FOREACH(crp2, &crp_ret_q, crp_next) {
1074 KASSERT(crp2 != crp,
1075 ("Freeing cryptop from the return queue (%p).",
1078 CRYPTO_RETQ_UNLOCK();
1082 while ((crd = crp->crp_desc) != NULL) {
1083 crp->crp_desc = crd->crd_next;
1084 uma_zfree(cryptodesc_zone, crd);
1086 uma_zfree(cryptop_zone, crp);
1090 * Acquire a set of crypto descriptors.
1093 crypto_getreq(int num)
1095 struct cryptodesc *crd;
1096 struct cryptop *crp;
1098 crp = uma_zalloc(cryptop_zone, M_NOWAIT|M_ZERO);
1101 crd = uma_zalloc(cryptodesc_zone, M_NOWAIT|M_ZERO);
1103 crypto_freereq(crp);
1107 crd->crd_next = crp->crp_desc;
1108 crp->crp_desc = crd;
1115 * Invoke the callback on behalf of the driver.
1118 crypto_done(struct cryptop *crp)
1120 KASSERT((crp->crp_flags & CRYPTO_F_DONE) == 0,
1121 ("crypto_done: op already done, flags 0x%x", crp->crp_flags));
1122 crp->crp_flags |= CRYPTO_F_DONE;
1123 if (crp->crp_etype != 0)
1124 cryptostats.cs_errs++;
1125 #ifdef CRYPTO_TIMING
1127 crypto_tstat(&cryptostats.cs_done, &crp->crp_tstamp);
1130 * CBIMM means unconditionally do the callback immediately;
1131 * CBIFSYNC means do the callback immediately only if the
1132 * operation was done synchronously. Both are used to avoid
1133 * doing extraneous context switches; the latter is mostly
1134 * used with the software crypto driver.
1136 if ((crp->crp_flags & CRYPTO_F_CBIMM) ||
1137 ((crp->crp_flags & CRYPTO_F_CBIFSYNC) &&
1138 (CRYPTO_SESID2CAPS(crp->crp_sid) & CRYPTOCAP_F_SYNC))) {
1140 * Do the callback directly. This is ok when the
1141 * callback routine does very little (e.g. the
1142 * /dev/crypto callback method just does a wakeup).
1144 #ifdef CRYPTO_TIMING
1145 if (crypto_timing) {
1147 * NB: We must copy the timestamp before
1148 * doing the callback as the cryptop is
1149 * likely to be reclaimed.
1151 struct bintime t = crp->crp_tstamp;
1152 crypto_tstat(&cryptostats.cs_cb, &t);
1153 crp->crp_callback(crp);
1154 crypto_tstat(&cryptostats.cs_finis, &t);
1157 crp->crp_callback(crp);
1160 * Normal case; queue the callback for the thread.
1163 if (CRYPTO_RETQ_EMPTY())
1164 wakeup_one(&crp_ret_q); /* shared wait channel */
1165 TAILQ_INSERT_TAIL(&crp_ret_q, crp, crp_next);
1166 CRYPTO_RETQ_UNLOCK();
1171 * Invoke the callback on behalf of the driver.
1174 crypto_kdone(struct cryptkop *krp)
1176 struct cryptocap *cap;
1178 if (krp->krp_status != 0)
1179 cryptostats.cs_kerrs++;
1180 CRYPTO_DRIVER_LOCK();
1181 /* XXX: What if driver is loaded in the meantime? */
1182 if (krp->krp_hid < crypto_drivers_num) {
1183 cap = &crypto_drivers[krp->krp_hid];
1184 KASSERT(cap->cc_koperations > 0, ("cc_koperations == 0"));
1185 cap->cc_koperations--;
1186 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP)
1189 CRYPTO_DRIVER_UNLOCK();
1191 if (CRYPTO_RETQ_EMPTY())
1192 wakeup_one(&crp_ret_q); /* shared wait channel */
1193 TAILQ_INSERT_TAIL(&crp_ret_kq, krp, krp_next);
1194 CRYPTO_RETQ_UNLOCK();
1198 crypto_getfeat(int *featp)
1200 int hid, kalg, feat = 0;
1202 CRYPTO_DRIVER_LOCK();
1203 for (hid = 0; hid < crypto_drivers_num; hid++) {
1204 const struct cryptocap *cap = &crypto_drivers[hid];
1206 if ((cap->cc_flags & CRYPTOCAP_F_SOFTWARE) &&
1207 !crypto_devallowsoft) {
1210 for (kalg = 0; kalg < CRK_ALGORITHM_MAX; kalg++)
1211 if (cap->cc_kalg[kalg] & CRYPTO_ALG_FLAG_SUPPORTED)
1214 CRYPTO_DRIVER_UNLOCK();
1220 * Terminate a thread at module unload. The process that
1221 * initiated this is waiting for us to signal that we're gone;
1222 * wake it up and exit. We use the driver table lock to insure
1223 * we don't do the wakeup before they're waiting. There is no
1224 * race here because the waiter sleeps on the proc lock for the
1225 * thread so it gets notified at the right time because of an
1226 * extra wakeup that's done in exit1().
1229 crypto_finis(void *chan)
1231 CRYPTO_DRIVER_LOCK();
1233 CRYPTO_DRIVER_UNLOCK();
1238 * Crypto thread, dispatches crypto requests.
1243 struct cryptop *crp, *submit;
1244 struct cryptkop *krp;
1245 struct cryptocap *cap;
1249 #if defined(__i386__) || defined(__amd64__)
1250 fpu_kern_thread(FPU_KERN_NORMAL);
1256 * Find the first element in the queue that can be
1257 * processed and look-ahead to see if multiple ops
1258 * are ready for the same driver.
1262 TAILQ_FOREACH(crp, &crp_q, crp_next) {
1263 hid = CRYPTO_SESID2HID(crp->crp_sid);
1264 cap = crypto_checkdriver(hid);
1266 * Driver cannot disappeared when there is an active
1269 KASSERT(cap != NULL, ("%s:%u Driver disappeared.",
1270 __func__, __LINE__));
1271 if (cap == NULL || cap->cc_dev == NULL) {
1272 /* Op needs to be migrated, process it. */
1277 if (!cap->cc_qblocked) {
1278 if (submit != NULL) {
1280 * We stop on finding another op,
1281 * regardless whether its for the same
1282 * driver or not. We could keep
1283 * searching the queue but it might be
1284 * better to just use a per-driver
1287 if (CRYPTO_SESID2HID(submit->crp_sid) == hid)
1288 hint = CRYPTO_HINT_MORE;
1292 if ((submit->crp_flags & CRYPTO_F_BATCH) == 0)
1294 /* keep scanning for more are q'd */
1298 if (submit != NULL) {
1299 TAILQ_REMOVE(&crp_q, submit, crp_next);
1300 hid = CRYPTO_SESID2HID(submit->crp_sid);
1301 cap = crypto_checkdriver(hid);
1302 KASSERT(cap != NULL, ("%s:%u Driver disappeared.",
1303 __func__, __LINE__));
1304 result = crypto_invoke(cap, submit, hint);
1305 if (result == ERESTART) {
1307 * The driver ran out of resources, mark the
1308 * driver ``blocked'' for cryptop's and put
1309 * the request back in the queue. It would
1310 * best to put the request back where we got
1311 * it but that's hard so for now we put it
1312 * at the front. This should be ok; putting
1313 * it at the end does not work.
1315 /* XXX validate sid again? */
1316 crypto_drivers[CRYPTO_SESID2HID(submit->crp_sid)].cc_qblocked = 1;
1317 TAILQ_INSERT_HEAD(&crp_q, submit, crp_next);
1318 cryptostats.cs_blocks++;
1322 /* As above, but for key ops */
1323 TAILQ_FOREACH(krp, &crp_kq, krp_next) {
1324 cap = crypto_checkdriver(krp->krp_hid);
1325 if (cap == NULL || cap->cc_dev == NULL) {
1327 * Operation needs to be migrated, invalidate
1328 * the assigned device so it will reselect a
1329 * new one below. Propagate the original
1330 * crid selection flags if supplied.
1332 krp->krp_hid = krp->krp_crid &
1333 (CRYPTOCAP_F_SOFTWARE|CRYPTOCAP_F_HARDWARE);
1334 if (krp->krp_hid == 0)
1336 CRYPTOCAP_F_SOFTWARE|CRYPTOCAP_F_HARDWARE;
1339 if (!cap->cc_kqblocked)
1343 TAILQ_REMOVE(&crp_kq, krp, krp_next);
1344 result = crypto_kinvoke(krp, krp->krp_hid);
1345 if (result == ERESTART) {
1347 * The driver ran out of resources, mark the
1348 * driver ``blocked'' for cryptkop's and put
1349 * the request back in the queue. It would
1350 * best to put the request back where we got
1351 * it but that's hard so for now we put it
1352 * at the front. This should be ok; putting
1353 * it at the end does not work.
1355 /* XXX validate sid again? */
1356 crypto_drivers[krp->krp_hid].cc_kqblocked = 1;
1357 TAILQ_INSERT_HEAD(&crp_kq, krp, krp_next);
1358 cryptostats.cs_kblocks++;
1362 if (submit == NULL && krp == NULL) {
1364 * Nothing more to be processed. Sleep until we're
1365 * woken because there are more ops to process.
1366 * This happens either by submission or by a driver
1367 * becoming unblocked and notifying us through
1368 * crypto_unblock. Note that when we wakeup we
1369 * start processing each queue again from the
1370 * front. It's not clear that it's important to
1371 * preserve this ordering since ops may finish
1372 * out of order if dispatched to different devices
1373 * and some become blocked while others do not.
1376 msleep(&crp_q, &crypto_q_mtx, PWAIT, "crypto_wait", 0);
1378 if (cryptoproc == NULL)
1380 cryptostats.cs_intrs++;
1385 crypto_finis(&crp_q);
1389 * Crypto returns thread, does callbacks for processed crypto requests.
1390 * Callbacks are done here, rather than in the crypto drivers, because
1391 * callbacks typically are expensive and would slow interrupt handling.
1394 crypto_ret_proc(void)
1396 struct cryptop *crpt;
1397 struct cryptkop *krpt;
1401 /* Harvest return q's for completed ops */
1402 crpt = TAILQ_FIRST(&crp_ret_q);
1404 TAILQ_REMOVE(&crp_ret_q, crpt, crp_next);
1406 krpt = TAILQ_FIRST(&crp_ret_kq);
1408 TAILQ_REMOVE(&crp_ret_kq, krpt, krp_next);
1410 if (crpt != NULL || krpt != NULL) {
1411 CRYPTO_RETQ_UNLOCK();
1413 * Run callbacks unlocked.
1416 #ifdef CRYPTO_TIMING
1417 if (crypto_timing) {
1419 * NB: We must copy the timestamp before
1420 * doing the callback as the cryptop is
1421 * likely to be reclaimed.
1423 struct bintime t = crpt->crp_tstamp;
1424 crypto_tstat(&cryptostats.cs_cb, &t);
1425 crpt->crp_callback(crpt);
1426 crypto_tstat(&cryptostats.cs_finis, &t);
1429 crpt->crp_callback(crpt);
1432 krpt->krp_callback(krpt);
1436 * Nothing more to be processed. Sleep until we're
1437 * woken because there are more returns to process.
1439 msleep(&crp_ret_q, &crypto_ret_q_mtx, PWAIT,
1440 "crypto_ret_wait", 0);
1441 if (cryptoretproc == NULL)
1443 cryptostats.cs_rets++;
1446 CRYPTO_RETQ_UNLOCK();
1448 crypto_finis(&crp_ret_q);
1453 db_show_drivers(void)
1457 db_printf("%12s %4s %4s %8s %2s %2s\n"
1465 for (hid = 0; hid < crypto_drivers_num; hid++) {
1466 const struct cryptocap *cap = &crypto_drivers[hid];
1467 if (cap->cc_dev == NULL)
1469 db_printf("%-12s %4u %4u %08x %2u %2u\n"
1470 , device_get_nameunit(cap->cc_dev)
1472 , cap->cc_koperations
1480 DB_SHOW_COMMAND(crypto, db_show_crypto)
1482 struct cryptop *crp;
1487 db_printf("%4s %8s %4s %4s %4s %4s %8s %8s\n",
1488 "HID", "Caps", "Ilen", "Olen", "Etype", "Flags",
1489 "Desc", "Callback");
1490 TAILQ_FOREACH(crp, &crp_q, crp_next) {
1491 db_printf("%4u %08x %4u %4u %4u %04x %8p %8p\n"
1492 , (int) CRYPTO_SESID2HID(crp->crp_sid)
1493 , (int) CRYPTO_SESID2CAPS(crp->crp_sid)
1494 , crp->crp_ilen, crp->crp_olen
1501 if (!TAILQ_EMPTY(&crp_ret_q)) {
1502 db_printf("\n%4s %4s %4s %8s\n",
1503 "HID", "Etype", "Flags", "Callback");
1504 TAILQ_FOREACH(crp, &crp_ret_q, crp_next) {
1505 db_printf("%4u %4u %04x %8p\n"
1506 , (int) CRYPTO_SESID2HID(crp->crp_sid)
1515 DB_SHOW_COMMAND(kcrypto, db_show_kcrypto)
1517 struct cryptkop *krp;
1522 db_printf("%4s %5s %4s %4s %8s %4s %8s\n",
1523 "Op", "Status", "#IP", "#OP", "CRID", "HID", "Callback");
1524 TAILQ_FOREACH(krp, &crp_kq, krp_next) {
1525 db_printf("%4u %5u %4u %4u %08x %4u %8p\n"
1528 , krp->krp_iparams, krp->krp_oparams
1529 , krp->krp_crid, krp->krp_hid
1533 if (!TAILQ_EMPTY(&crp_ret_q)) {
1534 db_printf("%4s %5s %8s %4s %8s\n",
1535 "Op", "Status", "CRID", "HID", "Callback");
1536 TAILQ_FOREACH(krp, &crp_ret_kq, krp_next) {
1537 db_printf("%4u %5u %08x %4u %8p\n"
1540 , krp->krp_crid, krp->krp_hid
1548 int crypto_modevent(module_t mod, int type, void *unused);
1551 * Initialization code, both for static and dynamic loading.
1552 * Note this is not invoked with the usual MODULE_DECLARE
1553 * mechanism but instead is listed as a dependency by the
1554 * cryptosoft driver. This guarantees proper ordering of
1555 * calls on module load/unload.
1558 crypto_modevent(module_t mod, int type, void *unused)
1564 error = crypto_init();
1565 if (error == 0 && bootverbose)
1566 printf("crypto: <crypto core>\n");
1569 /*XXX disallow if active sessions */
1576 MODULE_VERSION(crypto, 1);
1577 MODULE_DEPEND(crypto, zlib, 1, 1, 1);