netfs: Add a ->free_subrequest() op
[linux-2.6-microblaze.git] / fs / netfs / objects.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Object lifetime handling and tracing.
3  *
4  * Copyright (C) 2022 Red Hat, Inc. All Rights Reserved.
5  * Written by David Howells (dhowells@redhat.com)
6  */
7
8 #include <linux/slab.h>
9 #include "internal.h"
10
11 /*
12  * Allocate an I/O request and initialise it.
13  */
14 struct netfs_io_request *netfs_alloc_request(struct address_space *mapping,
15                                              struct file *file,
16                                              loff_t start, size_t len,
17                                              enum netfs_io_origin origin)
18 {
19         static atomic_t debug_ids;
20         struct inode *inode = file ? file_inode(file) : mapping->host;
21         struct netfs_inode *ctx = netfs_inode(inode);
22         struct netfs_io_request *rreq;
23         int ret;
24
25         rreq = kzalloc(ctx->ops->io_request_size ?: sizeof(struct netfs_io_request),
26                        GFP_KERNEL);
27         if (!rreq)
28                 return ERR_PTR(-ENOMEM);
29
30         rreq->start     = start;
31         rreq->len       = len;
32         rreq->origin    = origin;
33         rreq->netfs_ops = ctx->ops;
34         rreq->mapping   = mapping;
35         rreq->inode     = inode;
36         rreq->i_size    = i_size_read(inode);
37         rreq->debug_id  = atomic_inc_return(&debug_ids);
38         INIT_LIST_HEAD(&rreq->subrequests);
39         refcount_set(&rreq->ref, 1);
40         __set_bit(NETFS_RREQ_IN_PROGRESS, &rreq->flags);
41         if (rreq->netfs_ops->init_request) {
42                 ret = rreq->netfs_ops->init_request(rreq, file);
43                 if (ret < 0) {
44                         kfree(rreq);
45                         return ERR_PTR(ret);
46                 }
47         }
48
49         netfs_proc_add_rreq(rreq);
50         netfs_stat(&netfs_n_rh_rreq);
51         return rreq;
52 }
53
54 void netfs_get_request(struct netfs_io_request *rreq, enum netfs_rreq_ref_trace what)
55 {
56         int r;
57
58         __refcount_inc(&rreq->ref, &r);
59         trace_netfs_rreq_ref(rreq->debug_id, r + 1, what);
60 }
61
62 void netfs_clear_subrequests(struct netfs_io_request *rreq, bool was_async)
63 {
64         struct netfs_io_subrequest *subreq;
65
66         while (!list_empty(&rreq->subrequests)) {
67                 subreq = list_first_entry(&rreq->subrequests,
68                                           struct netfs_io_subrequest, rreq_link);
69                 list_del(&subreq->rreq_link);
70                 netfs_put_subrequest(subreq, was_async,
71                                      netfs_sreq_trace_put_clear);
72         }
73 }
74
75 static void netfs_free_request(struct work_struct *work)
76 {
77         struct netfs_io_request *rreq =
78                 container_of(work, struct netfs_io_request, work);
79
80         trace_netfs_rreq(rreq, netfs_rreq_trace_free);
81         netfs_proc_del_rreq(rreq);
82         netfs_clear_subrequests(rreq, false);
83         if (rreq->netfs_ops->free_request)
84                 rreq->netfs_ops->free_request(rreq);
85         if (rreq->cache_resources.ops)
86                 rreq->cache_resources.ops->end_operation(&rreq->cache_resources);
87         kfree_rcu(rreq, rcu);
88         netfs_stat_d(&netfs_n_rh_rreq);
89 }
90
91 void netfs_put_request(struct netfs_io_request *rreq, bool was_async,
92                        enum netfs_rreq_ref_trace what)
93 {
94         unsigned int debug_id = rreq->debug_id;
95         bool dead;
96         int r;
97
98         dead = __refcount_dec_and_test(&rreq->ref, &r);
99         trace_netfs_rreq_ref(debug_id, r - 1, what);
100         if (dead) {
101                 if (was_async) {
102                         rreq->work.func = netfs_free_request;
103                         if (!queue_work(system_unbound_wq, &rreq->work))
104                                 BUG();
105                 } else {
106                         netfs_free_request(&rreq->work);
107                 }
108         }
109 }
110
111 /*
112  * Allocate and partially initialise an I/O request structure.
113  */
114 struct netfs_io_subrequest *netfs_alloc_subrequest(struct netfs_io_request *rreq)
115 {
116         struct netfs_io_subrequest *subreq;
117
118         subreq = kzalloc(rreq->netfs_ops->io_subrequest_size ?:
119                          sizeof(struct netfs_io_subrequest),
120                          GFP_KERNEL);
121         if (subreq) {
122                 INIT_LIST_HEAD(&subreq->rreq_link);
123                 refcount_set(&subreq->ref, 2);
124                 subreq->rreq = rreq;
125                 netfs_get_request(rreq, netfs_rreq_trace_get_subreq);
126                 netfs_stat(&netfs_n_rh_sreq);
127         }
128
129         return subreq;
130 }
131
132 void netfs_get_subrequest(struct netfs_io_subrequest *subreq,
133                           enum netfs_sreq_ref_trace what)
134 {
135         int r;
136
137         __refcount_inc(&subreq->ref, &r);
138         trace_netfs_sreq_ref(subreq->rreq->debug_id, subreq->debug_index, r + 1,
139                              what);
140 }
141
142 static void netfs_free_subrequest(struct netfs_io_subrequest *subreq,
143                                   bool was_async)
144 {
145         struct netfs_io_request *rreq = subreq->rreq;
146
147         trace_netfs_sreq(subreq, netfs_sreq_trace_free);
148         if (rreq->netfs_ops->free_subrequest)
149                 rreq->netfs_ops->free_subrequest(subreq);
150         kfree(subreq);
151         netfs_stat_d(&netfs_n_rh_sreq);
152         netfs_put_request(rreq, was_async, netfs_rreq_trace_put_subreq);
153 }
154
155 void netfs_put_subrequest(struct netfs_io_subrequest *subreq, bool was_async,
156                           enum netfs_sreq_ref_trace what)
157 {
158         unsigned int debug_index = subreq->debug_index;
159         unsigned int debug_id = subreq->rreq->debug_id;
160         bool dead;
161         int r;
162
163         dead = __refcount_dec_and_test(&subreq->ref, &r);
164         trace_netfs_sreq_ref(debug_id, debug_index, r - 1, what);
165         if (dead)
166                 netfs_free_subrequest(subreq, was_async);
167 }