From: David Smith <dsmith@redhat.com>
Date: Tue, 4 Jun 2013 13:31:48 +0000 (-0500)
Subject: Fixed PR15523 by updating the socket.stp tapset.
X-Git-Tag: release-2.3~196
X-Git-Url: https://sourceware.org/git/?a=commitdiff_plain;h=b53b29317d328612f6bc016f0abeb2ae87d2d563;p=systemtap.git

Fixed PR15523 by updating the socket.stp tapset.

* tapset/linux/socket.stp: Reimplemented functions as macros. The old
  functions were deprecated. Used those new macros throughout the tapset,
  to avoid trying to use NULL pointers.
* NEWS: Mentioned function deprecations.
* testsuite/buildok/socket-embedded.stp: No longer test deprecated
  functions.
---

diff --git a/NEWS b/NEWS
index 83f9d97b6..bd15331f2 100644
--- a/NEWS
+++ b/NEWS
@@ -7,7 +7,9 @@
   consistency with [nd_]syscall.semtimedop.
 
 - The following tapset functions are deprecated in release 2.3:
-  'stap_NFS_CLIENT' and '__getfh_inode'
+  'stap_NFS_CLIENT', '__getfh_inode', '_success_check',
+  '_sock_prot_num', '_sock_fam_num', '_sock_state_num',
+  '_sock_type_num', and '_sock_flags_num'.
 
 * What's new in version 2.2.1, 2013-05-16
 * What's new in version 2.2, 2013-05-14
diff --git a/tapset/linux/socket.stp b/tapset/linux/socket.stp
index 4e94fc3fe..d3f625cee 100644
--- a/tapset/linux/socket.stp
+++ b/tapset/linux/socket.stp
@@ -1,6 +1,6 @@
 // Socket tapset
 // Copyright (C) 2006 IBM Corp.
-// Copyright (C) 2010 Red Hat Inc.
+// Copyright (C) 2010-2013 Red Hat Inc.
 //
 // This file is part of systemtap, and is free software.  You can
 // redistribute it and/or modify it under the terms of the GNU General
@@ -14,6 +14,55 @@
 #include <asm/bitops.h>
 %}
 
+###################
+# INTERNAL MACROS #
+###################
+
+// Note that since these macros are defined in this file, they are
+// local to this file. They are internal only.
+//
+// Note the '&@sock[0]' usage below. This allows calling the macros
+// with either a dwarf variable (like '$sock') or casts (like
+// '@cast(_sock, "socket", "kernel") without needing additional casts
+// inside the macros (which would then lose type information when
+// called with a dwarf variable).
+
+// Return whether the operation was successful.
+@define _sock_success_check(ret)
+%(
+	( @ret >= 0 ? 1 : 0 )
+%)
+
+// Return the socket protocol number.
+@define _sock_prot_num(sock)
+%(
+	( &@sock[0] ? ( @sock->sk ? @sock->sk->sk_protocol : -1 ) : -1 )
+%)
+
+// Return the socket family number.
+@define _sock_fam_num(sock)
+%(
+	( &@sock[0] ? ( @sock->ops ? @sock->ops->family : -1 ) : -1 )
+%)
+
+// Return the socket state number.
+@define _sock_state_num(sock)
+%(
+	( &@sock[0] ? @sock->state : -1 )
+%)
+
+// Return the socket type number.
+@define _sock_type_num(sock)
+%(
+	( &@sock[0] ? @sock->type : -1 )
+%)
+
+// Return the socket flags number.
+@define _sock_flags_num(sock)
+%(
+	( &@sock[0] ? @sock->flags : -1 )
+%)
+
 #################
 # PROBE ALIASES #
 #################
