xref: /freebsd/crypto/openssh/atomicio.c (revision ca86bcf2531c7b149c95244a67853d44323e7855)
1*ca86bcf2SDag-Erling Smørgrav /* $OpenBSD: atomicio.c,v 1.28 2016/07/27 23:18:12 djm Exp $ */
2511b41d2SMark Murray /*
3761efaa7SDag-Erling Smørgrav  * Copyright (c) 2006 Damien Miller. All rights reserved.
4043840dfSDag-Erling Smørgrav  * Copyright (c) 2005 Anil Madhavapeddy. All rights reserved.
51e8db6e2SBrian Feldman  * Copyright (c) 1995,1999 Theo de Raadt.  All rights reserved.
6511b41d2SMark Murray  * All rights reserved.
7511b41d2SMark Murray  *
8511b41d2SMark Murray  * Redistribution and use in source and binary forms, with or without
9511b41d2SMark Murray  * modification, are permitted provided that the following conditions
10511b41d2SMark Murray  * are met:
11511b41d2SMark Murray  * 1. Redistributions of source code must retain the above copyright
12511b41d2SMark Murray  *    notice, this list of conditions and the following disclaimer.
13511b41d2SMark Murray  * 2. Redistributions in binary form must reproduce the above copyright
14511b41d2SMark Murray  *    notice, this list of conditions and the following disclaimer in the
15511b41d2SMark Murray  *    documentation and/or other materials provided with the distribution.
16511b41d2SMark Murray  *
17511b41d2SMark Murray  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18511b41d2SMark Murray  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19511b41d2SMark Murray  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20511b41d2SMark Murray  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21511b41d2SMark Murray  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22511b41d2SMark Murray  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23511b41d2SMark Murray  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24511b41d2SMark Murray  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25511b41d2SMark Murray  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26511b41d2SMark Murray  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27511b41d2SMark Murray  */
28511b41d2SMark Murray 
29511b41d2SMark Murray #include "includes.h"
30761efaa7SDag-Erling Smørgrav 
31761efaa7SDag-Erling Smørgrav #include <sys/param.h>
32761efaa7SDag-Erling Smørgrav #include <sys/uio.h>
33761efaa7SDag-Erling Smørgrav 
34761efaa7SDag-Erling Smørgrav #include <errno.h>
35d4af9e69SDag-Erling Smørgrav #ifdef HAVE_POLL_H
36d4af9e69SDag-Erling Smørgrav #include <poll.h>
37d4af9e69SDag-Erling Smørgrav #else
38d4af9e69SDag-Erling Smørgrav # ifdef HAVE_SYS_POLL_H
39d4af9e69SDag-Erling Smørgrav #  include <sys/poll.h>
40d4af9e69SDag-Erling Smørgrav # endif
41d4af9e69SDag-Erling Smørgrav #endif
42761efaa7SDag-Erling Smørgrav #include <string.h>
43d4af9e69SDag-Erling Smørgrav #include <unistd.h>
44bc5531deSDag-Erling Smørgrav #include <limits.h>
45511b41d2SMark Murray 
461e8db6e2SBrian Feldman #include "atomicio.h"
47511b41d2SMark Murray 
48511b41d2SMark Murray /*
49d95e11bfSDag-Erling Smørgrav  * ensure all of data on socket comes through. f==read || f==vwrite
50511b41d2SMark Murray  */
51043840dfSDag-Erling Smørgrav size_t
524a421b63SDag-Erling Smørgrav atomicio6(ssize_t (*f) (int, void *, size_t), int fd, void *_s, size_t n,
534a421b63SDag-Erling Smørgrav     int (*cb)(void *, size_t), void *cb_arg)
54511b41d2SMark Murray {
55a8f6863aSKris Kennaway 	char *s = _s;
56043840dfSDag-Erling Smørgrav 	size_t pos = 0;
57043840dfSDag-Erling Smørgrav 	ssize_t res;
58d4af9e69SDag-Erling Smørgrav 	struct pollfd pfd;
59511b41d2SMark Murray 
60f7167e0eSDag-Erling Smørgrav #ifndef BROKEN_READ_COMPARISON
61d4af9e69SDag-Erling Smørgrav 	pfd.fd = fd;
62d4af9e69SDag-Erling Smørgrav 	pfd.events = f == read ? POLLIN : POLLOUT;
63f7167e0eSDag-Erling Smørgrav #endif
64511b41d2SMark Murray 	while (n > pos) {
65511b41d2SMark Murray 		res = (f) (fd, s + pos, n - pos);
66511b41d2SMark Murray 		switch (res) {
67511b41d2SMark Murray 		case -1:
68d4af9e69SDag-Erling Smørgrav 			if (errno == EINTR)
69511b41d2SMark Murray 				continue;
70d4af9e69SDag-Erling Smørgrav 			if (errno == EAGAIN || errno == EWOULDBLOCK) {
71f7167e0eSDag-Erling Smørgrav #ifndef BROKEN_READ_COMPARISON
72d4af9e69SDag-Erling Smørgrav 				(void)poll(&pfd, 1, -1);
73f7167e0eSDag-Erling Smørgrav #endif
74d4af9e69SDag-Erling Smørgrav 				continue;
75d4af9e69SDag-Erling Smørgrav 			}
76043840dfSDag-Erling Smørgrav 			return 0;
77511b41d2SMark Murray 		case 0:
78043840dfSDag-Erling Smørgrav 			errno = EPIPE;
79043840dfSDag-Erling Smørgrav 			return pos;
80511b41d2SMark Murray 		default:
81761efaa7SDag-Erling Smørgrav 			pos += (size_t)res;
824a421b63SDag-Erling Smørgrav 			if (cb != NULL && cb(cb_arg, (size_t)res) == -1) {
834a421b63SDag-Erling Smørgrav 				errno = EINTR;
844a421b63SDag-Erling Smørgrav 				return pos;
85511b41d2SMark Murray 			}
86511b41d2SMark Murray 		}
874a421b63SDag-Erling Smørgrav 	}
884a421b63SDag-Erling Smørgrav 	return pos;
894a421b63SDag-Erling Smørgrav }
904a421b63SDag-Erling Smørgrav 
914a421b63SDag-Erling Smørgrav size_t
924a421b63SDag-Erling Smørgrav atomicio(ssize_t (*f) (int, void *, size_t), int fd, void *_s, size_t n)
934a421b63SDag-Erling Smørgrav {
944a421b63SDag-Erling Smørgrav 	return atomicio6(f, fd, _s, n, NULL, NULL);
95511b41d2SMark Murray }
96761efaa7SDag-Erling Smørgrav 
97761efaa7SDag-Erling Smørgrav /*
98761efaa7SDag-Erling Smørgrav  * ensure all of data on socket comes through. f==readv || f==writev
99761efaa7SDag-Erling Smørgrav  */
100761efaa7SDag-Erling Smørgrav size_t
1014a421b63SDag-Erling Smørgrav atomiciov6(ssize_t (*f) (int, const struct iovec *, int), int fd,
1024a421b63SDag-Erling Smørgrav     const struct iovec *_iov, int iovcnt,
1034a421b63SDag-Erling Smørgrav     int (*cb)(void *, size_t), void *cb_arg)
104761efaa7SDag-Erling Smørgrav {
105761efaa7SDag-Erling Smørgrav 	size_t pos = 0, rem;
106761efaa7SDag-Erling Smørgrav 	ssize_t res;
107761efaa7SDag-Erling Smørgrav 	struct iovec iov_array[IOV_MAX], *iov = iov_array;
108d4af9e69SDag-Erling Smørgrav 	struct pollfd pfd;
109761efaa7SDag-Erling Smørgrav 
110*ca86bcf2SDag-Erling Smørgrav 	if (iovcnt < 0 || iovcnt > IOV_MAX) {
111761efaa7SDag-Erling Smørgrav 		errno = EINVAL;
112761efaa7SDag-Erling Smørgrav 		return 0;
113761efaa7SDag-Erling Smørgrav 	}
114761efaa7SDag-Erling Smørgrav 	/* Make a copy of the iov array because we may modify it below */
115*ca86bcf2SDag-Erling Smørgrav 	memcpy(iov, _iov, (size_t)iovcnt * sizeof(*_iov));
116761efaa7SDag-Erling Smørgrav 
117d4af9e69SDag-Erling Smørgrav #ifndef BROKEN_READV_COMPARISON
118d4af9e69SDag-Erling Smørgrav 	pfd.fd = fd;
119d4af9e69SDag-Erling Smørgrav 	pfd.events = f == readv ? POLLIN : POLLOUT;
120d4af9e69SDag-Erling Smørgrav #endif
121761efaa7SDag-Erling Smørgrav 	for (; iovcnt > 0 && iov[0].iov_len > 0;) {
122761efaa7SDag-Erling Smørgrav 		res = (f) (fd, iov, iovcnt);
123761efaa7SDag-Erling Smørgrav 		switch (res) {
124761efaa7SDag-Erling Smørgrav 		case -1:
125d4af9e69SDag-Erling Smørgrav 			if (errno == EINTR)
126761efaa7SDag-Erling Smørgrav 				continue;
127d4af9e69SDag-Erling Smørgrav 			if (errno == EAGAIN || errno == EWOULDBLOCK) {
128d4af9e69SDag-Erling Smørgrav #ifndef BROKEN_READV_COMPARISON
129d4af9e69SDag-Erling Smørgrav 				(void)poll(&pfd, 1, -1);
130d4af9e69SDag-Erling Smørgrav #endif
131d4af9e69SDag-Erling Smørgrav 				continue;
132d4af9e69SDag-Erling Smørgrav 			}
133761efaa7SDag-Erling Smørgrav 			return 0;
134761efaa7SDag-Erling Smørgrav 		case 0:
135761efaa7SDag-Erling Smørgrav 			errno = EPIPE;
136761efaa7SDag-Erling Smørgrav 			return pos;
137761efaa7SDag-Erling Smørgrav 		default:
138761efaa7SDag-Erling Smørgrav 			rem = (size_t)res;
139761efaa7SDag-Erling Smørgrav 			pos += rem;
140761efaa7SDag-Erling Smørgrav 			/* skip completed iov entries */
141761efaa7SDag-Erling Smørgrav 			while (iovcnt > 0 && rem >= iov[0].iov_len) {
142761efaa7SDag-Erling Smørgrav 				rem -= iov[0].iov_len;
143761efaa7SDag-Erling Smørgrav 				iov++;
144761efaa7SDag-Erling Smørgrav 				iovcnt--;
145761efaa7SDag-Erling Smørgrav 			}
146761efaa7SDag-Erling Smørgrav 			/* This shouldn't happen... */
147761efaa7SDag-Erling Smørgrav 			if (rem > 0 && (iovcnt <= 0 || rem > iov[0].iov_len)) {
148761efaa7SDag-Erling Smørgrav 				errno = EFAULT;
149761efaa7SDag-Erling Smørgrav 				return 0;
150761efaa7SDag-Erling Smørgrav 			}
151761efaa7SDag-Erling Smørgrav 			if (iovcnt == 0)
152761efaa7SDag-Erling Smørgrav 				break;
153761efaa7SDag-Erling Smørgrav 			/* update pointer in partially complete iov */
154761efaa7SDag-Erling Smørgrav 			iov[0].iov_base = ((char *)iov[0].iov_base) + rem;
155761efaa7SDag-Erling Smørgrav 			iov[0].iov_len -= rem;
156761efaa7SDag-Erling Smørgrav 		}
1574a421b63SDag-Erling Smørgrav 		if (cb != NULL && cb(cb_arg, (size_t)res) == -1) {
1584a421b63SDag-Erling Smørgrav 			errno = EINTR;
1594a421b63SDag-Erling Smørgrav 			return pos;
1604a421b63SDag-Erling Smørgrav 		}
161761efaa7SDag-Erling Smørgrav 	}
162761efaa7SDag-Erling Smørgrav 	return pos;
163761efaa7SDag-Erling Smørgrav }
1644a421b63SDag-Erling Smørgrav 
1654a421b63SDag-Erling Smørgrav size_t
1664a421b63SDag-Erling Smørgrav atomiciov(ssize_t (*f) (int, const struct iovec *, int), int fd,
1674a421b63SDag-Erling Smørgrav     const struct iovec *_iov, int iovcnt)
1684a421b63SDag-Erling Smørgrav {
1694a421b63SDag-Erling Smørgrav 	return atomiciov6(f, fd, _iov, iovcnt, NULL, NULL);
1704a421b63SDag-Erling Smørgrav }
171