Skip to content

Conversation

HarithaIBM
Copy link
Contributor

@HarithaIBM HarithaIBM commented Aug 22, 2024

Enable Git to resolve its own binary location using __getprogramdir and getprogname.

Since /proc is not a mandatory filesystem on z/OS, we cannot rely on the git_get_exec_path_procfs method to determine Git's executable path. To address this, we have implemented git_get_exec_path_zos, which resolves the executable path by extracting it from the current program's directory and filename.

cc: Haritha D Harithamma.D@ibm.com

Enable Git to resolve its own binary location using __getprogramdir
and getprogname.

Since /proc is not a mandatory filesystem on z/OS, we cannot rely on the
git_get_exec_path_procfs method to determine Git's executable path. To
address this, we have implemented git_get_exec_path_zos, which resolves
the executable path by extracting it from the current program's
directory and filename.

Signed-off-by: D Harithamma <harithamma.d@ibm.com>
@HarithaIBM
Copy link
Contributor Author

/submit

Copy link

Submitted as pull.1769.git.git.1724334732249.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-1769/HarithaIBM/execmdFix-v1

To fetch this version to local tag pr-git-1769/HarithaIBM/execmdFix-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-1769/HarithaIBM/execmdFix-v1

Copy link

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Haritha  via GitGitGadget" <gitgitgadget@gmail.com> writes:

>  Makefile         |  8 ++++++++
>  config.mak.uname |  1 +
>  exec-cmd.c       | 23 +++++++++++++++++++++++
>  3 files changed, 32 insertions(+)
>
> diff --git a/Makefile b/Makefile
> index a87e18b317d..bdc68234823 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -385,6 +385,10 @@ include shared.mak
>  # supports calling _NSGetExecutablePath to retrieve the path of the running
>  # executable.
>  #
> +# When using RUNTIME_PREFIX, define HAVE_ZOS_GET_EXECUTABLE_PATH if your platform
> +# supports calling __getprogramdir and getprogname to retrieve the path of the
> +# running executable.
> +#
>  # When using RUNTIME_PREFIX, define HAVE_WPGMPTR if your platform offers
>  # the global variable _wpgmptr containing the absolute path of the current
>  # executable (this is the case on Windows).

It is a bit puzzling why this new thing is not added after the last
existing one in the same family of "When using RUNTIME_PREFIX".  Our
usual convention to order things that have no inherent logical order
among them is either to add the new one at the end or order them
alphabetically.  This comment applies to the other additions to an
existing list (e.g. cascade of git_get_exec_$SYSTEM() calls in
git_get_exec_path() function).

In any case, we should reorganize this section a bit to make it more
obvious that the options from HAVE_BSD_KERN_PROC_SYSCTL to
HAVE_WPGMPTR are the ones that affect how RUNTIME_PREFIX finds the
program location, but that is outside the scope of this topic.

The remainder of the patch looked perfectly in line with the
existing practice (except for where the new thing is added, which I
already mentioned); I do not do zos so I'll have to take your word
for the implementation of git_get_exec_path_zos(), though ;-)

The following shows how I would fix what I found annoying while
studying the existing code to prepare this review.  None of it
should be part of this topic (even though it could become a
preliminary clean-up step if we wanted to), but since I wrote it
already, I'll record it here on the list as #leftoverbits.

Thanks.

 Makefile   | 26 ++++++++++++++------------
 exec-cmd.c | 20 +++++++++-----------
 2 files changed, 23 insertions(+), 23 deletions(-)

diff --git c/Makefile w/Makefile
index 41dfa0bad2..910aec0973 100644
--- c/Makefile
+++ w/Makefile
@@ -373,21 +373,23 @@ include shared.mak
 # Perl scripts to use a modified entry point header allowing them to resolve
 # support files at runtime.
 #
-# When using RUNTIME_PREFIX, define HAVE_BSD_KERN_PROC_SYSCTL if your platform
-# supports the KERN_PROC BSD sysctl function.
+# When using RUNTIME_PREFIX:
 #
-# When using RUNTIME_PREFIX, define PROCFS_EXECUTABLE_PATH if your platform
-# mounts a "procfs" filesystem capable of resolving the path of the current
-# executable. If defined, this must be the canonical path for the "procfs"
-# current executable path.
+# - define HAVE_BSD_KERN_PROC_SYSCTL if your platform supports the
+#   KERN_PROC BSD sysctl function.
 #
