eal: support systemd service convention for runtime directory
RFC 1/1 eal: support systemd service convention for runtime directory
Systemd.exec supports configuring the runtime directory of a service via RuntimeDirectory=. This creates the directory with the necessary permissions which actual service may not have if running in container.
The change to DPDK is to look for the environment RUNTIME_DIRECTORY first and use that in preference to the fallback alternatives.
--- lib/eal/linux/eal.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)
lib/eal/linux/eal.c +12 -11
@@ -86,25 +86,26 @@ struct lcore_config lcore_config[RTE_MAX_LCORE];/* used by rte_rdtsc() */ int rte_cycles_vmware_tsc_map; -static const char *default_runtime_dir ="/var/run" ; -int eal_create_runtime_dir (void ) { -const char *directory = default_runtime_dir; -const char *xdg_runtime_dir =getenv ("XDG_RUNTIME_DIR" ); -const char *fallback ="/tmp" ; +const char *directory;char run_dir[PATH_MAX ];char tmp[PATH_MAX ];int ret; -if (getuid () !=0 ) { -/* try XDG path first, fall back to /tmp */ -if (xdg_runtime_dir !=NULL ) - directory = xdg_runtime_dir; -else - directory = fallback; +/* from RuntimeDirectory= see systemd.exec */ + directory =getenv ("RUNTIME_DIRECTORY" ); +if (directory ==NULL ) { +if (getuid () ==0 ) + directory ="/var/run" ; +else { + directory =getenv ("XDG_RUNTIME_DIR" ); +if (directory ==NULL ) + directory ="/tmp" ; + } } +/* create DPDK subdirectory under runtime dir */ ret =snprintf (tmp,sizeof (tmp),"%s/dpdk" , directory);if (ret <0 || ret ==sizeof (tmp)) {
Signature · 1 line
2.30.2
Quoted 58 lines
From: Stephen Hemminger [mailto:[email protected]]
Sent: Friday, 24 December 2021 00.39Systemd.exec supports configuring the runtime directory of a service via RuntimeDirectory=. This creates the directory with the necessary permissions which actual service may not have if running in container.
The change to DPDK is to look for the environment
RUNTIME_DIRECTORYfirst and use that in preference to the fallback alternatives.Signed-off-by Stephen Hemminger <[email protected]>--- lib/eal/linux/eal.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)lib/eal/linux/eal.c +12
-12@@ -86,25 +86,26 @@ struct lcore_config lcore_config[RTE_MAX_LCORE];/* used by rte_rdtsc() */ int rte_cycles_vmware_tsc_map; -static const char *default_runtime_dir ="/var/run" ; -int eal_create_runtime_dir (void ) { -const char *directory = default_runtime_dir; -const char *xdg_runtime_dir =getenv ("XDG_RUNTIME_DIR" ); -const char *fallback ="/tmp" ; +const char *directory;char run_dir[PATH_MAX ];char tmp[PATH_MAX ];int ret; -if (getuid () !=0 ) { -/* try XDG path first, fall back to /tmp */ -if (xdg_runtime_dir !=NULL ) - directory = xdg_runtime_dir; -else - directory = fallback; +/* from RuntimeDirectory= see systemd.exec */ + directory =getenv ("RUNTIME_DIRECTORY" ); +if (directory ==NULL ) { +if (getuid () ==0 ) + directory ="/var/run" ; +else { + directory =getenv ("XDG_RUNTIME_DIR" ); +if (directory ==NULL ) + directory ="/tmp" ; + } } +/* create DPDK subdirectory under runtime dir */ ret =snprintf (tmp,sizeof (tmp),"%s/dpdk" , directory);if (ret <0 || ret ==sizeof (tmp)) { --
Quoted 2 lines
2.30.2
Also, while reviewing this, I stumbled across eal_set_runtime_dir() in eal_common_config.c, which I think should be fixed:
inteal_set_runtime_dir(char *run_dir, size_t size)
{
size_t str_size;- str_size = strlcpy(runtime_dir, run_dir, size);
- if (str_size >= size) {
+ str_size = strlcpy(runtime_dir, run_dir, sizeof(runtime_dir));
+ if (str_size >= sizeof(runtime_dir)) {
RTE_LOG(ERR, EAL, "Runtime directory string too long\n");
return -1;
}
return 0;
}And I don't understand why size is passed as a parameter to eal_set_runtime_dir().
RFC 1/1 eal: remove size for eal_set_runtime_dir
The size argument to eal_set_runtime_dir is useless and was being used incorrectly in strlcpy. It worked only because all callers passed PATH_MAX which is same as sizeof the destination runtime_dir.
--- lib/eal/common/eal_common_config.c | 7 ++----- lib/eal/common/eal_private.h | 4 +--- lib/eal/freebsd/eal.c | 2 +- lib/eal/linux/eal.c | 2 +- 4 files changed, 5 insertions(+), 10 deletions(-)
lib/eal/common/eal_common_config.c +2 -5
@@ -29,12 +29,9 @@ rte_eal_get_runtime_dir(void) }int -eal_set_runtime_dir (char *run_dir,size_t size) +eal_set_runtime_dir (const char *run_dir) { -size_t str_size; - - str_size =strlcpy (runtime_dir, run_dir, size); -if (str_size >= size) { +if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) {RTE_LOG (ERR ,EAL ,"Runtime directory string too long\n" );return -1 ; }
lib/eal/common/eal_private.h +1 -3
@@ -681,13 +681,11 @@ eal_mem_set_dump(void *virt, size_t size, bool dump);* * @param run_dir * The new runtime directory path of DPDK -* @param size -* The size of the new runtime directory path in bytes. * @return * 0 on success, (-1) on failure. */ int -eal_set_runtime_dir (char *run_dir,size_t size); +eal_set_runtime_dir (const char *run_dir);/** * Get the internal configuration structure.
lib/eal/freebsd/eal.c +1 -1
@@ -123,7 +123,7 @@ eal_create_runtime_dir(void)return -1 ; } -if (eal_set_runtime_dir (run_dir,sizeof (run_dir))) +if (eal_set_runtime_dir (run_dir))return -1 ;return 0 ;
lib/eal/linux/eal.c +1 -1
@@ -135,7 +135,7 @@ eal_create_runtime_dir(void)return -1 ; } -if (eal_set_runtime_dir (run_dir,sizeof (run_dir))) +if (eal_set_runtime_dir (run_dir))return -1 ;return 0 ;
Signature · 1 line
2.30.2
RE: [RFC] eal: remove size for eal_set_runtime_dir
Quoted 85 lines
From: Stephen Hemminger [mailto:[email protected]]
Sent: Wednesday, 5 January 2022 19.02The size argument to
eal_set_runtime_diris useless and was being used incorrectly in strlcpy. It worked only because all callers passedPATH_MAXwhich is same as sizeof the destinationruntime_dir.Signed-off-by Stephen Hemminger <[email protected]>Suggested-by Morten Brørup <[email protected]>--- lib/eal/common/eal_common_config.c | 7 ++----- lib/eal/common/eal_private.h | 4 +--- lib/eal/freebsd/eal.c | 2 +- lib/eal/linux/eal.c | 2 +- 4 files changed, 5 insertions(+), 10 deletions(-)lib/eal/common/eal_common_config.c +2
-5@@ -29,12 +29,9 @@ rte_eal_get_runtime_dir(void) }int -eal_set_runtime_dir (char *run_dir,size_t size) +eal_set_runtime_dir (const char *run_dir) { -size_t str_size; - - str_size =strlcpy (runtime_dir, run_dir, size); -if (str_size >= size) { +if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) {RTE_LOG (ERR ,EAL ,"Runtime directory string too long\n" );return -1 ; }lib/eal/common/eal_private.h +1
-3@@ -681,13 +681,11 @@ eal_mem_set_dump(void *virt, size_t size, booldump); * * @param run_dir * The new runtime directory path of DPDK -* @param size -* The size of the new runtime directory path in bytes. * @return * 0 on success, (-1) on failure. */ int -eal_set_runtime_dir (char *run_dir,size_t size); +eal_set_runtime_dir (const char *run_dir);/** * Get the internal configuration structure.
lib/eal/freebsd/eal.c +1
-1@@ -123,7 +123,7 @@ eal_create_runtime_dir(void)return -1 ; } -if (eal_set_runtime_dir (run_dir,sizeof (run_dir))) +if (eal_set_runtime_dir (run_dir))return -1 ;return 0 ;lib/eal/linux/eal.c +1
-2@@ -135,7 +135,7 @@ eal_create_runtime_dir(void)return -1 ; } -if (eal_set_runtime_dir (run_dir,sizeof (run_dir))) +if (eal_set_runtime_dir (run_dir))return -1 ;return 0 ; --
Quoted 2 lines
2.30.2
Quoted 4 lines · Stephen Hemminger
Systemd.exec supports configuring the runtime directory of a service via RuntimeDirectory=. This creates the directory with the necessary permissions which actual service may not have if running in container.
Quoted 8 lines
The change to DPDK is to look for the environment
RUNTIME_DIRECTORYfirst and use that in preference to the fallback alternatives.Signed-off-by Stephen Hemminger <[email protected]>--- lib/eal/linux/eal.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)
Seems reasonable. The path lookup for telemetry in the dpdk-telemetry.py script will need updating to match this.
Otherwise:
07/01/2022 13:07, Bruce Richardson:
Quoted 8 lines · Stephen Hemminger
Quoted 7 lines
Systemd.exec supports configuring the runtime directory of a service via RuntimeDirectory=. This creates the directory with the necessary permissions which actual service may not have if running in container.
The change to DPDK is to look for the environment
RUNTIME_DIRECTORYfirst and use that in preference to the fallback alternatives.
Quoted 7 lines
Quoted 5 lines
Signed-off-by Stephen Hemminger <[email protected]>--- lib/eal/linux/eal.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)Seems reasonable. The path lookup for telemetry in the
dpdk-telemetry.pyscript will need updating to match this.
Any followup?
Do you plan a v2 to address comments from Morten and Bruce?
Quoted 14 lines · On Wed, 02 Feb 2022 22:03:44 +0100 Thomas Monjalon <[email protected]> wrote:
07/01/2022 13:07, Bruce Richardson:
Quoted 13 lines · Stephen Hemminger
Quoted 12 lines
Systemd.exec supports configuring the runtime directory of a service via RuntimeDirectory=. This creates the directory with the necessary permissions which actual service may not have if running in container.
The change to DPDK is to look for the environment
RUNTIME_DIRECTORYfirst and use that in preference to the fallback alternatives.Signed-off-by Stephen Hemminger <[email protected]>--- lib/eal/linux/eal.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)
Quoted 5 lines
Quoted 2 lines
Seems reasonable. The path lookup for telemetry in the
dpdk-telemetry.pyscript will need updating to match this.Any followup?
Do you plan a v2 to address comments from Morten and Bruce?
Was waiting for any more responses, not urgent
cover better support of configuring runtime directory
In reply to Stephen HemmingerFound this while exploring running a DPDK service with systemd container environment. It helps if the place DPDK puts its runtime directory is configurable.
This version supersedes earlier RFC and includes the feedback.
Stephen Hemminger (2):
eal: remove size for eal_set_runtime_dir
eal: support systemd service convention for runtime directory
lib/eal/common/eal_common_config.c | 7 ++----- lib/eal/common/eal_private.h | 4 +--- lib/eal/freebsd/eal.c | 2 +- lib/eal/linux/eal.c | 25 ++++++++++++++----------- usertools/dpdk-telemetry.py | 9 +++++++-- 5 files changed, 25 insertions(+), 22 deletions(-)
Signature · 1 line
2.34.1
PATCH 1/2 eal: remove size for eal_set_runtime_dir
The size argument to eal_set_runtime_dir is useless and was being used incorrectly in strlcpy. It worked only because all callers passed PATH_MAX which is same as sizeof the destination runtime_dir.
Note: this is an internal API so no user exposed change.
--- lib/eal/common/eal_common_config.c | 7 ++----- lib/eal/common/eal_private.h | 4 +--- lib/eal/freebsd/eal.c | 2 +- lib/eal/linux/eal.c | 2 +- 4 files changed, 5 insertions(+), 10 deletions(-)
lib/eal/common/eal_common_config.c +2 -5
@@ -29,12 +29,9 @@ rte_eal_get_runtime_dir(void) }int -eal_set_runtime_dir (char *run_dir,size_t size) +eal_set_runtime_dir (const char *run_dir) { -size_t str_size; - - str_size =strlcpy (runtime_dir, run_dir, size); -if (str_size >= size) { +if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) {RTE_LOG (ERR ,EAL ,"Runtime directory string too long\n" );return -1 ; }
lib/eal/common/eal_private.h +1 -3
@@ -681,13 +681,11 @@ eal_mem_set_dump(void *virt, size_t size, bool dump);* * @param run_dir * The new runtime directory path of DPDK -* @param size -* The size of the new runtime directory path in bytes. * @return * 0 on success, (-1) on failure. */ int -eal_set_runtime_dir (char *run_dir,size_t size); +eal_set_runtime_dir (const char *run_dir);/** * Get the internal configuration structure.
lib/eal/freebsd/eal.c +1 -1
@@ -123,7 +123,7 @@ eal_create_runtime_dir(void)return -1 ; } -if (eal_set_runtime_dir (run_dir,sizeof (run_dir))) +if (eal_set_runtime_dir (run_dir))return -1 ;return 0 ;
lib/eal/linux/eal.c +1 -1
@@ -137,7 +137,7 @@ eal_create_runtime_dir(void)return -1 ; } -if (eal_set_runtime_dir (run_dir,sizeof (run_dir))) +if (eal_set_runtime_dir (run_dir))return -1 ;return 0 ;
Signature · 1 line
2.34.1
PATCH 2/2 eal: support systemd service convention for runtime directory
In reply to Stephen HemmingerSystemd.exec supports configuring the runtime directory of a service via RuntimeDirectory=. This creates the directory with the necessary permissions which actual service may not have if running in container.
The change to DPDK is to look for the environment RUNTIME_DIRECTORY first and use that in preference to the fallback alternatives.
--- lib/eal/linux/eal.c | 23 +++++++++++++---------- usertools/dpdk-telemetry.py | 9 +++++++-- 2 files changed, 20 insertions(+), 12 deletions(-)
lib/eal/linux/eal.c +13 -10
@@ -86,25 +86,28 @@ struct lcore_config lcore_config[RTE_MAX_LCORE];/* used by rte_rdtsc() */ int rte_cycles_vmware_tsc_map; -static const char *default_runtime_dir ="/var/run" ; -int eal_create_runtime_dir (void ) { -const char *directory = default_runtime_dir; -const char *xdg_runtime_dir =getenv ("XDG_RUNTIME_DIR" ); -const char *fallback ="/tmp" ; +const char *directory;char run_dir[PATH_MAX ];char tmp[PATH_MAX ];int ret; -if (getuid () !=0 ) { -/* try XDG path first, fall back to /tmp */ -if (xdg_runtime_dir !=NULL ) - directory = xdg_runtime_dir; +/* from RuntimeDirectory= see systemd.exec */ + directory =getenv ("RUNTIME_DIRECTORY" ); +if (directory ==NULL ) { +/* +* Used standard convention defined in +* XDG Base Directory Specification and +* Filesystem Hierachy Standard. +*/ +if (getuid () ==0 ) + directory ="/var/run" ;else - directory = fallback; + directory =getenv ("XDG_RUNTIME_DIR" ) ? :"/tmp" ; } +/* create DPDK subdirectory under runtime dir */ ret =snprintf (tmp,sizeof (tmp),"%s/dpdk" , directory);if (ret <0 || ret ==sizeof (tmp)) {
usertools/dpdk-telemetry.py +7 -2
@@ -75,9 +75,14 @@ def print_socket_options(prefix, paths): def get_dpdk_runtime_dir(fp): """ Using the same logic as in DPDK's EAL, get the DPDK runtime directory based on the file-prefix and user """ + run_dir = os.environ.get('RUNTIME_DIRECTORY') + if run_dir: + return run_dir if (os.getuid() == 0): - return os.path.join('/var/run/dpdk', fp) - return os.path.join(os.environ.get('XDG_RUNTIME_DIR', '/tmp'), 'dpdk', fp) + run_dir = '/var/run' + else: + run_dir = os.environ.get('XDG_RUNTIME_DIR', '/tmp')) + return os.path.join(run_dir, 'dpdk', fp) def list_fp():
Signature · 1 line
2.34.1
Quoted 63 lines · Stephen Hemminger
Systemd.exec supports configuring the runtime directory of a service via RuntimeDirectory=. This creates the directory with the necessary permissions which actual service may not have if running in container.
The change to DPDK is to look for the environment
RUNTIME_DIRECTORYfirst and use that in preference to the fallback alternatives.Signed-off-by Stephen Hemminger <[email protected]>Acked-by Bruce Richardson <[email protected]>Reviewed-by Morten Brørup <[email protected]>--- lib/eal/linux/eal.c | 23 +++++++++++++---------- usertools/dpdk-telemetry.py | 9 +++++++-- 2 files changed, 20 insertions(+), 12 deletions(-)lib/eal/linux/eal.c +13
-10@@ -86,25 +86,28 @@ struct lcore_config lcore_config[RTE_MAX_LCORE];/* used by rte_rdtsc() */ int rte_cycles_vmware_tsc_map; -static const char *default_runtime_dir ="/var/run" ; -int eal_create_runtime_dir (void ) { -const char *directory = default_runtime_dir; -const char *xdg_runtime_dir =getenv ("XDG_RUNTIME_DIR" ); -const char *fallback ="/tmp" ; +const char *directory;char run_dir[PATH_MAX ];char tmp[PATH_MAX ];int ret; -if (getuid () !=0 ) { -/* try XDG path first, fall back to /tmp */ -if (xdg_runtime_dir !=NULL ) - directory = xdg_runtime_dir; +/* from RuntimeDirectory= see systemd.exec */ + directory =getenv ("RUNTIME_DIRECTORY" ); +if (directory ==NULL ) { +/* +* Used standard convention defined in +* XDG Base Directory Specification and +* Filesystem Hierachy Standard. +*/ +if (getuid () ==0 ) + directory ="/var/run" ;else - directory = fallback; + directory =getenv ("XDG_RUNTIME_DIR" ) ? :"/tmp" ; } +/* create DPDK subdirectory under runtime dir */ ret =snprintf (tmp,sizeof (tmp),"%s/dpdk" , directory);if (ret <0 || ret ==sizeof (tmp)) {usertools/dpdk-telemetry.py +0
-0
usertools/dpdk-telemetry.py def print_socket_options(prefix, paths): · line 80
Quoted 6 lines
usertools/dpdk-telemetry.py +3
-0@@ -75,9 +75,14 @@ def print_socket_options(prefix, paths): def get_dpdk_runtime_dir(fp): """ Using the same logic as in DPDK's EAL, get the DPDK runtime directory based on the file-prefix and user """ + run_dir = os.environ.get('RUNTIME_DIRECTORY') + if run_dir: + return run_dir
This bit doesn't seem to match the EAL changes above, since in the EAL code you are still appending the "dpdk" suffixes to the value returned from RUNTIME_DIRECTORY.
Quoted 13 lines
usertools/dpdk-telemetry.py +4
-2if (os.getuid() == 0): - return os.path.join('/var/run/dpdk', fp) - return os.path.join(os.environ.get('XDG_RUNTIME_DIR', '/tmp'), 'dpdk', fp) + run_dir = '/var/run' + else: + run_dir = os.environ.get('XDG_RUNTIME_DIR', '/tmp')) + return os.path.join(run_dir, 'dpdk', fp) def list_fp():Signature · 1 line
2.34.1
v2 cover eal: support configuring runtime directory
In reply to Stephen HemmingerFound this while exploring running a DPDK service with systemd container environment. It helps if the place DPDK puts its runtime directory is configurable.
v2 - fix dpdk_telemetry.py to use append dpdk
Stephen Hemminger (2):
eal: remove size for eal_set_runtime_dir
eal: support systemd service convention for runtime directory
lib/eal/common/eal_common_config.c | 7 ++----- lib/eal/common/eal_private.h | 4 +--- lib/eal/freebsd/eal.c | 2 +- lib/eal/linux/eal.c | 25 ++++++++++++++----------- usertools/dpdk-telemetry.py | 10 +++++++--- 5 files changed, 25 insertions(+), 23 deletions(-)
Signature · 1 line
2.34.1
PATCH v2 1/2 eal: remove size for eal_set_runtime_dir
The size argument to eal_set_runtime_dir is useless and was being used incorrectly in strlcpy. It worked only because all callers passed PATH_MAX which is same as sizeof the destination runtime_dir.
Note: this is an internal API so no user exposed change.
--- lib/eal/common/eal_common_config.c | 7 ++----- lib/eal/common/eal_private.h | 4 +--- lib/eal/freebsd/eal.c | 2 +- lib/eal/linux/eal.c | 2 +- 4 files changed, 5 insertions(+), 10 deletions(-)
lib/eal/common/eal_common_config.c +2 -5
@@ -29,12 +29,9 @@ rte_eal_get_runtime_dir(void) }int -eal_set_runtime_dir (char *run_dir,size_t size) +eal_set_runtime_dir (const char *run_dir) { -size_t str_size; - - str_size =strlcpy (runtime_dir, run_dir, size); -if (str_size >= size) { +if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) {RTE_LOG (ERR ,EAL ,"Runtime directory string too long\n" );return -1 ; }
lib/eal/common/eal_private.h +1 -3
@@ -681,13 +681,11 @@ eal_mem_set_dump(void *virt, size_t size, bool dump);* * @param run_dir * The new runtime directory path of DPDK -* @param size -* The size of the new runtime directory path in bytes. * @return * 0 on success, (-1) on failure. */ int -eal_set_runtime_dir (char *run_dir,size_t size); +eal_set_runtime_dir (const char *run_dir);/** * Get the internal configuration structure.
lib/eal/freebsd/eal.c +1 -1
@@ -123,7 +123,7 @@ eal_create_runtime_dir(void)return -1 ; } -if (eal_set_runtime_dir (run_dir,sizeof (run_dir))) +if (eal_set_runtime_dir (run_dir))return -1 ;return 0 ;
lib/eal/linux/eal.c +1 -1
@@ -137,7 +137,7 @@ eal_create_runtime_dir(void)return -1 ; } -if (eal_set_runtime_dir (run_dir,sizeof (run_dir))) +if (eal_set_runtime_dir (run_dir))return -1 ;return 0 ;
Signature · 1 line
2.34.1
PATCH v2 2/2 eal: support systemd service convention for runtime directory
In reply to Stephen HemmingerSystemd.exec supports configuring the runtime directory of a service via RuntimeDirectory=. This creates the directory with the necessary permissions which actual service may not have if running in container.
The change to DPDK is to look for the environment RUNTIME_DIRECTORY first and use that in preference to the fallback alternatives.
--- lib/eal/linux/eal.c | 23 +++++++++++++---------- usertools/dpdk-telemetry.py | 10 +++++++--- 2 files changed, 20 insertions(+), 13 deletions(-)
lib/eal/linux/eal.c +13 -10
@@ -86,25 +86,28 @@ struct lcore_config lcore_config[RTE_MAX_LCORE];/* used by rte_rdtsc() */ int rte_cycles_vmware_tsc_map; -static const char *default_runtime_dir ="/var/run" ; -int eal_create_runtime_dir (void ) { -const char *directory = default_runtime_dir; -const char *xdg_runtime_dir =getenv ("XDG_RUNTIME_DIR" ); -const char *fallback ="/tmp" ; +const char *directory;char run_dir[PATH_MAX ];char tmp[PATH_MAX ];int ret; -if (getuid () !=0 ) { -/* try XDG path first, fall back to /tmp */ -if (xdg_runtime_dir !=NULL ) - directory = xdg_runtime_dir; +/* from RuntimeDirectory= see systemd.exec */ + directory =getenv ("RUNTIME_DIRECTORY" ); +if (directory ==NULL ) { +/* +* Used standard convention defined in +* XDG Base Directory Specification and +* Filesystem Hierachy Standard. +*/ +if (getuid () ==0 ) + directory ="/var/run" ;else - directory = fallback; + directory =getenv ("XDG_RUNTIME_DIR" ) ? :"/tmp" ; } +/* create DPDK subdirectory under runtime dir */ ret =snprintf (tmp,sizeof (tmp),"%s/dpdk" , directory);if (ret <0 || ret ==sizeof (tmp)) {
usertools/dpdk-telemetry.py +7 -3
@@ -75,9 +75,13 @@ def print_socket_options(prefix, paths): def get_dpdk_runtime_dir(fp): """ Using the same logic as in DPDK's EAL, get the DPDK runtime directory based on the file-prefix and user """ - if (os.getuid() == 0): - return os.path.join('/var/run/dpdk', fp) - return os.path.join(os.environ.get('XDG_RUNTIME_DIR', '/tmp'), 'dpdk', fp) + run_dir = os.environ.get('RUNTIME_DIRECTORY') + if not run_dir: + if (os.getuid() == 0): + run_dir = '/var/run' + else: + run_dir = os.environ.get('XDG_RUNTIME_DIR', '/tmp') + return os.path.join(run_dir, 'dpdk', fp) def list_fp():
Signature · 1 line
2.34.1
Re: [PATCH v2 0/2] eal: support configuring runtime directory
In reply to Stephen HemmingerQuoted 10 lines · On Sat, 5 Feb 2022 09:10:59 -0800 Stephen Hemminger…
Found this while exploring running a DPDK service with systemd container environment. It helps if the place DPDK puts its runtime directory is configurable.
v2 - fix
dpdk_telemetry.pyto use append dpdkStephen Hemminger (2):
eal: remove size foreal_set_runtime_dir
eal: support systemd service convention for runtime directory
Quoted 7 lines
lib/eal/common/eal_common_config.c | 7 ++----- lib/eal/common/eal_private.h | 4 +--- lib/eal/freebsd/eal.c | 2 +- lib/eal/linux/eal.c | 25 ++++++++++++++----------- usertools/dpdk-telemetry.py | 10 +++++++--- 5 files changed, 25 insertions(+), 23 deletions(-)
Bruce is it worth moving this (and the sysfs logic) from Linux only into unix/ directory and have common code with FreeBSD?
Re: [PATCH v2 0/2] eal: support configuring runtime directory
Quoted 21 lines · Stephen Hemminger
Quoted 10 lines · On Sat, 5 Feb 2022 09:10:59 -0800 Stephen Hemminger…
Found this while exploring running a DPDK service with systemd container environment. It helps if the place DPDK puts its runtime directory is configurable.
v2 - fix
dpdk_telemetry.pyto use append dpdkStephen Hemminger (2):
eal: remove size foreal_set_runtime_dir
eal: support systemd service convention for runtime directoryQuoted 7 lines
lib/eal/common/eal_common_config.c | 7 ++----- lib/eal/common/eal_private.h | 4 +--- lib/eal/freebsd/eal.c | 2 +- lib/eal/linux/eal.c | 25 ++++++++++++++----------- usertools/dpdk-telemetry.py | 10 +++++++--- 5 files changed, 25 insertions(+), 23 deletions(-)
Quoted 3 lines
Bruce is it worth moving this (and the sysfs logic) from Linux only into unix/ directory and have common code with FreeBSD?
The "create_runtime_dir()" function is indeed a copy-paste between the two OS's so looks like it should be moved into a common unix implementation.
v3 cover eal: support configuring runtime directory
In reply to Stephen HemmingerSystemd defines a standard way for setting the runtime directory for services by setting RUNTIME_DIRECTORY in the environment, and this is a useful way to interact with DPDK internals. DPDK was already following the relevant standards
but there can be time when running as a non-root user that the defaults don't work well.
v3 - move to common code between Linux and FreeBSD
there is lots more code that could be combined here in future.
v2 - fix dpdk_telemetry.py to use append dpdk
Stephen Hemminger (3):
eal: remove size for eal_set_runtime_dir
eal: support systemd service convention for runtime directory
eal: move common filesystem setup code into one file
lib/eal/common/eal_common_config.c | 7 +- lib/eal/common/eal_private.h | 4 +- lib/eal/freebsd/eal.c | 88 ----------------------- lib/eal/linux/eal.c | 87 ----------------------- lib/eal/unix/eal_filesystem.c | 110 +++++++++++++++++++++++++++++ lib/eal/unix/meson.build | 1 + usertools/dpdk-telemetry.py | 10 ++- 7 files changed, 121 insertions(+), 186 deletions(-) create mode 100644 lib/eal/unix/eal_filesystem.c
Signature · 1 line
2.34.1
PATCH v3 1/3 eal: remove size for eal_set_runtime_dir
The size argument to eal_set_runtime_dir is useless and was being used incorrectly in strlcpy. It worked only because all callers passed PATH_MAX which is same as sizeof the destination runtime_dir.
Note: this is an internal API so no user exposed change.
--- lib/eal/common/eal_common_config.c | 7 ++----- lib/eal/common/eal_private.h | 4 +--- lib/eal/freebsd/eal.c | 2 +- lib/eal/linux/eal.c | 2 +- 4 files changed, 5 insertions(+), 10 deletions(-)
lib/eal/common/eal_common_config.c +2 -5
@@ -29,12 +29,9 @@ rte_eal_get_runtime_dir(void) }int -eal_set_runtime_dir (char *run_dir,size_t size) +eal_set_runtime_dir (const char *run_dir) { -size_t str_size; - - str_size =strlcpy (runtime_dir, run_dir, size); -if (str_size >= size) { +if (strlcpy (runtime_dir, run_dir,PATH_MAX ) >=PATH_MAX ) {RTE_LOG (ERR ,EAL ,"Runtime directory string too long\n" );return -1 ; }
lib/eal/common/eal_private.h +1 -3
@@ -681,13 +681,11 @@ eal_mem_set_dump(void *virt, size_t size, bool dump);* * @param run_dir * The new runtime directory path of DPDK -* @param size -* The size of the new runtime directory path in bytes. * @return * 0 on success, (-1) on failure. */ int -eal_set_runtime_dir (char *run_dir,size_t size); +eal_set_runtime_dir (const char *run_dir);/** * Get the internal configuration structure.
lib/eal/freebsd/eal.c +1 -1
@@ -123,7 +123,7 @@ eal_create_runtime_dir(void)return -1 ; } -if (eal_set_runtime_dir (run_dir,sizeof (run_dir))) +if (eal_set_runtime_dir (run_dir))return -1 ;return 0 ;
lib/eal/linux/eal.c +1 -1
@@ -137,7 +137,7 @@ eal_create_runtime_dir(void)return -1 ; } -if (eal_set_runtime_dir (run_dir,sizeof (run_dir))) +if (eal_set_runtime_dir (run_dir))return -1 ;return 0 ;
Signature · 1 line
2.34.1
PATCH v3 2/3 eal: support systemd service convention for runtime directory
In reply to Stephen HemmingerSystemd.exec supports configuring the runtime directory of a service via RuntimeDirectory=. This creates the directory with the necessary permissions which actual service may not have if running in container.
The change to DPDK is to look for the environment RUNTIME_DIRECTORY first and use that in preference to the fallback alternatives.
--- lib/eal/linux/eal.c | 23 +++++++++++++---------- usertools/dpdk-telemetry.py | 10 +++++++--- 2 files changed, 20 insertions(+), 13 deletions(-)
lib/eal/linux/eal.c +13 -10
@@ -86,25 +86,28 @@ struct lcore_config lcore_config[RTE_MAX_LCORE];/* used by rte_rdtsc() */ int rte_cycles_vmware_tsc_map; -static const char *default_runtime_dir ="/var/run" ; -int eal_create_runtime_dir (void ) { -const char *directory = default_runtime_dir; -const char *xdg_runtime_dir =getenv ("XDG_RUNTIME_DIR" ); -const char *fallback ="/tmp" ; +const char *directory;char run_dir[PATH_MAX ];char tmp[PATH_MAX ];int ret; -if (getuid () !=0 ) { -/* try XDG path first, fall back to /tmp */ -if (xdg_runtime_dir !=NULL ) - directory = xdg_runtime_dir; +/* from RuntimeDirectory= see systemd.exec */ + directory =getenv ("RUNTIME_DIRECTORY" ); +if (directory ==NULL ) { +/* +* Used standard convention defined in +* XDG Base Directory Specification and +* Filesystem Hierarchy Standard. +*/ +if (getuid () ==0 ) + directory ="/var/run" ;else - directory = fallback; + directory =getenv ("XDG_RUNTIME_DIR" ) ? :"/tmp" ; } +/* create DPDK subdirectory under runtime dir */ ret =snprintf (tmp,sizeof (tmp),"%s/dpdk" , directory);if (ret <0 || ret ==sizeof (tmp)) {
usertools/dpdk-telemetry.py +7 -3
@@ -75,9 +75,13 @@ def print_socket_options(prefix, paths): def get_dpdk_runtime_dir(fp): """ Using the same logic as in DPDK's EAL, get the DPDK runtime directory based on the file-prefix and user """ - if (os.getuid() == 0): - return os.path.join('/var/run/dpdk', fp) - return os.path.join(os.environ.get('XDG_RUNTIME_DIR', '/tmp'), 'dpdk', fp) + run_dir = os.environ.get('RUNTIME_DIRECTORY') + if not run_dir: + if (os.getuid() == 0): + run_dir = '/var/run' + else: + run_dir = os.environ.get('XDG_RUNTIME_DIR', '/tmp') + return os.path.join(run_dir, 'dpdk', fp) def list_fp():
Signature · 1 line
2.34.1
PATCH v3 3/3 eal: move common filesystem setup code into one file
In reply to Stephen HemmingerBoth Linux and FreeBSD have same code for creating runtime directory and reading sysfs files. Put them in the new lib/eal/unix subdirectory.
--- lib/eal/freebsd/eal.c | 88 --------------------------- lib/eal/linux/eal.c | 90 ---------------------------- lib/eal/unix/eal_filesystem.c | 110 ++++++++++++++++++++++++++++++++++ lib/eal/unix/meson.build | 1 + 4 files changed, 111 insertions(+), 178 deletions(-) create mode 100644 lib/eal/unix/eal_filesystem.c
lib/eal/freebsd/eal.c +0 -88
@@ -72,62 +72,6 @@ struct lcore_config lcore_config[RTE_MAX_LCORE];/* used by rte_rdtsc() */ int rte_cycles_vmware_tsc_map; -static const char *default_runtime_dir ="/var/run" ; - -int -eal_create_runtime_dir (void ) -{ -const char *directory = default_runtime_dir; -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 ) { -/* 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)) { -RTE_LOG (ERR ,EAL ,"Error creating DPDK runtime path name\n" ); -return -1 ; - } - -/* create prefix-specific subdirectory under DPDK runtime dir */ - ret =snprintf (run_dir,sizeof (run_dir),"%s/%s" , - tmp,eal_get_hugefile_prefix ()); -if (ret <0 || ret ==sizeof (run_dir)) { -RTE_LOG (ERR ,EAL ,"Error creating prefix-specific runtime path name\n" ); -return -1 ; - } - -/* create the path if it doesn't exist. no "mkdir -p" here, so do it -* step by step. -*/ - ret =mkdir (tmp,0700 ); -if (ret <0 && errno !=EEXIST ) { -RTE_LOG (ERR ,EAL ,"Error creating '%s': %s\n" , - tmp,strerror (errno)); -return -1 ; - } - - ret =mkdir (run_dir,0700 ); -if (ret <0 && errno !=EEXIST ) { -RTE_LOG (ERR ,EAL ,"Error creating '%s': %s\n" , - run_dir,strerror (errno)); -return -1 ; - } - -if (eal_set_runtime_dir (run_dir)) -return -1 ; - -return 0 ; -}int eal_clean_runtime_dir (void )
@@ -138,38 +82,6 @@ eal_clean_runtime_dir(void)return 0 ; } -/* parse a sysfs (or other) file containing one integer value */ -int -eal_parse_sysfs_value (const char *filename,unsigned long *val) -{ -FILE *f; -char buf[BUFSIZ ]; -char *end =NULL ; - -if ((f =fopen (filename,"r" )) ==NULL ) { -RTE_LOG (ERR ,EAL ,"%s(): cannot open sysfs value %s\n" , - __func__, filename); -return -1 ; - } - -if (fgets (buf,sizeof (buf), f) ==NULL ) { -RTE_LOG (ERR ,EAL ,"%s(): cannot read sysfs value %s\n" , - __func__, filename); -fclose (f); -return -1 ; - } - *val =strtoul (buf, &end,0 ); -if ((buf[0 ] =='\0' ) || (end ==NULL ) || (*end !='\n' )) { -RTE_LOG (ERR ,EAL ,"%s(): cannot parse sysfs value %s\n" , - __func__, filename); -fclose (f); -return -1 ; - } -fclose (f); -return 0 ; -} - -/* create memory configuration in shared/mmap memory. Take out * a write lock on the memsegs, so we can auto-detect primary/secondary. * This means we never close the file while running (auto-close on exit).
lib/eal/linux/eal.c +0 -90
102 lines not on this page · raw message
lib/eal/unix/eal_filesystem.c new file +110 -0
110 lines not on this page · raw message
lib/eal/unix/meson.build +1 -0
@@ -6,5 +6,6 @@ sources += files( 'eal_unix_memory.c', 'eal_unix_timer.c', 'eal_firmware.c', + 'eal_filesystem.c', 'rte_thread.c', )
Signature · 1 line
2.34.1
Re: [PATCH v3 3/3] eal: move common filesystem setup code into one file
Quoted 5 lines · Stephen Hemminger
Both Linux and FreeBSD have same code for creating runtime directory and reading sysfs files. Put them in the new
lib/eal/unixsubdirectory.Signed-off-by Stephen Hemminger <[email protected]>
LGTM, apart from one minor nit inline below.
Quoted 8 lines
--- lib/eal/freebsd/eal.c | 88 --------------------------- lib/eal/linux/eal.c | 90 ---------------------------- lib/eal/unix/eal_filesystem.c | 110 ++++++++++++++++++++++++++++++++++ lib/eal/unix/meson.build | 1 + 4 files changed, 111 insertions(+), 178 deletions(-) create mode 100644 lib/eal/unix/eal_filesystem.c
<snip>
Quoted 13 lines
lib/eal/unix/eal_filesystem.c new file +13
-0+ +/* create the path if it doesn't exist. no "mkdir -p" here, so do it +* step by step. +*/ + ret =mkdir (tmp,0700 ); +if (ret <0 && errno !=EEXIST ) { +RTE_LOG (ERR ,EAL ,"Error creating '%s': %s\n" , + tmp,strerror (errno)); +return -1 ; + } + + ret =mkdir (run_dir,0700 ); +if (ret <0 && errno !=EEXIST ) {
lib/eal/unix/eal_filesystem.c line 80
Quoted 10 lines
lib/eal/unix/eal_filesystem.c new file +10
-0+RTE_LOG (ERR ,EAL ,"Error creating '%s': %s\n" , + run_dir,strerror (errno)); +return -1 ; + } + +if (eal_set_runtime_dir (run_dir)) +return -1 ; + +return 0 ; +}
Missing a blank line here between the two functions.
Quoted 44 lines
lib/eal/unix/eal_filesystem.c new file +30
-0+/* parse a sysfs (or other) file containing one integer value */ +int +eal_parse_sysfs_value (const char *filename,unsigned long *val) +{ +FILE *f; +char buf[BUFSIZ ]; +char *end =NULL ; + +if ((f =fopen (filename,"r" )) ==NULL ) { +RTE_LOG (ERR ,EAL ,"%s(): cannot open sysfs value %s\n" , + __func__, filename); +return -1 ; + } + +if (fgets (buf,sizeof (buf), f) ==NULL ) { +RTE_LOG (ERR ,EAL ,"%s(): cannot read sysfs value %s\n" , + __func__, filename); +fclose (f); +return -1 ; + } + *val =strtoul (buf, &end,0 ); +if ((buf[0 ] =='\0' ) || (end ==NULL ) || (*end !='\n' )) { +RTE_LOG (ERR ,EAL ,"%s(): cannot parse sysfs value %s\n" , + __func__, filename); +fclose (f); +return -1 ; + } +fclose (f); +return 0 ; +}lib/eal/unix/meson.build +1
-0@@ -6,5 +6,6 @@ sources += files( 'eal_unix_memory.c', 'eal_unix_timer.c', 'eal_firmware.c', + 'eal_filesystem.c', 'rte_thread.c', )Signature · 1 line
2.34.1
Re: [PATCH v3 0/3] eal: support configuring runtime directory
In reply to Stephen Hemminger09/02/2022 07:54, Stephen Hemminger:
Quoted 6 lines
Systemd defines a standard way for setting the runtime directory for services by setting
RUNTIME_DIRECTORYin the environment, and this is a useful way to interact with DPDK internals. DPDK was already following the relevant standards
but there can be time when running as a non-root user that the defaults don't work well.
Applied with suggested minor fix, thanks.