eal: allow user to override DPDK runtime path

Message ID 20210310172137.59938-1-sthemmin@microsoft.com (mailing list archive)
State Rejected, archived
Delegated to: Thomas Monjalon
Headers
Series eal: allow user to override DPDK runtime path |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success travis build: passed
ci/github-robot success github build: passed
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-mellanox-Functional success Functional Testing PASS
ci/iol-testing success Testing PASS
ci/intel-Testing success Testing PASS

Commit Message

Stephen Hemminger March 10, 2021, 5:21 p.m. UTC
  There can be cases such as containers or other runtime environments
where DPDK may not be able to access the default runtime path.
This patch introduces DPDK_RUNTIME_DIR as an environment variable
to allow controlling and overriding the path.

The example we have is DPDK application running in an untrusted
systemd container. In this case, it is not root, and XDG_RUNTIME_DIR
is not set (since it is not a user application), and /tmp is
blocked. The correct place for this application is to use /run.

In any case, hard coded path assumptions are a problem.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 lib/librte_eal/linux/eal.c | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
  

Comments

Bruce Richardson March 10, 2021, 5:27 p.m. UTC | #1
On Wed, Mar 10, 2021 at 09:21:37AM -0800, Stephen Hemminger wrote:
> There can be cases such as containers or other runtime environments
> where DPDK may not be able to access the default runtime path.
> This patch introduces DPDK_RUNTIME_DIR as an environment variable
> to allow controlling and overriding the path.
> 
> The example we have is DPDK application running in an untrusted
> systemd container. In this case, it is not root, and XDG_RUNTIME_DIR
> is not set (since it is not a user application), and /tmp is
> blocked. The correct place for this application is to use /run.
> 
> In any case, hard coded path assumptions are a problem.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---

Basic question, if the user/operator can set DPDK_RUNTIME_DIR in the
container, can they not also set XDG_RUNTIME_DIR?
  
Stephen Hemminger March 10, 2021, 6:33 p.m. UTC | #2
On Wed, 10 Mar 2021 17:27:17 +0000
Bruce Richardson <bruce.richardson@intel.com> wrote:

> On Wed, Mar 10, 2021 at 09:21:37AM -0800, Stephen Hemminger wrote:
> > There can be cases such as containers or other runtime environments
> > where DPDK may not be able to access the default runtime path.
> > This patch introduces DPDK_RUNTIME_DIR as an environment variable
> > to allow controlling and overriding the path.
> > 
> > The example we have is DPDK application running in an untrusted
> > systemd container. In this case, it is not root, and XDG_RUNTIME_DIR
> > is not set (since it is not a user application), and /tmp is
> > blocked. The correct place for this application is to use /run.
> > 
> > In any case, hard coded path assumptions are a problem.
> > 
> > Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> > ---  
> 
> Basic question, if the user/operator can set DPDK_RUNTIME_DIR in the
> container, can they not also set XDG_RUNTIME_DIR?

Yes they could, but more about not having hard coded paths.
  
Bruce Richardson March 11, 2021, 12:13 p.m. UTC | #3
On Wed, Mar 10, 2021 at 10:33:50AM -0800, Stephen Hemminger wrote:
> On Wed, 10 Mar 2021 17:27:17 +0000
> Bruce Richardson <bruce.richardson@intel.com> wrote:
> 
> > On Wed, Mar 10, 2021 at 09:21:37AM -0800, Stephen Hemminger wrote:
> > > There can be cases such as containers or other runtime environments
> > > where DPDK may not be able to access the default runtime path.
> > > This patch introduces DPDK_RUNTIME_DIR as an environment variable
> > > to allow controlling and overriding the path.
> > > 
> > > The example we have is DPDK application running in an untrusted
> > > systemd container. In this case, it is not root, and XDG_RUNTIME_DIR
> > > is not set (since it is not a user application), and /tmp is
> > > blocked. The correct place for this application is to use /run.
> > > 
> > > In any case, hard coded path assumptions are a problem.
> > > 
> > > Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> > > ---  
> > 
> > Basic question, if the user/operator can set DPDK_RUNTIME_DIR in the
> > container, can they not also set XDG_RUNTIME_DIR?
> 
> Yes they could, but more about not having hard coded paths.

As far as I can see, you aren't removing the hard-coded path to "/tmp" in
your patch, so unless I'm missing something I'm not seeing the significance
of the change here? It largely just seems to be adding a new environment
variable on top of the existing one, while changing nothing if neither is
set.

/Bruce
  