-# When using RUNTIME_PREFIX, define HAVE_NS_GET_EXECUTABLE_PATH if your platform
-# supports calling _NSGetExecutablePath to retrieve the path of the running
-# executable.
+# - define PROCFS_EXECUTABLE_PATH if your platform mounts a "procfs"
+#   filesystem capable of resolving the path of the current
+#   executable. If defined, this must be the canonical path for the
+#   "procfs" current executable path.
 #
-# When using RUNTIME_PREFIX, define HAVE_WPGMPTR if your platform offers
-# the global variable _wpgmptr containing the absolute path of the current
-# executable (this is the case on Windows).
+# - define HAVE_NS_GET_EXECUTABLE_PATH if your platform supports
+#   calling _NSGetExecutablePath to retrieve the path of the running
+#   executable.
+#
+# - define HAVE_WPGMPTR if your platform offers the global variable
+#   _wpgmptr containing the absolute path of the current executable
+#   (this is the case on Windows).
 #
 # INSTALL_STRIP can be set to "-s" to strip binaries during installation,
 # if your $(INSTALL) command supports the option.
diff --git c/exec-cmd.c w/exec-cmd.c
index 909777f61f..54bc7ed304 100644
--- c/exec-cmd.c
+++ w/exec-cmd.c
@@ -100,6 +100,8 @@ static int git_get_exec_path_procfs(struct strbuf *buf)
 	}
 	return -1;
 }
+#else
+# define git_get_exec_path_procfs(ignore) 1
 #endif /* PROCFS_EXECUTABLE_PATH */
 
 #ifdef HAVE_BSD_KERN_PROC_SYSCTL
@@ -127,6 +129,8 @@ static int git_get_exec_path_bsd_sysctl(struct strbuf *buf)
 	}
 	return -1;
 }
+#else
+# define git_get_exec_path_bsd_sysctl(ignore) 1
 #endif /* HAVE_BSD_KERN_PROC_SYSCTL */
 
 #ifdef HAVE_NS_GET_EXECUTABLE_PATH
@@ -148,6 +152,8 @@ static int git_get_exec_path_darwin(struct strbuf *buf)
 	}
 	return -1;
 }
+#else
+# define git_get_exec_path_darwin(ignore) 1
 #endif /* HAVE_NS_GET_EXECUTABLE_PATH */
 
 #ifdef HAVE_WPGMPTR
@@ -166,6 +172,8 @@ static int git_get_exec_path_wpgmptr(struct strbuf *buf)
 	buf->len += len;
 	return 0;
 }
+#else
+# define git_get_exec_path_wpgmptr(ignore) 1
 #endif /* HAVE_WPGMPTR */
 
 /*
@@ -190,22 +198,12 @@ static int git_get_exec_path(struct strbuf *buf, const char *argv0)
 	 * after the first successful method.
 	 */
 	if (
-#ifdef HAVE_BSD_KERN_PROC_SYSCTL
 		git_get_exec_path_bsd_sysctl(buf) &&
-#endif /* HAVE_BSD_KERN_PROC_SYSCTL */
-
-#ifdef HAVE_NS_GET_EXECUTABLE_PATH
 		git_get_exec_path_darwin(buf) &&
-#endif /* HAVE_NS_GET_EXECUTABLE_PATH */
-
-#ifdef PROCFS_EXECUTABLE_PATH
 		git_get_exec_path_procfs(buf) &&
-#endif /* PROCFS_EXECUTABLE_PATH */
-
-#ifdef HAVE_WPGMPTR
 		git_get_exec_path_wpgmptr(buf) &&
-#endif /* HAVE_WPGMPTR */
 
+		/* fallback -- must be at the end */
 		git_get_exec_path_from_argv0(buf, argv0)) {
 		return -1;
 	}

Copy link

This patch series was integrated into seen via 84aa78f.

Copy link

This branch is now known as dh/runtime-prefix-on-zos.

Copy link

This patch series was integrated into seen via 9839560.

Copy link

On the Git mailing list, Junio C Hamano wrote (reply to this):

Junio C Hamano <gitster@pobox.com> writes:

> The following shows how I would fix what I found annoying while
> studying the existing code to prepare this review.  None of it
> should be part of this topic (even though it could become a
> preliminary clean-up step if we wanted to), but since I wrote it
> already, I'll record it here on the list as #leftoverbits.
>
> Thanks.