@@ -84,11 +133,11 @@ probe socket.sendmsg = kernel.function ("sock_sendmsg")
 {
 	name = "socket.sendmsg"
 	size = $size
-	protocol = $sock->sk->sk_protocol
-	family = $sock->ops->family
-	state = $sock->state
-	flags = $sock->flags
-	type = $sock->type
+	protocol = @_sock_prot_num($sock)
+	family = @_sock_fam_num($sock)
+	state = @_sock_state_num($sock)
+	flags = @_sock_flags_num($sock)
+	type = @_sock_type_num($sock)
 }
 
 /**
@@ -112,12 +161,12 @@ probe socket.sendmsg.return = kernel.function("sock_sendmsg").return
 {
 	name = "socket.sendmsg.return"
 	size = $return
-	protocol = $sock->sk->sk_protocol
-	family = $sock->ops->family
-	state = $sock->state
-	flags = $sock->flags
-	type = $sock->type
-	success = _success_check($return)
+	protocol = @_sock_prot_num($sock)
+	family = @_sock_fam_num($sock)
+	state = @_sock_state_num($sock)
+	flags = @_sock_flags_num($sock)
+	type = @_sock_type_num($sock)
+	success = @_sock_success_check($return)
 }
 
 /**
@@ -141,11 +190,11 @@ probe socket.recvmsg = kernel.function("sock_recvmsg")
 {
 	name = "socket.recvmsg"
 	size = $size
-	protocol = $sock->sk->sk_protocol
-	family = $sock->ops->family
-	state = $sock->state
-	flags = $sock->flags
-	type = $sock->type
+	protocol = @_sock_prot_num($sock)
+	family = @_sock_fam_num($sock)
+	state = @_sock_state_num($sock)
+	flags = @_sock_flags_num($sock)
+	type = @_sock_type_num($sock)
 }
 
 /**
@@ -171,12 +220,12 @@ probe socket.recvmsg.return = kernel.function("sock_recvmsg").return
 {
 	name = "socket.recvmsg.return"
 	size = $return
-	protocol = $sock->sk->sk_protocol
-	family = $sock->ops->family
-	state = $sock->state
-	flags = $sock->flags
-	type = $sock->type
-	success = _success_check($return)
+	protocol = @_sock_prot_num($sock)
+	family = @_sock_fam_num($sock)
+	state = @_sock_state_num($sock)
+	flags = @_sock_flags_num($sock)
+	type = @_sock_type_num($sock)
+	success = @_sock_success_check($return)
 }
 
 /**
@@ -212,11 +261,11 @@ probe socket.aio_write = kernel.function("sock_aio_write")
 	_sock = _get_sock_addr($iocb->ki_filp)
 	size = (@defined($iov) ? _get_sock_size($iov, $nr_segs)
 		: @choose_defined($count, $size))
-	protocol = _sock_prot_num(_sock)
-	family = _sock_fam_num(_sock)
-	state = _sock_state_num(_sock)
-	flags = _sock_flags_num(_sock)
-	type = _sock_type_num(_sock)
+	protocol = @_sock_prot_num(@cast(_sock, "socket", "kernel"))
+	family = @_sock_fam_num(@cast(_sock, "socket", "kernel"))
+	state = @_sock_state_num(@cast(_sock, "socket", "kernel"))
+	flags = @_sock_flags_num(@cast(_sock, "socket", "kernel"))
+	type = @_sock_type_num(@cast(_sock, "socket", "kernel"))
 }
 
 /**
@@ -241,12 +290,12 @@ probe socket.aio_write.return = kernel.function("sock_aio_write").return
 	name = "socket.aio_write.return"
 	size = $return
 	_sock = _get_sock_addr($iocb->ki_filp)
-	protocol = _sock_prot_num(_sock)
-	family = _sock_fam_num(_sock)
-	state = _sock_state_num(_sock)
-	flags = _sock_flags_num(_sock)
-	type = _sock_type_num(_sock)
-	success = _success_check($return)
+	protocol = @_sock_prot_num(@cast(_sock, "socket", "kernel"))
+	family = @_sock_fam_num(@cast(_sock, "socket", "kernel"))
+	state = @_sock_state_num(@cast(_sock, "socket", "kernel"))
+	flags = @_sock_flags_num(@cast(_sock, "socket", "kernel"))
+	type = @_sock_type_num(@cast(_sock, "socket", "kernel"))
+	success = @_sock_success_check($return)
 }
 
 /**
@@ -280,13 +329,13 @@ probe socket.aio_read = kernel.function("sock_aio_read")
 {
 	name = "socket.aio_read"
 	_sock = _get_sock_addr($iocb->ki_filp)
-	size =(@defined($iov) ? _get_sock_size($iov, $nr_segs)
+	size = (@defined($iov) ? _get_sock_size($iov, $nr_segs)
 		: @choose_defined($count, $size))
-	protocol = _sock_prot_num(_sock)
-	family = _sock_fam_num(_sock)
-	state = _sock_state_num(_sock)
-	flags = _sock_flags_num(_sock)
-	type = _sock_type_num(_sock)
+	protocol = @_sock_prot_num(@cast(_sock, "socket", "kernel"))
+	family = @_sock_fam_num(@cast(_sock, "socket", "kernel"))
+	state = @_sock_state_num(@cast(_sock, "socket", "kernel"))
+	flags = @_sock_flags_num(@cast(_sock, "socket", "kernel"))
+	type = @_sock_type_num(@cast(_sock, "socket", "kernel"))
 }
 
 /**
@@ -311,12 +360,12 @@ probe socket.aio_read.return = kernel.function("sock_aio_read").return
 	name = "socket.aio_read.return"
 	size = $return
 	_sock = _get_sock_addr($iocb->ki_filp)
-	protocol = _sock_prot_num(_sock)
-	family = _sock_fam_num(_sock)
-	state = _sock_state_num(_sock)
-	flags = _sock_flags_num(_sock)
-	type = _sock_type_num(_sock)
-	success = _success_check($return)
+	protocol = @_sock_prot_num(@cast(_sock, "socket", "kernel"))
+	family = @_sock_fam_num(@cast(_sock, "socket", "kernel"))
+	state = @_sock_state_num(@cast(_sock, "socket", "kernel"))
+	flags = @_sock_flags_num(@cast(_sock, "socket", "kernel"))
+	type = @_sock_type_num(@cast(_sock, "socket", "kernel"))
+	success = @_sock_success_check($return)
 }
 
 /**
@@ -341,11 +390,11 @@ probe socket.writev = kernel.function("sock_writev") ?
 	_sock = _get_sock_addr($file)
 	size = (@defined($iov) ? _get_sock_size($iov, $nr_segs)
 		: _get_sock_size($vector, $count))
-	protocol = _sock_prot_num(_sock)
-	family = _sock_fam_num(_sock)
-	state = _sock_state_num(_sock)
-	flags = _sock_flags_num(_sock)
-	type = _sock_type_num(_sock)
+	protocol = @_sock_prot_num(@cast(_sock, "socket", "kernel"))
+	family = @_sock_fam_num(@cast(_sock, "socket", "kernel"))
+	state = @_sock_state_num(@cast(_sock, "socket", "kernel"))
+	flags = @_sock_flags_num(@cast(_sock, "socket", "kernel"))
+	type = @_sock_type_num(@cast(_sock, "socket", "kernel"))
 }
 
 /**
@@ -370,12 +419,12 @@ probe socket.writev.return = kernel.function("sock_writev").return ?
 	name = "socket.writev.return"
 	size = $return
 	_sock = _get_sock_addr($file)
-	protocol = _sock_prot_num(_sock)
-	family = _sock_fam_num(_sock)
-	state = _sock_state_num(_sock)
-	flags = _sock_flags_num(_sock)
-	type = _sock_type_num(_sock)
-	success = _success_check($return)
+	protocol = @_sock_prot_num(@cast(_sock, "socket", "kernel"))
+	family = @_sock_fam_num(@cast(_sock, "socket", "kernel"))
+	state = @_sock_state_num(@cast(_sock, "socket", "kernel"))
+	flags = @_sock_flags_num(@cast(_sock, "socket", "kernel"))
+	type = @_sock_type_num(@cast(_sock, "socket", "kernel"))
+	success = @_sock_success_check($return)
 }
 
 /**
@@ -400,11 +449,11 @@ probe socket.readv = kernel.function("sock_readv") ?
 	_sock = _get_sock_addr($file)
 	size = (@defined($iov) ? _get_sock_size($iov, $nr_segs)
 		: _get_sock_size($vector, $count))
-	protocol = _sock_prot_num(_sock)
-	family = _sock_fam_num(_sock)
-	state = _sock_state_num(_sock)
-	flags = _sock_flags_num(_sock)
-	type = _sock_type_num(_sock)
+	protocol = @_sock_prot_num(@cast(_sock, "socket", "kernel"))
+	family = @_sock_fam_num(@cast(_sock, "socket", "kernel"))
+	state = @_sock_state_num(@cast(_sock, "socket", "kernel"))
+	flags = @_sock_flags_num(@cast(_sock, "socket", "kernel"))
+	type = @_sock_type_num(@cast(_sock, "socket", "kernel"))
 }
 
 /**
@@ -429,12 +478,12 @@ probe socket.readv.return = kernel.function("sock_readv").return ?
 	name = "socket.readv.return"
 	size = $return
 	_sock = _get_sock_addr($file)
-	protocol = _sock_prot_num(_sock)
-	family = _sock_fam_num(_sock)
-	state = _sock_state_num(_sock)
-	flags = _sock_flags_num(_sock)
-	type = _sock_type_num(_sock)
-	success = _success_check($return)
+	protocol = @_sock_prot_num(@cast(_sock, "socket", "kernel"))
+	family = @_sock_fam_num(@cast(_sock, "socket", "kernel"))
+	state = @_sock_state_num(@cast(_sock, "socket", "kernel"))
+	flags = @_sock_flags_num(@cast(_sock, "socket", "kernel"))
+	type = @_sock_type_num(@cast(_sock, "socket", "kernel"))
+	success = @_sock_success_check($return)
 }
 
 /**
@@ -456,7 +505,7 @@ probe socket.create = kernel.function("__sock_create")
 	protocol = $protocol
 	family = $family
 	type = $type
-	requester =$kern
+	requester = $kern
 }
 
 /**
@@ -480,9 +529,9 @@ probe socket.create.return = kernel.function("__sock_create").return
 	protocol = $protocol
 	family = $family
 	type = $type
-	requester =$kern
+	requester = $kern
 	err = $return
-	success = _success_check($return)
+	success = @_sock_success_check($return)
 }
 
 /**
@@ -502,11 +551,11 @@ probe socket.create.return = kernel.function("__sock_create").return
 probe socket.close = kernel.function("sock_release")
 {
 	name = "socket.close"
-	protocol = $sock->sk->sk_protocol
-	family = $sock->ops->family
-	state = $sock->state
-	flags = $sock->flags
-	type = $sock->type
+	protocol = @_sock_prot_num($sock)
+	family = @_sock_fam_num($sock)
+	state = @_sock_state_num($sock)
+	flags = @_sock_flags_num($sock)
+	type = @_sock_type_num($sock)
 }
 
 /**
@@ -887,11 +936,6 @@ probe begin(-1001)
 # INTERNAL FUNCTIONS #
 ######################
 
-function _success_check:long(ret:long)
-{
-	return (ret >= 0 ? 1 : 0)
-}
-
 function _get_sock_addr:long(file:long)
 %{ /* pure */
 	struct file *filep = (struct file *)(long)(STAP_ARG_file);