Burakov, Anatoly March 12, 2021, 10:56 a.m. UTC | #4
On 11-Mar-21 12:13 PM, Bruce Richardson wrote:
> On Wed, Mar 10, 2021 at 10:33:50AM -0800, Stephen Hemminger wrote:
>> On Wed, 10 Mar 2021 17:27:17 +0000
>> Bruce Richardson <bruce.richardson@intel.com> wrote:
>>
>>> On Wed, Mar 10, 2021 at 09:21:37AM -0800, Stephen Hemminger wrote:
>>>> There can be cases such as containers or other runtime environments
>>>> where DPDK may not be able to access the default runtime path.
>>>> This patch introduces DPDK_RUNTIME_DIR as an environment variable
>>>> to allow controlling and overriding the path.
>>>>
>>>> The example we have is DPDK application running in an untrusted
>>>> systemd container. In this case, it is not root, and XDG_RUNTIME_DIR
>>>> is not set (since it is not a user application), and /tmp is
>>>> blocked. The correct place for this application is to use /run.
>>>>
>>>> In any case, hard coded path assumptions are a problem.
>>>>
>>>> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
>>>> ---
>>>
>>> Basic question, if the user/operator can set DPDK_RUNTIME_DIR in the
>>> container, can they not also set XDG_RUNTIME_DIR?
>>
>> Yes they could, but more about not having hard coded paths.
> 
> As far as I can see, you aren't removing the hard-coded path to "/tmp" in
> your patch, so unless I'm missing something I'm not seeing the significance
> of the change here? It largely just seems to be adding a new environment
> variable on top of the existing one, while changing nothing if neither is
> set.
> 
> /Bruce
> 

An argument could be made that DPDK_RUNTIME_DIR is DPDK-specific while 
XDG_RUNTIME_DIR is system-wide, so setting up an environment like that 
is more "correct". However, since you can set environment variables per 
executable without affecting the rest of the system, i'm not sure it's 
worth the hassle of adding another variable.
  
Bruce Richardson March 12, 2021, 12:05 p.m. UTC | #5
On Fri, Mar 12, 2021 at 10:56:20AM +0000, Burakov, Anatoly wrote:
> On 11-Mar-21 12:13 PM, Bruce Richardson wrote:
> > On Wed, Mar 10, 2021 at 10:33:50AM -0800, Stephen Hemminger wrote:
> > > On Wed, 10 Mar 2021 17:27:17 +0000
> > > Bruce Richardson <bruce.richardson@intel.com> wrote:
> > > 
> > > > On Wed, Mar 10, 2021 at 09:21:37AM -0800, Stephen Hemminger wrote:
> > > > > There can be cases such as containers or other runtime environments
> > > > > where DPDK may not be able to access the default runtime path.
> > > > > This patch introduces DPDK_RUNTIME_DIR as an environment variable
> > > > > to allow controlling and overriding the path.
> > > > > 
> > > > > The example we have is DPDK application running in an untrusted
> > > > > systemd container. In this case, it is not root, and XDG_RUNTIME_DIR
> > > > > is not set (since it is not a user application), and /tmp is
> > > > > blocked. The correct place for this application is to use /run.
> > > > > 
> > > > > In any case, hard coded path assumptions are a problem.
> > > > > 
> > > > > Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> > > > > ---
> > > > 
> > > > Basic question, if the user/operator can set DPDK_RUNTIME_DIR in the
> > > > container, can they not also set XDG_RUNTIME_DIR?
> > > 
> > > Yes they could, but more about not having hard coded paths.
> > 
> > As far as I can see, you aren't removing the hard-coded path to "/tmp" in
> > your patch, so unless I'm missing something I'm not seeing the significance
> > of the change here? It largely just seems to be adding a new environment
> > variable on top of the existing one, while changing nothing if neither is
> > set.
> > 
> > /Bruce
> > 
> 
> An argument could be made that DPDK_RUNTIME_DIR is DPDK-specific while
> XDG_RUNTIME_DIR is system-wide, so setting up an environment like that is
> more "correct". However, since you can set environment variables per
> executable without affecting the rest of the system, i'm not sure it's worth
> the hassle of adding another variable.
> 

Since some of the concern seems to be around the use of "/tmp" as a
hardcoded path, I would actually suggest that instead of an extra
environment variable we add an EAL flag for the runtime dir. Then we can
fail eal init if XDG_RUNTIME_DIR is not set and if no runtime dir is
specified on cmdline. That would remove any hard-coded paths and gives two
separate ways to set runtime dir, rather than having two options using the
same method.

One final note that whatever the behaviour of EAL is changed to, some
scripts which mimic that behaviour e.g. to find sockets, will also need
updating. "dpdk-telemetry.py" is one that I am aware of anyway.

