Changeset 78048 in vbox for trunk/include/iprt

Timestamp:

Apr 9, 2019 1:21:09 AM (6 years ago)

Author:

vboxsync

Message:

IPRT: Working on new RTPathAbsEx implementation, temporarily called RTPathAbsExEx. This should fix most of the bugs in the current RTPathAbs/Ex code and do away with the fixed path buffer limitations. Also introduces a RTPATH_BIG_MAX, given that RTPATH_MAX is just a reasonable and not absolute MAX value. The new one is more or less absolute and must never be used for stack buffers. bugref:9172

Location:

trunk/include/iprt

Files:

• mangling.h (modified) (1 diff)
• path.h (modified) (6 diffs)

trunk/include/iprt/mangling.h

@@ -1597 +1597 @@
 # define RTPathAbsDup                                   RT_MANGLER(RTPathAbsDup)
 # define RTPathAbsEx                                    RT_MANGLER(RTPathAbsEx)
+# define RTPathAbsExEx                                  RT_MANGLER(RTPathAbsExEx)
 # define RTPathAbsExDup                                 RT_MANGLER(RTPathAbsExDup)
 # define RTPathAppDocs                                  RT_MANGLER(RTPathAppDocs)

trunk/include/iprt/path.h

@@ -50 +50 @@
  */
 #if !defined(IPRT_INCLUDED_param_h) || defined(DOXYGEN_RUNNING)
-# define RTPATH_MAX         (4096 + 4)    /* (PATH_MAX + 1) on linux w/ some alignment */
+# define RTPATH_MAX                 (4096 + 4)    /* (PATH_MAX + 1) on linux w/ some alignment */
 #endif
+
+/**
+ * The absolute max host path length we are willing to support.
+ * @note Not really suitable for stack buffers.
+ */
+#define RTPATH_BIG_MAX              (_64K)
 
 /** @def RTPATH_TAG
@@ -61 +67 @@
  */
 #ifndef RTPATH_TAG
-# define RTPATH_TAG     (__FILE__)
+# define RTPATH_TAG                 (__FILE__)
 #endif
 
@@ -305 +311 @@
  * @param   pszPath         The path to resolve.
  * @param   pszAbsPath      Where to store the absolute path.
- * @param   cchAbsPath      Size of the buffer.
+ * @param   cbAbsPath       Size of the buffer.
  *
  * @note    Current implementation is buggy and will remove trailing slashes
  *          that would normally specify a directory.  Don't depend on this.
  */
-RTDECL(int) RTPathAbs(const char *pszPath, char *pszAbsPath, size_t cchAbsPath);
+RTDECL(int) RTPathAbs(const char *pszPath, char *pszAbsPath, size_t cbAbsPath);
 
 /**
@@ -335 +341 @@
  * @param   pszPath         The path to resolve.
  * @param   pszAbsPath      Where to store the absolute path.
- * @param   cchAbsPath      Size of the buffer.
+ * @param   cbAbsPath       Size of the buffer.
  *
  * @note    Current implementation is buggy and will remove trailing slashes
  *          that would normally specify a directory.  Don't depend on this.
  */
-RTDECL(int) RTPathAbsEx(const char *pszBase, const char *pszPath, char *pszAbsPath, size_t cchAbsPath);
+RTDECL(int) RTPathAbsEx(const char *pszBase, const char *pszPath, char *pszAbsPath, size_t cbAbsPath);
+
+/**
+ * Get the absolute path (no symlinks, no . or .. components), assuming the
+ * given base path as the current directory.
+ *
+ * The resulting path doesn't have to exist.
+ *
+ * @returns iprt status code.
+ * @param   pszBase         The base path to act like a current directory.
+ *                          When NULL, the actual cwd is used (i.e. the call
+ *                          is equivalent to RTPathAbs(pszPath, ...).
+ * @param   pszPath         The path to resolve.
+ * @param   fFlags          One of the RTPATH_STR_F_STYLE_XXX flags combined
+ *                          with any of the RTPATHABS_F_XXX ones.  Most
+ *                          users will pass RTPATH_STR_F_STYLE_HOST (0).
+ * @param   pszAbsPath      Where to store the absolute path.
+ * @param   pcbAbsPath      Hold the size of the buffer when called.  The return
+ *                          value is the string length on success, and the
+ *                          required (or slightly more in some case) buffer
+ *                          size, including terminator, on VERR_BUFFER_OVERFLOW
+ *                          failures.
+ */
+RTDECL(int) RTPathAbsExEx(const char *pszBase, const char *pszPath, uint32_t fFlags, char *pszAbsPath, size_t *pcbAbsPath);
+
+/** @name RTPATHABS_F_XXX - Flags for RTPathAbsEx.
+ * @note The RTPATH_F_STR_XXX style flags also applies.
+ * @{ */
+/** Treat specified base directory as a root that cannot be ascended beyond.  */
+#define RTPATHABS_F_STOP_AT_BASE    RT_BIT_32(16)
+/** Treat CWD as a root that cannot be ascended beyond.  */
+#define RTPATHABS_F_STOP_AT_CWD     RT_BIT_32(17)
+/** @} */
 
 /**
@@ -619 +657 @@
  * RTPATH_PROP_RELATIVE will always be set together with this.  */
 #define RTPATH_PROP_DOTDOT_REFS     UINT16_C(0x1000)
+/** Special UNC root.
+ * The share name is not sacred when this is set. */
+#define RTPATH_PROP_SPECIAL_UNC     UINT16_C(0x2000)
 
 
@@ -714 +755 @@
  *
  * @returns IPRT status code.
- * @retval  VERR_BUFFER_OVERFLOW if @a cbDstPath is less than or equal to
- *          RTPATHPARSED::cchPath.
+ * @retval  VERR_BUFFER_OVERFLOW if the destination buffer is too small.
+ *          The necessary length is @a pParsed->cchPath + 1 (updated).
  *
  * @param   pszSrcPath          The source path.
- * @param   pParsed             The parser output for @a pszSrcPath.
+ * @param   pParsed             The parser output for @a pszSrcPath.  Caller may
+ *                              eliminate elements by setting their length to
+ *                              zero.  The cchPath member is updated.
  * @param   fFlags              Combination of RTPATH_STR_F_STYLE_XXX.
  *                              Most users will pass 0.