@@ -926,44 +970,34 @@ function _get_sock_size:long(iov:long, nr_segs:long)
 	CATCH_DEREF_FAULT();
 %}
 
+%( systemtap_v < "2.3" %?
+function _success_check:long(ret:long)
+{
+	return @_sock_success_check(ret)
+}
+
 function _sock_prot_num:long(sock:long)
 {
-	skp = sock? @cast(sock, "socket", "kernel")->sk : 0
-	if (skp == 0)
-		return -1
-	else
-		return @cast(skp, "sock", "kernel")->sk_protocol
+	return @_sock_prot_num(@cast(sock, "socket", "kernel"))
 }
 
 function _sock_fam_num:long(sock:long)
 {
-	ops = sock? @cast(sock, "socket", "kernel")->ops : 0
-	if (ops == 0)
-		return -1
-	else
-		return @cast(ops, "proto_ops", "kernel")->family
+	return @_sock_fam_num(@cast(sock, "socket", "kernel"))
 }
 
 function _sock_state_num:long(sock:long)
 {
-	if (sock == 0)
-		return -1
-	else
-		return @cast(sock, "socket", "kernel")->state
+	return @_sock_state_num(@cast(sock, "socket", "kernel"))
 }
 
 function _sock_type_num:long(sock:long)
 {
-        if (sock == 0)
-                return -1
-        else
-                return @cast(sock, "socket", "kernel")->type
+	return @_sock_type_num(@cast(sock, "socket", "kernel"))
 }
 
 function _sock_flags_num:long(sock:long)
 {
-        if (sock == 0)
-                return -1
-        else
-                return @cast(sock, "socket", "kernel")->flags
+	return @_sock_flags_num(@cast(sock, "socket", "kernel"))
 }
+%)
diff --git a/testsuite/buildok/socket-embedded.stp b/testsuite/buildok/socket-embedded.stp
index 621bedc77..04b1e35fb 100755
--- a/testsuite/buildok/socket-embedded.stp
+++ b/testsuite/buildok/socket-embedded.stp
@@ -12,13 +12,16 @@ probe begin {
 		sock_fam_str2num ("") +
 		sock_state_str2num ("") +
 		sock_type_str2num ("") +
-		_success_check (0) +
 		_get_sock_addr (0) +
 		_get_sock_size (0, 0) +
+%( systemtap_v < "2.3" %?
+		_success_check (0) +
 		_sock_prot_num (0) +
 		_sock_fam_num (0) +
 		_sock_state_num (0) +
 		_sock_type_num (0) +
-		_sock_flags_num (0))
+		_sock_flags_num (0) +
+%)
+		0)
 }