/Bruce
  
Burakov, Anatoly March 12, 2021, 12:49 p.m. UTC | #6
On 12-Mar-21 12:05 PM, Bruce Richardson wrote:
> On Fri, Mar 12, 2021 at 10:56:20AM +0000, Burakov, Anatoly wrote:
>> On 11-Mar-21 12:13 PM, Bruce Richardson wrote:
>>> On Wed, Mar 10, 2021 at 10:33:50AM -0800, Stephen Hemminger wrote:
>>>> On Wed, 10 Mar 2021 17:27:17 +0000
>>>> Bruce Richardson <bruce.richardson@intel.com> wrote:
>>>>
>>>>> On Wed, Mar 10, 2021 at 09:21:37AM -0800, Stephen Hemminger wrote:
>>>>>> There can be cases such as containers or other runtime environments
>>>>>> where DPDK may not be able to access the default runtime path.
>>>>>> This patch introduces DPDK_RUNTIME_DIR as an environment variable
>>>>>> to allow controlling and overriding the path.
>>>>>>
>>>>>> The example we have is DPDK application running in an untrusted
>>>>>> systemd container. In this case, it is not root, and XDG_RUNTIME_DIR
>>>>>> is not set (since it is not a user application), and /tmp is
>>>>>> blocked. The correct place for this application is to use /run.
>>>>>>
>>>>>> In any case, hard coded path assumptions are a problem.
>>>>>>
>>>>>> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
>>>>>> ---
>>>>>
>>>>> Basic question, if the user/operator can set DPDK_RUNTIME_DIR in the
>>>>> container, can they not also set XDG_RUNTIME_DIR?
>>>>
>>>> Yes they could, but more about not having hard coded paths.
>>>
>>> As far as I can see, you aren't removing the hard-coded path to "/tmp" in
>>> your patch, so unless I'm missing something I'm not seeing the significance
>>> of the change here? It largely just seems to be adding a new environment
>>> variable on top of the existing one, while changing nothing if neither is
>>> set.
>>>
>>> /Bruce
>>>
>>
>> An argument could be made that DPDK_RUNTIME_DIR is DPDK-specific while
>> XDG_RUNTIME_DIR is system-wide, so setting up an environment like that is
>> more "correct". However, since you can set environment variables per
>> executable without affecting the rest of the system, i'm not sure it's worth
>> the hassle of adding another variable.
>>
> 
> Since some of the concern seems to be around the use of "/tmp" as a
> hardcoded path, I would actually suggest that instead of an extra
> environment variable we add an EAL flag for the runtime dir. Then we can
> fail eal init if XDG_RUNTIME_DIR is not set and if no runtime dir is
> specified on cmdline. That would remove any hard-coded paths and gives two
> separate ways to set runtime dir, rather than having two options using the
> same method.

Yep, i don't think there are any distributions that don't set this path 
any more. And if they don't, well, they should :D

> 
> One final note that whatever the behaviour of EAL is changed to, some
> scripts which mimic that behaviour e.g. to find sockets, will also need
> updating. "dpdk-telemetry.py" is one that I am aware of anyway.
> 
> /Bruce
>
  

Patch

diff --git a/lib/librte_eal/linux/eal.c b/lib/librte_eal/linux/eal.c
index 6c34ac890386..f2a5e73817d6 100644
--- a/lib/librte_eal/linux/eal.c
+++ b/lib/librte_eal/linux/eal.c
@@ -90,20 +90,26 @@  static const char *default_runtime_dir = "/var/run";
 int
 eal_create_runtime_dir(void)
 {
-	const char *directory = default_runtime_dir;
+	const char *directory;
 	const char *xdg_runtime_dir = getenv("XDG_RUNTIME_DIR");
 	const char *fallback = "/tmp";
 	char run_dir[PATH_MAX];
 	char tmp[PATH_MAX];
 	int ret;
 
-	if (getuid() != 0) {
+	directory = getenv("DPDK_RUNTIME_DIR");
+	if (directory != NULL) {
+		RTE_LOG(DEBUG, EAL, "Using DPDK runtime directory: %s\n", directory);
+	} else if (getuid() == 0) {
+		directory = default_runtime_dir;
+	} else {
 		/* try XDG path first, fall back to /tmp */
 		if (xdg_runtime_dir != NULL)
 			directory = xdg_runtime_dir;
 		else
 			directory = fallback;
 	}
+
 	/* create DPDK subdirectory under runtime dir */
 	ret = snprintf(tmp, sizeof(tmp), "%s/dpdk", directory);
 	if (ret < 0 || ret == sizeof(tmp)) {