2 * Copyright (c) 2015 FUJITSU LIMITED
3 * Author: Yang Hongyang <yanghy@cn.fujitsu.com>
5 * This work is licensed under the terms of the GNU GPL, version 2 or
6 * later. See the COPYING file in the top-level directory.
9 #include "qemu/osdep.h"
10 #include "qapi/error.h"
11 #include "qapi/qmp/qerror.h"
12 #include "qemu/error-report.h"
14 #include "net/filter.h"
16 #include "net/vhost_net.h"
17 #include "qom/object_interfaces.h"
19 #include "qemu/module.h"
21 #include "migration/colo.h"
23 static inline bool qemu_can_skip_netfilter(NetFilterState *nf)
28 ssize_t qemu_netfilter_receive(NetFilterState *nf,
29 NetFilterDirection direction,
30 NetClientState *sender,
32 const struct iovec *iov,
34 NetPacketSent *sent_cb)
36 if (qemu_can_skip_netfilter(nf)) {
39 if (nf->direction == direction ||
40 nf->direction == NET_FILTER_DIRECTION_ALL) {
41 return NETFILTER_GET_CLASS(OBJECT(nf))->receive_iov(
42 nf, sender, flags, iov, iovcnt, sent_cb);
48 static NetFilterState *netfilter_next(NetFilterState *nf,
49 NetFilterDirection dir)
53 if (dir == NET_FILTER_DIRECTION_TX) {
54 /* forward walk through filters */
55 next = QTAILQ_NEXT(nf, next);
58 next = QTAILQ_PREV(nf, next);
64 ssize_t qemu_netfilter_pass_to_next(NetClientState *sender,
66 const struct iovec *iov,
72 NetFilterState *nf = opaque;
73 NetFilterState *next = NULL;
75 if (!sender || !sender->peer) {
76 /* no receiver, or sender been deleted, no need to pass it further */
80 if (nf->direction == NET_FILTER_DIRECTION_ALL) {
81 if (sender == nf->netdev) {
82 /* This packet is sent by netdev itself */
83 direction = NET_FILTER_DIRECTION_TX;
85 direction = NET_FILTER_DIRECTION_RX;
88 direction = nf->direction;
91 next = netfilter_next(nf, direction);
94 * if qemu_netfilter_pass_to_next been called, means that
95 * the packet has been hold by filter and has already retured size
96 * to the sender, so sent_cb shouldn't be called later, just
99 ret = qemu_netfilter_receive(next, direction, sender, flags, iov,
104 next = netfilter_next(next, direction);
108 * We have gone through all filters, pass it to receiver.
109 * Do the valid check again incase sender or receiver been
110 * deleted while we go through filters.
112 if (sender && sender->peer) {
113 qemu_net_queue_send_iov(sender->peer->incoming_queue,
114 sender, flags, iov, iovcnt, NULL);
118 /* no receiver, or sender been deleted */
119 return iov_size(iov, iovcnt);
122 static char *netfilter_get_netdev_id(Object *obj, Error **errp)
124 NetFilterState *nf = NETFILTER(obj);
126 return g_strdup(nf->netdev_id);
129 static void netfilter_set_netdev_id(Object *obj, const char *str, Error **errp)
131 NetFilterState *nf = NETFILTER(obj);
133 nf->netdev_id = g_strdup(str);
136 static int netfilter_get_direction(Object *obj, Error **errp G_GNUC_UNUSED)
138 NetFilterState *nf = NETFILTER(obj);
139 return nf->direction;
142 static void netfilter_set_direction(Object *obj, int direction, Error **errp)
144 NetFilterState *nf = NETFILTER(obj);
145 nf->direction = direction;
148 static char *netfilter_get_status(Object *obj, Error **errp)
150 NetFilterState *nf = NETFILTER(obj);
152 return nf->on ? g_strdup("on") : g_strdup("off");
155 static void netfilter_set_status(Object *obj, const char *str, Error **errp)
157 NetFilterState *nf = NETFILTER(obj);
158 NetFilterClass *nfc = NETFILTER_GET_CLASS(obj);
160 if (strcmp(str, "on") && strcmp(str, "off")) {
161 error_setg(errp, "Invalid value for netfilter status, "
162 "should be 'on' or 'off'");
165 if (nf->on == !strcmp(str, "on")) {
169 if (nf->netdev && nfc->status_changed) {
170 nfc->status_changed(nf, errp);
174 static char *netfilter_get_position(Object *obj, Error **errp)
176 NetFilterState *nf = NETFILTER(obj);
178 return g_strdup(nf->position);
181 static void netfilter_set_position(Object *obj, const char *str, Error **errp)
183 NetFilterState *nf = NETFILTER(obj);
185 nf->position = g_strdup(str);
188 static char *netfilter_get_insert(Object *obj, Error **errp)
190 NetFilterState *nf = NETFILTER(obj);
192 return nf->insert_before_flag ? g_strdup("before") : g_strdup("behind");
195 static void netfilter_set_insert(Object *obj, const char *str, Error **errp)
197 NetFilterState *nf = NETFILTER(obj);
199 if (strcmp(str, "before") && strcmp(str, "behind")) {
200 error_setg(errp, "Invalid value for netfilter insert, "
201 "should be 'before' or 'behind'");
205 nf->insert_before_flag = !strcmp(str, "before");
208 static void netfilter_init(Object *obj)
210 NetFilterState *nf = NETFILTER(obj);
213 nf->insert_before_flag = false;
214 nf->position = g_strdup("tail");
216 object_property_add_str(obj, "netdev",
217 netfilter_get_netdev_id, netfilter_set_netdev_id);
218 object_property_add_enum(obj, "queue", "NetFilterDirection",
219 &NetFilterDirection_lookup,
220 netfilter_get_direction, netfilter_set_direction);
221 object_property_add_str(obj, "status",
222 netfilter_get_status, netfilter_set_status);
223 object_property_add_str(obj, "position",
224 netfilter_get_position, netfilter_set_position);
225 object_property_add_str(obj, "insert",
226 netfilter_get_insert, netfilter_set_insert);
229 static void netfilter_complete(UserCreatable *uc, Error **errp)
231 NetFilterState *nf = NETFILTER(uc);
232 NetFilterState *position = NULL;
233 NetClientState *ncs[MAX_QUEUE_NUM];
234 NetFilterClass *nfc = NETFILTER_GET_CLASS(uc);
236 Error *local_err = NULL;
238 if (!nf->netdev_id) {
239 error_setg(errp, "Parameter 'netdev' is required");
243 queues = qemu_find_net_clients_except(nf->netdev_id, ncs,
244 NET_CLIENT_DRIVER_NIC,
247 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "netdev",
248 "a network backend id");
250 } else if (queues > 1) {
251 error_setg(errp, "multiqueue is not supported");
255 if (get_vhost_net(ncs[0])) {
256 error_setg(errp, "Vhost is not supported");
260 if (strcmp(nf->position, "head") && strcmp(nf->position, "tail")) {
265 if (!g_str_has_prefix(nf->position, "id=")) {
266 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "position",
267 "'head', 'tail' or 'id=<id>'");
271 /* get the id from the string */
272 position_id = g_strndup(nf->position + 3, strlen(nf->position) - 3);
274 /* Search for the position to insert before/behind */
275 container = object_get_objects_root();
276 obj = object_resolve_path_component(container, position_id);
278 error_setg(errp, "filter '%s' not found", position_id);
283 position = NETFILTER(obj);
285 if (position->netdev != ncs[0]) {
286 error_setg(errp, "filter '%s' belongs to a different netdev",
298 nfc->setup(nf, &local_err);
300 error_propagate(errp, local_err);
306 if (nf->insert_before_flag) {
307 QTAILQ_INSERT_BEFORE(position, nf, next);
309 QTAILQ_INSERT_AFTER(&nf->netdev->filters, position, nf, next);
311 } else if (!strcmp(nf->position, "head")) {
312 QTAILQ_INSERT_HEAD(&nf->netdev->filters, nf, next);
313 } else if (!strcmp(nf->position, "tail")) {
314 QTAILQ_INSERT_TAIL(&nf->netdev->filters, nf, next);
318 static void netfilter_finalize(Object *obj)
320 NetFilterState *nf = NETFILTER(obj);
321 NetFilterClass *nfc = NETFILTER_GET_CLASS(obj);
327 if (nf->netdev && !QTAILQ_EMPTY(&nf->netdev->filters) &&
328 QTAILQ_IN_USE(nf, next)) {
329 QTAILQ_REMOVE(&nf->netdev->filters, nf, next);
331 g_free(nf->netdev_id);
332 g_free(nf->position);
335 static void default_handle_event(NetFilterState *nf, int event, Error **errp)
338 case COLO_EVENT_CHECKPOINT:
340 case COLO_EVENT_FAILOVER:
341 object_property_set_str(OBJECT(nf), "off", "status", errp);
348 static void netfilter_class_init(ObjectClass *oc, void *data)
350 UserCreatableClass *ucc = USER_CREATABLE_CLASS(oc);
351 NetFilterClass *nfc = NETFILTER_CLASS(oc);
353 ucc->complete = netfilter_complete;
354 nfc->handle_event = default_handle_event;
357 static const TypeInfo netfilter_info = {
358 .name = TYPE_NETFILTER,
359 .parent = TYPE_OBJECT,
361 .class_size = sizeof(NetFilterClass),
362 .class_init = netfilter_class_init,
363 .instance_size = sizeof(NetFilterState),
364 .instance_init = netfilter_init,
365 .instance_finalize = netfilter_finalize,
366 .interfaces = (InterfaceInfo[]) {
367 { TYPE_USER_CREATABLE },
372 static void register_types(void)
374 type_register_static(&netfilter_info);
377 type_init(register_types);