I'll take your patch as-is and merge it down to 'next'.

Once the dust settles from this topic, I'll see if we want to do
further clean-ups (the "how-about" patch below, possibly also
reorder them alphabetically) so for now, I'd leave #leftoverbits
mark here.


>  Makefile   | 26 ++++++++++++++------------
>  exec-cmd.c | 20 +++++++++-----------
>  2 files changed, 23 insertions(+), 23 deletions(-)
>
> diff --git c/Makefile w/Makefile
> index 41dfa0bad2..910aec0973 100644
> --- c/Makefile
> +++ w/Makefile
> @@ -373,21 +373,23 @@ include shared.mak
>  # Perl scripts to use a modified entry point header allowing them to resolve
>  # support files at runtime.
>  #
> -# When using RUNTIME_PREFIX, define HAVE_BSD_KERN_PROC_SYSCTL if your platform
> -# supports the KERN_PROC BSD sysctl function.
> +# When using RUNTIME_PREFIX:
>  #
> -# When using RUNTIME_PREFIX, define PROCFS_EXECUTABLE_PATH if your platform
> -# mounts a "procfs" filesystem capable of resolving the path of the current
> -# executable. If defined, this must be the canonical path for the "procfs"
> -# current executable path.
> +# - define HAVE_BSD_KERN_PROC_SYSCTL if your platform supports the
> +#   KERN_PROC BSD sysctl function.
>  #
> -# When using RUNTIME_PREFIX, define HAVE_NS_GET_EXECUTABLE_PATH if your platform
> -# supports calling _NSGetExecutablePath to retrieve the path of the running
> -# executable.
> +# - define PROCFS_EXECUTABLE_PATH if your platform mounts a "procfs"
> +#   filesystem capable of resolving the path of the current
> +#   executable. If defined, this must be the canonical path for the
> +#   "procfs" current executable path.
>  #
> -# When using RUNTIME_PREFIX, define HAVE_WPGMPTR if your platform offers
> -# the global variable _wpgmptr containing the absolute path of the current
> -# executable (this is the case on Windows).
> +# - define HAVE_NS_GET_EXECUTABLE_PATH if your platform supports
> +#   calling _NSGetExecutablePath to retrieve the path of the running
> +#   executable.
> +#
> +# - define HAVE_WPGMPTR if your platform offers the global variable
> +#   _wpgmptr containing the absolute path of the current executable
> +#   (this is the case on Windows).
>  #
>  # INSTALL_STRIP can be set to "-s" to strip binaries during installation,
>  # if your $(INSTALL) command supports the option.
> diff --git c/exec-cmd.c w/exec-cmd.c
> index 909777f61f..54bc7ed304 100644
> --- c/exec-cmd.c
> +++ w/exec-cmd.c
> @@ -100,6 +100,8 @@ static int git_get_exec_path_procfs(struct strbuf *buf)
>  	}
>  	return -1;
>  }
> +#else
> +# define git_get_exec_path_procfs(ignore) 1
>  #endif /* PROCFS_EXECUTABLE_PATH */
>  
>  #ifdef HAVE_BSD_KERN_PROC_SYSCTL
> @@ -127,6 +129,8 @@ static int git_get_exec_path_bsd_sysctl(struct strbuf *buf)
>  	}
>  	return -1;
>  }
> +#else
> +# define git_get_exec_path_bsd_sysctl(ignore) 1
>  #endif /* HAVE_BSD_KERN_PROC_SYSCTL */
>  
>  #ifdef HAVE_NS_GET_EXECUTABLE_PATH
> @@ -148,6 +152,8 @@ static int git_get_exec_path_darwin(struct strbuf *buf)
>  	}
>  	return -1;
>  }
> +#else
> +# define git_get_exec_path_darwin(ignore) 1
>  #endif /* HAVE_NS_GET_EXECUTABLE_PATH */
>  
>  #ifdef HAVE_WPGMPTR
> @@ -166,6 +172,8 @@ static int git_get_exec_path_wpgmptr(struct strbuf *buf)
>  	buf->len += len;
>  	return 0;
>  }
> +#else
> +# define git_get_exec_path_wpgmptr(ignore) 1
>  #endif /* HAVE_WPGMPTR */
>  
>  /*
> @@ -190,22 +198,12 @@ static int git_get_exec_path(struct strbuf *buf, const char *argv0)
>  	 * after the first successful method.
>  	 */
>  	if (
> -#ifdef HAVE_BSD_KERN_PROC_SYSCTL
>  		git_get_exec_path_bsd_sysctl(buf) &&
> -#endif /* HAVE_BSD_KERN_PROC_SYSCTL */
> -
> -#ifdef HAVE_NS_GET_EXECUTABLE_PATH
>  		git_get_exec_path_darwin(buf) &&
> -#endif /* HAVE_NS_GET_EXECUTABLE_PATH */
> -
> -#ifdef PROCFS_EXECUTABLE_PATH
>  		git_get_exec_path_procfs(buf) &&
> -#endif /* PROCFS_EXECUTABLE_PATH */
> -
> -#ifdef HAVE_WPGMPTR
>  		git_get_exec_path_wpgmptr(buf) &&
> -#endif /* HAVE_WPGMPTR */
>  
> +		/* fallback -- must be at the end */
>  		git_get_exec_path_from_argv0(buf, argv0)) {
>  		return -1;
>  	}

