tools/regression/fifo/fifo_misc/fifo_misc.c

   1 /*-
   2  * Copyright (c) 2005 Robert N. M. Watson
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #include <sys/types.h>
  30 #include <sys/event.h>
  31 #include <sys/filio.h>
  32 #include <sys/stat.h>
  33 #include <sys/time.h>
  34
  35 #include <err.h>
  36 #include <errno.h>
  37 #include <fcntl.h>
  38 #include <limits.h>
  39 #include <stdio.h>
  40 #include <stdlib.h>
  41 #include <string.h>
  42 #include <unistd.h>
  43
  44 /*
  45  * Regression test for piddling details of fifos.
  46  */
  47
  48 /*
  49  * All activity occurs within a temporary directory created early in the
  50  * test.
  51  */
  52 char    temp_dir[PATH_MAX];
  53
  54 static void __unused
  55 atexit_temp_dir(void)
  56 {
  57
  58         rmdir(temp_dir);
  59 }
  60
  61 static void
  62 makefifo(const char *fifoname, const char *testname)
  63 {
  64
  65         if (mkfifo(fifoname, 0700) < 0)
  66                 err(-1, "%s: makefifo: mkfifo: %s", testname, fifoname);
  67 }
  68
  69 static void
  70 cleanfifo(const char *fifoname, int fd1, int fd2)
  71 {
  72
  73         if (fd1 != -1)
  74                 close(fd1);
  75         if (fd2 != -1)
  76                 close(fd2);
  77         (void)unlink(fifoname);
  78 }
  79
  80 static int
  81 openfifo(const char *fifoname, const char *testname, int *reader_fdp,
  82     int *writer_fdp)
  83 {
  84         int error, fd1, fd2;
  85
  86         fd1 = open(fifoname, O_RDONLY | O_NONBLOCK);
  87         if (fd1 < 0)
  88                 return (-1);
  89         fd2 = open(fifoname, O_WRONLY | O_NONBLOCK);
  90         if (fd2 < 0) {
  91                 error = errno;
  92                 close(fd1);
  93                 errno = error;
  94                 return (-1);
  95         }
  96         *reader_fdp = fd1;
  97         *writer_fdp = fd2;
  98
  99         return (0);
 100 }
 101
 102 /*
 103  * POSIX does not allow lseek(2) on fifos, so we expect ESPIPE as a result.
 104  */
 105 static void
 106 test_lseek(void)
 107 {
 108         int reader_fd, writer_fd;
 109
 110         makefifo("testfifo", __func__);
 111
 112         if (openfifo("testfifo", __func__, &reader_fd, &writer_fd) < 0) {
 113                 warn("%s: openfifo", __func__);
 114                 cleanfifo("testfifo", -1, -1);
 115                 exit(-1);
 116         }
 117
 118         if (lseek(reader_fd, SEEK_CUR, 1) >= 0) {
 119                 warnx("%s: lseek succeeded instead of returning ESPIPE",
 120                     __func__);
 121                 cleanfifo("testfifo", reader_fd, writer_fd);
 122                 exit(-1);
 123         }
 124         if (errno != ESPIPE) {
 125                 warn("%s: lseek returned instead of ESPIPE", __func__);
 126                 cleanfifo("testfifo", reader_fd, writer_fd);
 127                 exit(-1);
 128         }
 129
 130         cleanfifo("testfifo", reader_fd, writer_fd);
 131 }
 132
 133 /*
 134  * truncate(2) on FIFO should silently return success.
 135  */
 136 static void
 137 test_truncate(void)
 138 {
 139
 140         makefifo("testfifo", __func__);
 141
 142         if (truncate("testfifo", 1024) != 0) {
 143                 warn("%s: truncate", __func__);
 144                 cleanfifo("testfifo", -1, -1);
 145                 exit(-1);
 146         }
 147
 148         cleanfifo("testfifo", -1, -1);
 149 }
 150
 151 struct filter_entry {
 152         int              fe_filter;
 153         const char      *fe_name;
 154         int              fe_error;
 155         const char      *fe_errorname;
 156 };
 157
 158 static const struct filter_entry good_filter_types[] = {
 159         { EVFILT_READ, "EVFILT_READ", 0, "0" },
 160         { EVFILT_WRITE, "EVFILT_WRITE", 0, "0" },
 161 #if WORKING_EVFILT_VNODE_ON_FIFOS
 162         { EVFILT_VNODE, "EVFILT_VNODE", EINVAL, "EINVAL" },
 163 #endif
 164 };
 165 static const int good_filter_types_len = sizeof(good_filter_types) /
 166     sizeof(good_filter_types[0]);
 167
 168 static const struct filter_entry bad_filter_types[] = {
 169         { EVFILT_NETDEV, "EVFILT_NETDEV", EINVAL, "EINVAL" },
 170 };
 171 static const int bad_filter_types_len = sizeof(bad_filter_types) /
 172     sizeof(bad_filter_types[0]);
 173
 174 /*
 175  * kqueue event-related tests are in fifo_io.c; however, that tests only
 176  * valid invocations of kqueue.  Check to make sure that some invalid filters
 177  * that are generally allowed on file descriptors are not allowed to be
 178  * registered with kqueue, and that if attempts are made, we get the right
 179  * error.
 180  */
 181 static void
 182 test_kqueue(void)
 183 {
 184         int kqueue_fd, reader_fd, writer_fd;
 185         struct kevent kev_set;
 186         struct timespec timeout;
 187         int i, ret;
 188
 189         makefifo("testfifo", __func__);
 190
 191         if (openfifo("testfifo", __func__, &reader_fd, &writer_fd) < 0) {
 192                 warn("%s: openfifo", __func__);
 193                 cleanfifo("testfifo", -1, -1);
 194                 exit(-1);
 195         }
 196
 197         kqueue_fd = kqueue();
 198         if (kqueue_fd < 0) {
 199                 warn("%s: kqueue", __func__);
 200                 cleanfifo("testfifo", reader_fd, writer_fd);
 201                 exit(-1);
 202         }
 203
 204         timeout.tv_sec = 0;
 205         timeout.tv_nsec = 0;
 206
 207         for (i = 0; i < good_filter_types_len; i++) {
 208                 bzero(&kev_set, sizeof(kev_set));
 209                 EV_SET(&kev_set, reader_fd, good_filter_types[i].fe_filter,
 210                     EV_ADD, 0, 0, 0);
 211                 ret = kevent(kqueue_fd, &kev_set, 1, NULL, 0, &timeout);
 212                 if (ret < 0) {
 213                         warn("%s: kevent: adding good filter %s", __func__,
 214                             good_filter_types[i].fe_name);
 215                         close(kqueue_fd);
 216                         cleanfifo("testfifo", reader_fd, writer_fd);
 217                         exit(-1);
 218                 }
 219                 bzero(&kev_set, sizeof(kev_set));
 220                 EV_SET(&kev_set, reader_fd, good_filter_types[i].fe_filter,
 221                     EV_DELETE, 0, 0, 0);
 222                 ret = kevent(kqueue_fd, &kev_set, 1, NULL, 0, &timeout);
 223                 if (ret < 0) {
 224                         warn("%s: kevent: deleting good filter %s", __func__,
 225                             good_filter_types[i].fe_name);
 226                         close(kqueue_fd);
 227                         cleanfifo("testfifo", reader_fd, writer_fd);
 228                         exit(-1);
 229                 }
 230         }
 231
 232         for (i = 0; i < bad_filter_types_len; i++) {
 233                 bzero(&kev_set, sizeof(kev_set));
 234                 EV_SET(&kev_set, reader_fd, bad_filter_types[i].fe_filter,
 235                     EV_ADD, 0, 0, 0);
 236                 ret = kevent(kqueue_fd, &kev_set, 1, NULL, 0, &timeout);
 237                 if (ret >= 0) {
 238                         warnx("%s: kevent: bad filter %s succeeded, expected "
 239                             "EINVAL", __func__, bad_filter_types[i].fe_name);
 240                         close(kqueue_fd);
 241                         cleanfifo("testfifo", reader_fd, writer_fd);
 242                         exit(-1);
 243                 }
 244                 if (errno != bad_filter_types[i].fe_error) {
 245                         warn("%s: kevent: bad filter %s failed with error "
 246                             "not %s", __func__,
 247                             bad_filter_types[i].fe_name,
 248                             bad_filter_types[i].fe_errorname);
 249                         close(kqueue_fd);
 250                         cleanfifo("testfifo", reader_fd, writer_fd);
 251                         exit(-1);
 252                 }
 253         }
 254
 255         close(kqueue_fd);
 256         cleanfifo("testfifo", reader_fd, writer_fd);
 257 }
 258
 259 static int
 260 test_ioctl_setclearflag(int fd, int flag, const char *testname,
 261     const char *fdname, const char *flagname)
 262 {
 263         int i;
 264
 265         i = 1;
 266         if (ioctl(fd, flag, &i) < 0) {
 267                 warn("%s:%s: ioctl(%s, %s, 1)", testname, __func__, fdname,
 268                     flagname);
 269                 cleanfifo("testfifo", -1, -1);
 270                 exit(-1);
 271         }
 272
 273         i = 0;
 274         if (ioctl(fd, flag, &i) < 0) {
 275                 warn("%s:%s: ioctl(%s, %s, 0)", testname, __func__, fdname,
 276                     flagname);
 277                 cleanfifo("testfifo", -1, -1);
 278                 exit(-1);
 279         }
 280
 281         return (0);
 282 }
 283
 284 /*
 285  * Test that various ioctls can be issued against the file descriptor.  We
 286  * don't currently test the semantics of these changes here.
 287  */
 288 static void
 289 test_ioctl(void)
 290 {
 291         int reader_fd, writer_fd;
 292
 293         makefifo("testfifo", __func__);
 294
 295         if (openfifo("testfifo", __func__, &reader_fd, &writer_fd) < 0) {
 296                 warn("%s: openfifo", __func__);
 297                 cleanfifo("testfifo", -1, -1);
 298                 exit(-1);
 299         }
 300
 301         /*
 302          * Set and remove the non-blocking I/O flag.
 303          */
 304         if (test_ioctl_setclearflag(reader_fd, FIONBIO, __func__,
 305             "reader_fd", "FIONBIO") < 0) {
 306                 cleanfifo("testfifo", reader_fd, writer_fd);
 307                 exit(-1);
 308         }
 309
 310         if (test_ioctl_setclearflag(writer_fd, FIONBIO, __func__,
 311             "writer_fd", "FIONBIO") < 0) {
 312                 cleanfifo("testfifo", reader_fd, writer_fd);
 313                 exit(-1);
 314         }
 315
 316         /*
 317          * Set and remove the async I/O flag.
 318          */
 319         if (test_ioctl_setclearflag(reader_fd, FIOASYNC, __func__,
 320             "reader_fd", "FIOASYNC") < 0) {
 321                 cleanfifo("testfifo", reader_fd, writer_fd);
 322                 exit(-1);
 323         }
 324
 325         if (test_ioctl_setclearflag(writer_fd, FIOASYNC, __func__,
 326             "writer_fd", "FIONASYNC") < 0) {
 327                 cleanfifo("testfifo", reader_fd, writer_fd);
 328                 exit(-1);
 329         }
 330
 331         cleanfifo("testfifo", reader_fd, writer_fd);
 332 }
 333
 334 int
 335 main(int argc, char *argv[])
 336 {
 337
 338         strcpy(temp_dir, "/tmp/fifo_misc.XXXXXXXXXXX");
 339         if (mkdtemp(temp_dir) == NULL)
 340                 err(-1, "mkdtemp");
 341         atexit(atexit_temp_dir);
 342
 343         if (chdir(temp_dir) < 0)
 344                 err(-1, "chdir %s", temp_dir);
 345
 346         test_lseek();
 347         test_truncate();
 348         test_kqueue();
 349         test_ioctl();
 350
 351         return (0);
 352 }