netfilter: flowtable: add function to invoke garbage collection immediately
Subsystems (2)
Pablo Neira Ayuso
maintainerPATCH 1/2 netfilter: flowtable: add function to invoke garbage collection immediately
Expose nf_flow_table_gc_run() to force a garbage collector run from the offload infrastructure.
--- include/net/netfilter/nf_flow_table.h | 1 + net/netfilter/nf_flow_table_core.c | 12 +++++++++--- 2 files changed, 10 insertions(+), 3 deletions(-)
include/net/netfilter/nf_flow_table.h +1 -0
@@ -270,6 +270,7 @@ void flow_offload_refresh(struct nf_flowtable *flow_table,struct flow_offload_tuple_rhash *flow_offload_lookup (struct nf_flowtable *flow_table,struct flow_offload_tuple *tuple); +void nf_flow_table_gc_run (struct nf_flowtable *flow_table);void nf_flow_table_gc_cleanup (struct nf_flowtable *flowtable,struct net_device *dev);void nf_flow_table_cleanup (struct net_device *dev);
net/netfilter/nf_flow_table_core.c +9 -3
@@ -437,12 +437,17 @@ static void nf_flow_offload_gc_step(struct nf_flowtable *flow_table, } } +void nf_flow_table_gc_run (struct nf_flowtable *flow_table) +{ +nf_flow_table_iterate (flow_table, nf_flow_offload_gc_step,NULL ); +} +static void nf_flow_offload_work_gc (struct work_struct *work) {struct nf_flowtable *flow_table; flow_table = container_of(work, struct nf_flowtable, gc_work.work); -nf_flow_table_iterate (flow_table, nf_flow_offload_gc_step,NULL ); +nf_flow_table_gc_run (flow_table);queue_delayed_work (system_power_efficient_wq, &flow_table->gc_work,HZ ); }
@@ -601,10 +606,11 @@ void nf_flow_table_free(struct nf_flowtable *flow_table)cancel_delayed_work_sync (&flow_table->gc_work);nf_flow_table_iterate (flow_table, nf_flow_table_do_cleanup,NULL ); -nf_flow_table_iterate (flow_table, nf_flow_offload_gc_step,NULL ); +nf_flow_table_gc_run (flow_table);nf_flow_table_offload_flush (flow_table);if (nf_flowtable_hw_offload (flow_table)) -nf_flow_table_iterate (flow_table, nf_flow_offload_gc_step,NULL ); +nf_flow_table_gc_run (flow_table); +rhashtable_destroy (&flow_table->rhashtable); }EXPORT_SYMBOL_GPL (nf_flow_table_free);
Signature · 1 line
2.30.2
Pablo Neira Ayuso
maintainerPATCH 2/2 netfilter: flowtable: fix stuck flows on cleanup due to pending work
To clear the flow table on flow table free, the following sequence normally happens in order:
1) gc_step work is stopped to disable any further stats/del requests.
2) All flow table entries are set to teardown state.
3) Run gc_step which will queue HW del work for each flow table entry.
4) Waiting for the above del work to finish (flush).
5) Run gc_step again, deleting all entries from the flow table.
6) Flow table is freed.
But if a flow table entry already has pending HW stats or HW add work step 3 will not queue HW del work (it will be skipped), step 4 will wait for the pending add/stats to finish, and step 5 will queue HW del work which might execute after freeing of the flow table.
To fix the above, this patch flushes the pending work, then it sets the teardown flag to all flows in the flowtable and it forces a garbage collector run to queue work to remove the flows from hardware, then it flushes this new pending work and (finally) it forces another garbage collector run to remove the entry from the software flowtable.
Stack trace:
[47773.882335] BUG: KASAN: use-after-free in down_read+0x99/0x460 [47773.883634] Write of size 8 at addr ffff888103b45aa8 by task kworker/u20:6/543704 [47773.885634] CPU: 3 PID: 543704 Comm: kworker/u20:6 Not tainted 5.12.0-rc7+ #2 [47773.886745] Hardware name: QEMU Standard PC (Q35 + ICH9, 2009) [47773.888438] Workqueue: nf_ft_offload_del flow_offload_work_handler [nf_flow_table] [47773.889727] Call Trace: [47773.890214] dump_stack+0xbb/0x107 [47773.890818] print_address_description.constprop.0+0x18/0x140 [47773.892990] kasan_report.cold+0x7c/0xd8 [47773.894459] kasan_check_range+0x145/0x1a0 [47773.895174] down_read+0x99/0x460 [47773.899706] nf_flow_offload_tuple+0x24f/0x3c0 [nf_flow_table] [47773.907137] flow_offload_work_handler+0x72d/0xbe0 [nf_flow_table] [47773.913372] process_one_work+0x8ac/0x14e0 [47773.921325] [47773.921325] Allocated by task 592159: [47773.922031] kasan_save_stack+0x1b/0x40 [47773.922730] __kasan_kmalloc+0x7a/0x90 [47773.923411] tcf_ct_flow_table_get+0x3cb/0x1230 [act_ct] [47773.924363] tcf_ct_init+0x71c/0x1156 [act_ct] [47773.925207] tcf_action_init_1+0x45b/0x700 [47773.925987] tcf_action_init+0x453/0x6b0 [47773.926692] tcf_exts_validate+0x3d0/0x600 [47773.927419] fl_change+0x757/0x4a51 [cls_flower] [47773.928227] tc_new_tfilter+0x89a/0x2070 [47773.936652] [47773.936652] Freed by task 543704: [47773.937303] kasan_save_stack+0x1b/0x40 [47773.938039] kasan_set_track+0x1c/0x30 [47773.938731] kasan_set_free_info+0x20/0x30 [47773.939467] __kasan_slab_free+0xe7/0x120 [47773.940194] slab_free_freelist_hook+0x86/0x190 [47773.941038] kfree+0xce/0x3a0 [47773.941644] tcf_ct_flow_table_cleanup_work
Original patch description and stack trace by Paul Blakey.
--- include/net/netfilter/nf_flow_table.h | 2 ++ net/netfilter/nf_flow_table_core.c | 7 +++---- net/netfilter/nf_flow_table_offload.c | 8 ++++++++ 3 files changed, 13 insertions(+), 4 deletions(-)
include/net/netfilter/nf_flow_table.h +2 -0
@@ -307,6 +307,8 @@ void nf_flow_offload_stats(struct nf_flowtable *flowtable, struct flow_offload *flow);void nf_flow_table_offload_flush (struct nf_flowtable *flowtable); +void nf_flow_table_offload_flush_cleanup (struct nf_flowtable *flowtable); +int nf_flow_table_offload_setup (struct nf_flowtable *flowtable,struct net_device *dev,enum flow_block_command cmd);
net/netfilter/nf_flow_table_core.c +3 -4
@@ -605,12 +605,11 @@ void nf_flow_table_free(struct nf_flowtable *flow_table)mutex_unlock (&flowtable_lock);cancel_delayed_work_sync (&flow_table->gc_work); +nf_flow_table_offload_flush (flow_table); +/* ... no more pending work after this stage ... */ nf_flow_table_iterate (flow_table, nf_flow_table_do_cleanup,NULL );nf_flow_table_gc_run (flow_table); -nf_flow_table_offload_flush (flow_table); -if (nf_flowtable_hw_offload (flow_table)) -nf_flow_table_gc_run (flow_table); - +nf_flow_table_offload_flush_cleanup (flow_table);rhashtable_destroy (&flow_table->rhashtable); }EXPORT_SYMBOL_GPL (nf_flow_table_free);
net/netfilter/nf_flow_table_offload.c +8 -0
@@ -1074,6 +1074,14 @@ void nf_flow_offload_stats(struct nf_flowtable *flowtable,flow_offload_queue_work (offload); } +void nf_flow_table_offload_flush_cleanup (struct nf_flowtable *flowtable) +{ +if (nf_flowtable_hw_offload (flowtable)) { +flush_workqueue (nf_flow_offload_del_wq); +nf_flow_table_gc_run (flowtable); + } +} +void nf_flow_table_offload_flush (struct nf_flowtable *flowtable) {if (nf_flowtable_hw_offload (flowtable)) {
Signature · 1 line
2.30.2
Re: [PATCH nf 2/2] netfilter: flowtable: fix stuck flows on cleanup due to pending work
Quoted 110 lines · Pablo Neira Ayuso
To clear the flow table on flow table free, the following sequence normally happens in order:
1)
gc_stepwork is stopped to disable any further stats/del requests.
2) All flow table entries are set to teardown state.
3) Rungc_stepwhich will queue HW del work for each flow table entry.
4) Waiting for the above del work to finish (flush).
5) Rungc_stepagain, deleting all entries from the flow table.
6) Flow table is freed.But if a flow table entry already has pending HW stats or HW add work step 3 will not queue HW del work (it will be skipped), step 4 will wait for the pending add/stats to finish, and step 5 will queue HW del work which might execute after freeing of the flow table.
To fix the above, this patch flushes the pending work, then it sets the teardown flag to all flows in the flowtable and it forces a garbage collector run to queue work to remove the flows from hardware, then it flushes this new pending work and (finally) it forces another garbage collector run to remove the entry from the software flowtable.
Stack trace:
[47773.882335] BUG: KASAN: use-after-free in down_read+0x99/0x460 [47773.883634] Write of size 8 at addr ffff888103b45aa8 by task kworker/u20:6/543704 [47773.885634] CPU: 3 PID: 543704 Comm: kworker/u20:6 Not tainted 5.12.0-rc7+ #2 [47773.886745] Hardware name: QEMU Standard PC (Q35 + ICH9, 2009) [47773.888438] Workqueue: nf_ft_offload_del flow_offload_work_handler [nf_flow_table] [47773.889727] Call Trace: [47773.890214] dump_stack+0xbb/0x107 [47773.890818] print_address_description.constprop.0+0x18/0x140 [47773.892990] kasan_report.cold+0x7c/0xd8 [47773.894459] kasan_check_range+0x145/0x1a0 [47773.895174] down_read+0x99/0x460 [47773.899706] nf_flow_offload_tuple+0x24f/0x3c0 [nf_flow_table] [47773.907137] flow_offload_work_handler+0x72d/0xbe0 [nf_flow_table] [47773.913372] process_one_work+0x8ac/0x14e0 [47773.921325] [47773.921325] Allocated by task 592159: [47773.922031] kasan_save_stack+0x1b/0x40 [47773.922730] __kasan_kmalloc+0x7a/0x90 [47773.923411] tcf_ct_flow_table_get+0x3cb/0x1230 [act_ct] [47773.924363] tcf_ct_init+0x71c/0x1156 [act_ct] [47773.925207] tcf_action_init_1+0x45b/0x700 [47773.925987] tcf_action_init+0x453/0x6b0 [47773.926692] tcf_exts_validate+0x3d0/0x600 [47773.927419] fl_change+0x757/0x4a51 [cls_flower] [47773.928227] tc_new_tfilter+0x89a/0x2070 [47773.936652] [47773.936652] Freed by task 543704: [47773.937303] kasan_save_stack+0x1b/0x40 [47773.938039] kasan_set_track+0x1c/0x30 [47773.938731] kasan_set_free_info+0x20/0x30 [47773.939467] __kasan_slab_free+0xe7/0x120 [47773.940194] slab_free_freelist_hook+0x86/0x190 [47773.941038] kfree+0xce/0x3a0 [47773.941644] tcf_ct_flow_table_cleanup_workOriginal patch description and stack trace by Paul Blakey.
Fixes c29f74e0df7a ("netfilter: nf_flow_table: hardware offload support")Reported-by Paul Blakey <[email protected]>Signed-off-by Pablo Neira Ayuso <[email protected]>--- include/net/netfilter/nf_flow_table.h | 2 ++ net/netfilter/nf_flow_table_core.c | 7 +++---- net/netfilter/nf_flow_table_offload.c | 8 ++++++++ 3 files changed, 13 insertions(+), 4 deletions(-)include/net/netfilter/nf_flow_table.h +2
-0@@ -307,6 +307,8 @@ void nf_flow_offload_stats(struct nf_flowtable *flowtable, struct flow_offload *flow);void nf_flow_table_offload_flush (struct nf_flowtable *flowtable); +void nf_flow_table_offload_flush_cleanup (struct nf_flowtable *flowtable); +int nf_flow_table_offload_setup (struct nf_flowtable *flowtable,struct net_device *dev,enum flow_block_command cmd);net/netfilter/nf_flow_table_core.c +3
-4@@ -605,12 +605,11 @@ void nf_flow_table_free(struct nf_flowtable *flow_table)mutex_unlock (&flowtable_lock);cancel_delayed_work_sync (&flow_table->gc_work); +nf_flow_table_offload_flush (flow_table); +/* ... no more pending work after this stage ... */ nf_flow_table_iterate (flow_table, nf_flow_table_do_cleanup,NULL );nf_flow_table_gc_run (flow_table); -nf_flow_table_offload_flush (flow_table); -if (nf_flowtable_hw_offload (flow_table)) -nf_flow_table_gc_run (flow_table); - +nf_flow_table_offload_flush_cleanup (flow_table);rhashtable_destroy (&flow_table->rhashtable); }EXPORT_SYMBOL_GPL (nf_flow_table_free);net/netfilter/nf_flow_table_offload.c +1
-0@@ -1074,6 +1074,14 @@ void nf_flow_offload_stats(struct nf_flowtable *flowtable,flow_offload_queue_work (offload); } +void nf_flow_table_offload_flush_cleanup (struct nf_flowtable *flowtable)
net/netfilter/nf_flow_table_offload.c void nf_flow_offload_stats(struct nf_flowtable *flowtable, · line 1087
Quoted 10 lines
net/netfilter/nf_flow_table_offload.c +7
-0+{ +if (nf_flowtable_hw_offload (flowtable)) { +flush_workqueue (nf_flow_offload_del_wq); +nf_flow_table_gc_run (flowtable); + } +} +void nf_flow_table_offload_flush (struct nf_flowtable *flowtable) {if (nf_flowtable_hw_offload (flowtable)) {