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/l2tp | |
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/l2tp')
-rw-r--r-- | net/l2tp/l2tp_netlink.c | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/net/l2tp/l2tp_netlink.c b/net/l2tp/l2tp_netlink.c index 6b16598f31d5..b4e923f77954 100644 --- a/net/l2tp/l2tp_netlink.c +++ b/net/l2tp/l2tp_netlink.c | |||
@@ -390,7 +390,8 @@ static int l2tp_nl_tunnel_send(struct sk_buff *skb, u32 portid, u32 seq, int fla | |||
390 | } | 390 | } |
391 | 391 | ||
392 | out: | 392 | out: |
393 | return genlmsg_end(skb, hdr); | 393 | genlmsg_end(skb, hdr); |
394 | return 0; | ||
394 | 395 | ||
395 | nla_put_failure: | 396 | nla_put_failure: |
396 | genlmsg_cancel(skb, hdr); | 397 | genlmsg_cancel(skb, hdr); |
@@ -451,7 +452,7 @@ static int l2tp_nl_cmd_tunnel_dump(struct sk_buff *skb, struct netlink_callback | |||
451 | 452 | ||
452 | if (l2tp_nl_tunnel_send(skb, NETLINK_CB(cb->skb).portid, | 453 | if (l2tp_nl_tunnel_send(skb, NETLINK_CB(cb->skb).portid, |
453 | cb->nlh->nlmsg_seq, NLM_F_MULTI, | 454 | cb->nlh->nlmsg_seq, NLM_F_MULTI, |
454 | tunnel, L2TP_CMD_TUNNEL_GET) <= 0) | 455 | tunnel, L2TP_CMD_TUNNEL_GET) < 0) |
455 | goto out; | 456 | goto out; |
456 | 457 | ||
457 | ti++; | 458 | ti++; |
@@ -752,7 +753,8 @@ static int l2tp_nl_session_send(struct sk_buff *skb, u32 portid, u32 seq, int fl | |||
752 | goto nla_put_failure; | 753 | goto nla_put_failure; |
753 | nla_nest_end(skb, nest); | 754 | nla_nest_end(skb, nest); |
754 | 755 | ||
755 | return genlmsg_end(skb, hdr); | 756 | genlmsg_end(skb, hdr); |
757 | return 0; | ||
756 | 758 | ||
757 | nla_put_failure: | 759 | nla_put_failure: |
758 | genlmsg_cancel(skb, hdr); | 760 | genlmsg_cancel(skb, hdr); |
@@ -816,7 +818,7 @@ static int l2tp_nl_cmd_session_dump(struct sk_buff *skb, struct netlink_callback | |||
816 | 818 | ||
817 | if (l2tp_nl_session_send(skb, NETLINK_CB(cb->skb).portid, | 819 | if (l2tp_nl_session_send(skb, NETLINK_CB(cb->skb).portid, |
818 | cb->nlh->nlmsg_seq, NLM_F_MULTI, | 820 | cb->nlh->nlmsg_seq, NLM_F_MULTI, |
819 | session, L2TP_CMD_SESSION_GET) <= 0) | 821 | session, L2TP_CMD_SESSION_GET) < 0) |
820 | break; | 822 | break; |
821 | 823 | ||
822 | si++; | 824 | si++; |