Remove the old console input code; use qio
[akaros.git] / kern / src / fdtap.c
1 /* Copyright (c) 2015 Google Inc
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * FD taps.  Allows the user to receive events when certain things happen to an
6  * FD's underlying device file/qid. */
7
8 #include <fdtap.h>
9 #include <vfs.h>
10 #include <event.h>
11 #include <kmalloc.h>
12 #include <syscall.h>
13 #include <error.h>
14
15
16 static void tap_min_release(struct kref *kref)
17 {
18         struct fd_tap *tap = container_of(kref, struct fd_tap, kref);
19         cclose(tap->chan);
20         kfree(tap);
21 }
22
23 static void tap_full_release(struct kref *kref)
24 {
25         struct fd_tap *tap = container_of(kref, struct fd_tap, kref);
26         devtab[tap->chan->type].tapfd(tap->chan, tap, FDTAP_CMD_REM);
27         tap_min_release(kref);
28 }
29
30 /* Adds a tap with the file/qid of the underlying device for the requested FD.
31  * The FD must be a chan, and the device must support the filter requested.
32  *
33  * Returns -1 or some other device-specific non-zero number on failure, 0 on
34  * success. */
35 int add_fd_tap(struct proc *p, struct fd_tap_req *tap_req)
36 {
37         struct fd_table *fdt = &p->open_files;
38         struct fd_tap *tap;
39         int ret = 0;
40         struct chan *chan;
41         int fd = tap_req->fd;
42
43         if (fd < 0) {
44                 set_errno(EBADF);
45                 return -1;
46         }
47         tap = kzmalloc(sizeof(struct fd_tap), MEM_WAIT);
48         tap->proc = p;
49         tap->fd = fd;
50         tap->filter = tap_req->filter;
51         tap->ev_q = tap_req->ev_q;
52         tap->ev_id = tap_req->ev_id;
53         tap->data = tap_req->data;
54
55         spin_lock(&fdt->lock);
56         if (fd >= fdt->max_fdset) {
57                 set_errno(ENFILE);
58                 goto out_with_lock;
59         }
60         if (!GET_BITMASK_BIT(fdt->open_fds->fds_bits, fd)) {
61                 set_errno(EBADF);
62                 goto out_with_lock;
63         }
64         if (!fdt->fd[fd].fd_chan) {
65                 set_error(EINVAL, "Can't tap a VFS file");
66                 goto out_with_lock;
67         }
68         chan = fdt->fd[fd].fd_chan;
69         if (fdt->fd[fd].fd_tap) {
70                 set_error(EBUSY, "FD %d already has a tap", fd);
71                 goto out_with_lock;
72         }
73         if (!devtab[chan->type].tapfd) {
74                 set_error(ENOSYS, "Device %s does not handle taps",
75                                   devtab[chan->type].name);
76                 goto out_with_lock;
77         }
78         /* need to keep chan alive for our call to the device.  someone else
79          * could come in and close the FD and the chan, once we unlock */
80         chan_incref(chan);
81         tap->chan = chan;
82         /* One for the FD table, one for us to keep the removal of *this* tap from
83          * happening until we've attempted to register with the device. */
84         kref_init(&tap->kref, tap_full_release, 2);
85         fdt->fd[fd].fd_tap = tap;
86         /* As soon as we unlock, another thread can come in and remove our old tap
87          * from the table and decref it.  Our ref keeps us from removing it yet,
88          * as well as keeps the memory safe.  However, a new tap can be installed
89          * and registered with the device before we even attempt to register.  The
90          * devices should be able to handle multiple, distinct taps, even if they
91          * happen to have the same {proc, fd} tuple. */
92         spin_unlock(&fdt->lock);
93         /* For refcnting fans, the tap ref is weak/uncounted.  We'll protect the
94          * memory and call the device when tap is being released. */
95         ret = devtab[chan->type].tapfd(chan, tap, FDTAP_CMD_ADD);
96         if (ret) {
97                 /* we failed, so we need to make sure *our* tap is removed.  We haven't
98                  * decreffed, so we know our tap pointer is unique. */
99                 spin_lock(&fdt->lock);
100                 if (fdt->fd[fd].fd_tap == tap) {
101                         fdt->fd[fd].fd_tap = 0;
102                         /* normally we can't decref a tap while holding a lock, but we
103                          * know we have another reference so this won't trigger a release */
104                         kref_put(&tap->kref);
105                 }
106                 spin_unlock(&fdt->lock);
107                 /* Regardless of whether someone else removed it or not, *we* are the
108                  * only ones that know that registration failed and that we shouldn't
109                  * remove it.  Since we still hold a ref, we can change the release
110                  * method to skip the device dereg. */
111                 tap->kref.release = tap_min_release;
112         }
113         kref_put(&tap->kref);
114         return ret;
115 out_with_lock:
116         spin_unlock(&fdt->lock);
117         kfree(tap);
118         return -1;
119 }
120
121 /* Removes the FD tap associated with FD.  Returns 0 on success, -1 with
122  * errno/errstr on failure. */
123 int remove_fd_tap(struct proc *p, int fd)
124 {
125         struct fd_table *fdt = &p->open_files;
126         struct fd_tap *tap;
127
128         spin_lock(&fdt->lock);
129         tap = fdt->fd[fd].fd_tap;
130         fdt->fd[fd].fd_tap = 0;
131         spin_unlock(&fdt->lock);
132         if (tap) {
133                 kref_put(&tap->kref);
134                 return 0;
135         } else {
136                 set_error(EBADF, "FD %d was not tapped", fd);
137                 return -1;
138         }
139 }
140
141 /* Fires off tap, with the events of filter having occurred.  Returns -1 on
142  * error, though this need a little more thought.
143  *
144  * Some callers may require this to not block. */
145 int fire_tap(struct fd_tap *tap, int filter)
146 {
147         ERRSTACK(1);
148         struct event_msg ev_msg = {0};
149         int fire_filt = tap->filter & filter;
150
151         if (!fire_filt)
152                 return 0;
153         if (waserror()) {
154                 /* The process owning the tap could trigger a kernel PF, as with any
155                  * send_event() call.  Eventually we'll catch that with waserror. */
156                 warn("Tap for proc %d, fd %d, threw %s", tap->proc->pid, tap->fd,
157                      current_errstr());
158                 poperror();
159                 return -1;
160         }
161         ev_msg.ev_type = tap->ev_id;    /* e.g. CEQ idx */
162         ev_msg.ev_arg2 = fire_filt;             /* e.g. CEQ coalesce */
163         ev_msg.ev_arg3 = tap->data;             /* e.g. CEQ data */
164         send_event(tap->proc, tap->ev_q, &ev_msg, 0);
165         poperror();
166         return 0;
167 }