Copy link

There was a status update in the "New Topics" section about the branch dh/runtime-prefix-on-zos on the Git mailing list:

Support for the RUNTIME_PREFIX feature has been added to z/OS port.

Will merge to 'next'.
source: <pull.1769.git.git.1724334732249.gitgitgadget@gmail.com>

Copy link

This patch series was integrated into seen via 62e7444.

Copy link

This patch series was integrated into next via 54a7e6c.

Copy link

This patch series was integrated into seen via 6221b7b.

Copy link

On the Git mailing list, Haritha D wrote (reply to this):

Hi Junio,

I was away for a few days and, therefore, couldn’t respond sooner. Thank you for reviewing and accepting the changes.

Best regards,
Haritha

On 23/08/24, 10:28 PM, "Junio C Hamano" <gitster@pobox.com <mailto:gitster@pobox.com>> wrote:


Junio C Hamano <gitster@pobox.com <mailto:gitster@pobox.com>> writes:


> The following shows how I would fix what I found annoying while
> studying the existing code to prepare this review. None of it
> should be part of this topic (even though it could become a
> preliminary clean-up step if we wanted to), but since I wrote it
> already, I'll record it here on the list as #leftoverbits.
>
> Thanks.


I'll take your patch as-is and merge it down to 'next'.


Once the dust settles from this topic, I'll see if we want to do
further clean-ups (the "how-about" patch below, possibly also
reorder them alphabetically) so for now, I'd leave #leftoverbits
mark here.




