diff options
author | Johannes Berg <johannes.berg@intel.com> | 2015-01-16 16:09:00 -0500 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2015-01-18 01:03:45 -0500 |
commit | 053c095a82cf773075e83d7233b5cc19a1f73ece (patch) | |
tree | c787028efa9a73a182a0f338f87b6294cef4b8b9 /net/ipv4/inet_diag.c | |
parent | ede58ef28e105de94475b2b69fa069c9a2ce6933 (diff) |
netlink: make nlmsg_end() and genlmsg_end() void
Contrary to common expectations for an "int" return, these functions
return only a positive value -- if used correctly they cannot even
return 0 because the message header will necessarily be in the skb.
This makes the very common pattern of
if (genlmsg_end(...) < 0) { ... }
be a whole bunch of dead code. Many places also simply do
return nlmsg_end(...);
and the caller is expected to deal with it.
This also commonly (at least for me) causes errors, because it is very
common to write
if (my_function(...))
/* error condition */
and if my_function() does "return nlmsg_end()" this is of course wrong.
Additionally, there's not a single place in the kernel that actually
needs the message length returned, and if anyone needs it later then
it'll be very easy to just use skb->len there.
Remove this, and make the functions void. This removes a bunch of dead
code as described above. The patch adds lines because I did
- return nlmsg_end(...);
+ nlmsg_end(...);
+ return 0;
I could have preserved all the function's return values by returning
skb->len, but instead I've audited all the places calling the affected
functions and found that none cared. A few places actually compared
the return value with <= 0 in dump functionality, but that could just
be changed to < 0 with no change in behaviour, so I opted for the more
efficient version.
One instance of the error I've made numerous times now is also present
in net/phonet/pn_netlink.c in the route_dumpit() function - it didn't
check for <0 or <=0 and thus broke out of the loop every single time.
I've preserved this since it will (I think) have caused the messages to
userspace to be formatted differently with just a single message for
every SKB returned to userspace. It's possible that this isn't needed
for the tools that actually use this, but I don't even know what they
are so couldn't test that changing this behaviour would be acceptable.
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'net/ipv4/inet_diag.c')
-rw-r--r-- | net/ipv4/inet_diag.c | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/net/ipv4/inet_diag.c b/net/ipv4/inet_diag.c index e34dccbc4d70..81751f12645f 100644 --- a/net/ipv4/inet_diag.c +++ b/net/ipv4/inet_diag.c | |||
@@ -203,7 +203,8 @@ int inet_sk_diag_fill(struct sock *sk, struct inet_connection_sock *icsk, | |||
203 | icsk->icsk_ca_ops->get_info(sk, ext, skb); | 203 | icsk->icsk_ca_ops->get_info(sk, ext, skb); |
204 | 204 | ||
205 | out: | 205 | out: |
206 | return nlmsg_end(skb, nlh); | 206 | nlmsg_end(skb, nlh); |
207 | return 0; | ||
207 | 208 | ||
208 | errout: | 209 | errout: |
209 | nlmsg_cancel(skb, nlh); | 210 | nlmsg_cancel(skb, nlh); |
@@ -271,7 +272,8 @@ static int inet_twsk_diag_fill(struct inet_timewait_sock *tw, | |||
271 | } | 272 | } |
272 | #endif | 273 | #endif |
273 | 274 | ||
274 | return nlmsg_end(skb, nlh); | 275 | nlmsg_end(skb, nlh); |
276 | return 0; | ||
275 | } | 277 | } |
276 | 278 | ||
277 | static int sk_diag_fill(struct sock *sk, struct sk_buff *skb, | 279 | static int sk_diag_fill(struct sock *sk, struct sk_buff *skb, |
@@ -758,7 +760,8 @@ static int inet_diag_fill_req(struct sk_buff *skb, struct sock *sk, | |||
758 | } | 760 | } |
759 | #endif | 761 | #endif |
760 | 762 | ||
761 | return nlmsg_end(skb, nlh); | 763 | nlmsg_end(skb, nlh); |
764 | return 0; | ||
762 | } | 765 | } |
763 | 766 | ||
764 | static int inet_diag_dump_reqs(struct sk_buff *skb, struct sock *sk, | 767 | static int inet_diag_dump_reqs(struct sk_buff *skb, struct sock *sk, |