Build fix: retrieve unix socket peer PID on non-unix platforms

[lttng-tools.git] / src / common / compat / socket.h

diff --git a/src/common/compat/socket.h b/src/common/compat/socket.h
index 464678292b95eed68afa5cc2d9e0311bd6843b41..fda00e536413ed22ab69302fcd4aa0fe8f8740dd 100644 (file)
--- a/src/common/compat/socket.h
+++ b/src/common/compat/socket.h
@@ -10,6 +10,7 @@
 
 #include <sys/socket.h>
 #include <sys/un.h>
+#include <unistd.h>
 
 #include <common/macros.h>
 
@@ -97,8 +98,58 @@ ssize_t lttng_recvmsg_nosigpipe(int sockfd, struct msghdr *msg)
 }
 #endif
 
+#ifdef __sun__
+
+# ifndef CMSG_ALIGN
+#  ifdef _CMSG_DATA_ALIGN
+#   define CMSG_ALIGN(len) _CMSG_DATA_ALIGN(len)
+#  else
+    /* aligning to sizeof (long) is assumed to be portable (fd.o#40235) */
+#   define CMSG_ALIGN(len) (((len) + sizeof (long) - 1) & ~(sizeof (long) - 1))
+#  endif
+#  ifndef CMSG_SPACE
+#    define CMSG_SPACE(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + CMSG_ALIGN (len))
+#  endif
+#  ifndef CMSG_LEN
+#    define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
+#  endif
+# endif
+
+#include <ucred.h>
 
-#ifdef __linux__
+static inline
+int getpeereid(int s, uid_t *euid, gid_t *gid)
+{
+       int ret = 0;
+       ucred_t *ucred = NULL;
+
+       ret = getpeerucred(s, &ucred);
+       if (ret == -1) {
+               goto end;
+       }
+
+       ret = ucred_geteuid(ucred);
+       if (ret == -1) {
+               goto free;
+       }
+       *euid = ret;
+
+       ret = ucred_getrgid(ucred);
+       if (ret == -1) {
+               goto free;
+       }
+       *gid = ret;
+
+       ret = 0;
+free:
+       ucred_free(ucred);
+end:
+       return ret;
+}
+#endif /* __sun__ */
+
+
+#if defined(__linux__) || defined(__CYGWIN__)
 
 #define LTTNG_SOCK_CREDS SCM_CREDENTIALS
 
@@ -112,7 +163,7 @@ typedef struct ucred lttng_sock_cred;
 #define LTTNG_SOCK_GET_GID_CRED(c) LTTNG_REF(c)->gid
 #define LTTNG_SOCK_GET_PID_CRED(c) LTTNG_REF(c)->pid
 
-#elif (defined(__FreeBSD__) || defined(__CYGWIN__) || defined(__sun__) || defined(__APPLE__))
+#elif (defined(__FreeBSD__) || defined(__sun__) || defined(__APPLE__))
 
 struct lttng_sock_cred {
        uid_t uid;
@@ -124,39 +175,27 @@ typedef struct lttng_sock_cred lttng_sock_cred;
 
 #define LTTNG_SOCK_SET_UID_CRED(c, u) LTTNG_REF(c)->uid = u
 #define LTTNG_SOCK_SET_GID_CRED(c, g) LTTNG_REF(c)->gid = g
-#define LTTNG_SOCK_SET_PID_CRED(c, p)
+#define LTTNG_SOCK_SET_PID_CRED(c, p) LTTNG_REF(c)->pid = p
 
 #define LTTNG_SOCK_GET_UID_CRED(c) LTTNG_REF(c)->uid
 #define LTTNG_SOCK_GET_GID_CRED(c) LTTNG_REF(c)->gid
-#define LTTNG_SOCK_GET_PID_CRED(c) -1
-
-#else
-#error "Please add support for your OS."
-#endif /* __linux__ , __FreeBSD__ */
-
-
-#ifdef __sun__
+#define LTTNG_SOCK_GET_PID_CRED(c) LTTNG_REF(c)->pid
 
-# ifndef CMSG_ALIGN
-#  ifdef _CMSG_DATA_ALIGN
-#   define CMSG_ALIGN(len) _CMSG_DATA_ALIGN(len)
-#  else
-    /* aligning to sizeof (long) is assumed to be portable (fd.o#40235) */
-#   define CMSG_ALIGN(len) (((len) + sizeof (long) - 1) & ~(sizeof (long) - 1))
-#  endif
-#  ifndef CMSG_SPACE
-#    define CMSG_SPACE(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + CMSG_ALIGN (len))
-#  endif
-#  ifndef CMSG_LEN
-#    define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
-#  endif
-# endif
+#ifdef __APPLE__
 
+static inline
+int lttng_get_unix_socket_peer_pid(int socket_fd, pid_t *pid)
+{
+       /* The getsockopt LOCAL_PEERPID option is available since macOS 10.8. */
+       return getsockopt(socket_fd, SOL_LOCAL, LOCAL_PEERPID, pid,
+                       &((socklen_t) {sizeof(*pid)}));
+}
 
-#include <ucred.h>
+#elif defined(__sun__)
 
+/* Use the getpeerucreds interface on Solaris. */
 static inline
-int getpeereid(int s, uid_t *euid, gid_t *gid, pid_t *pid)
+int lttng_get_unix_socket_peer_pid(int socket_fd, pid_t *pid)
 {
        int ret = 0;
        ucred_t *ucred = NULL;
@@ -166,24 +205,12 @@ int getpeereid(int s, uid_t *euid, gid_t *gid, pid_t *pid)
                goto end;
        }
 
-       ret = ucred_geteuid(ucred);
-       if (ret == -1) {
-               goto free;
-       }
-       *euid = ret;
-
-       ret = ucred_getrgid(ucred);
-       if (ret == -1) {
-               goto free;
-       }
-       *gid = ret;
-
        ret = ucred_getpid(ucred);
        if (ret == -1) {
                goto free;
        }
-       *pid = ret;
 
+       *pid = ret;
        ret = 0;
 free:
        ucred_free(ucred);
@@ -191,6 +218,53 @@ end:
        return ret;
 }
 
-#endif /* __sun__ */
+#elif defined(__FreeBSD__)
+
+#include <sys/ucred.h>
+
+static inline
+int lttng_get_unix_socket_peer_pid(int socket_fd, pid_t *pid)
+{
+       int ret;
+       struct xucred sock_creds = {};
+
+       /* Only available in FreeBSD 13.0 and up. */
+       ret = getsockopt(socket_fd, SOL_LOCAL, LOCAL_PEERCRED, &sock_creds,
+                       &((socklen_t) {sizeof(sock_creds)}));
+       if (ret) {
+               goto end;
+       }
+
+       *pid = sock_creds.cr_pid;
+end:
+       return ret;
+}
+
+#endif /* __APPLE__ */
+
+
+static inline
+int lttng_get_unix_socket_peer_creds(int socket_fd, struct lttng_sock_cred *creds)
+{
+       int ret;
+
+       /* This is a BSD extension that is supported by Cygwin. */
+       ret = getpeereid(socket_fd, &creds->uid, &creds->gid);
+       if (ret) {
+               goto end;
+       }
+
+       /*
+        * Getting a peer's PID is a bit more troublesome as it is platform
+        * specific.
+        */
+       ret = lttng_get_unix_socket_peer_pid(socket_fd, &creds->pid);
+end:
+       return ret;
+}
+
+#else
+#error "Please add support for your OS."
+#endif /* __linux__ , __FreeBSD__, __APPLE__ */
 
 #endif /* _COMPAT_SOCKET_H */