> Makefile | 26 ++++++++++++++------------
> exec-cmd.c | 20 +++++++++-----------
> 2 files changed, 23 insertions(+), 23 deletions(-)
>
> diff --git c/Makefile w/Makefile
> index 41dfa0bad2..910aec0973 100644
> --- c/Makefile
> +++ w/Makefile
> @@ -373,21 +373,23 @@ include shared.mak
> # Perl scripts to use a modified entry point header allowing them to resolve
> # support files at runtime.
> #
> -# When using RUNTIME_PREFIX, define HAVE_BSD_KERN_PROC_SYSCTL if your platform
> -# supports the KERN_PROC BSD sysctl function.
> +# When using RUNTIME_PREFIX:
> #
> -# When using RUNTIME_PREFIX, define PROCFS_EXECUTABLE_PATH if your platform
> -# mounts a "procfs" filesystem capable of resolving the path of the current
> -# executable. If defined, this must be the canonical path for the "procfs"
> -# current executable path.
> +# - define HAVE_BSD_KERN_PROC_SYSCTL if your platform supports the
> +# KERN_PROC BSD sysctl function.
> #
> -# When using RUNTIME_PREFIX, define HAVE_NS_GET_EXECUTABLE_PATH if your platform
> -# supports calling _NSGetExecutablePath to retrieve the path of the running
> -# executable.
> +# - define PROCFS_EXECUTABLE_PATH if your platform mounts a "procfs"
> +# filesystem capable of resolving the path of the current
> +# executable. If defined, this must be the canonical path for the
> +# "procfs" current executable path.
> #
> -# When using RUNTIME_PREFIX, define HAVE_WPGMPTR if your platform offers
> -# the global variable _wpgmptr containing the absolute path of the current
> -# executable (this is the case on Windows).
> +# - define HAVE_NS_GET_EXECUTABLE_PATH if your platform supports
> +# calling _NSGetExecutablePath to retrieve the path of the running
> +# executable.
> +#
> +# - define HAVE_WPGMPTR if your platform offers the global variable
> +# _wpgmptr containing the absolute path of the current executable
> +# (this is the case on Windows).
> #
> # INSTALL_STRIP can be set to "-s" to strip binaries during installation,
> # if your $(INSTALL) command supports the option.
> diff --git c/exec-cmd.c w/exec-cmd.c
> index 909777f61f..54bc7ed304 100644
> --- c/exec-cmd.c
> +++ w/exec-cmd.c
> @@ -100,6 +100,8 @@ static int git_get_exec_path_procfs(struct strbuf *buf)
> }
> return -1;
> }
> +#else
> +# define git_get_exec_path_procfs(ignore) 1
> #endif /* PROCFS_EXECUTABLE_PATH */
> 
> #ifdef HAVE_BSD_KERN_PROC_SYSCTL
> @@ -127,6 +129,8 @@ static int git_get_exec_path_bsd_sysctl(struct strbuf *buf)
> }
> return -1;
> }
> +#else
> +# define git_get_exec_path_bsd_sysctl(ignore) 1
> #endif /* HAVE_BSD_KERN_PROC_SYSCTL */
> 
> #ifdef HAVE_NS_GET_EXECUTABLE_PATH
> @@ -148,6 +152,8 @@ static int git_get_exec_path_darwin(struct strbuf *buf)
> }
> return -1;
> }
> +#else
> +# define git_get_exec_path_darwin(ignore) 1
> #endif /* HAVE_NS_GET_EXECUTABLE_PATH */
> 
> #ifdef HAVE_WPGMPTR
> @@ -166,6 +172,8 @@ static int git_get_exec_path_wpgmptr(struct strbuf *buf)
> buf->len += len;
> return 0;
> }
> +#else
> +# define git_get_exec_path_wpgmptr(ignore) 1
> #endif /* HAVE_WPGMPTR */
> 
> /*
> @@ -190,22 +198,12 @@ static int git_get_exec_path(struct strbuf *buf, const char *argv0)
> * after the first successful method.
> */
> if (
> -#ifdef HAVE_BSD_KERN_PROC_SYSCTL
> git_get_exec_path_bsd_sysctl(buf) &&
> -#endif /* HAVE_BSD_KERN_PROC_SYSCTL */
> -
> -#ifdef HAVE_NS_GET_EXECUTABLE_PATH
> git_get_exec_path_darwin(buf) &&
> -#endif /* HAVE_NS_GET_EXECUTABLE_PATH */
> -
> -#ifdef PROCFS_EXECUTABLE_PATH
> git_get_exec_path_procfs(buf) &&
> -#endif /* PROCFS_EXECUTABLE_PATH */
> -
> -#ifdef HAVE_WPGMPTR
> git_get_exec_path_wpgmptr(buf) &&
> -#endif /* HAVE_WPGMPTR */
> 
> + /* fallback -- must be at the end */
> git_get_exec_path_from_argv0(buf, argv0)) {
> return -1;
> }


Copy link

User Haritha D <Harithamma.D@ibm.com> has been added to the cc: list.

Copy link

This patch series was integrated into seen via 3fdc8cd.

Copy link

There was a status update in the "Cooking" section about the branch dh/runtime-prefix-on-zos on the Git mailing list:

Support for the RUNTIME_PREFIX feature has been added to z/OS port.

Will merge to 'master'.
source: <pull.1769.git.git.1724334732249.gitgitgadget@gmail.com>

Copy link

This patch series was integrated into seen via a16bf0c.

Copy link

This patch series was integrated into seen via 6895cdd.

Copy link

This patch series was integrated into seen via af3ad40.

Copy link

This patch series was integrated into seen via 15fb624.

Copy link

There was a status update in the "Cooking" section about the branch dh/runtime-prefix-on-zos on the Git mailing list:

Support for the RUNTIME_PREFIX feature has been added to z/OS port.

Will merge to 'master'.
source: <pull.1769.git.git.1724334732249.gitgitgadget@gmail.com>

Copy link

This patch series was integrated into seen via 739c509.

Copy link

This patch series was integrated into master via 739c509.

Copy link

This patch series was integrated into next via 739c509.

Copy link

Closed via 739c509.

@gitgitgadget-git gitgitgadget-git bot closed this Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant