From 58b575485c446f9d76ee00f67516ed42cf017769 Mon Sep 17 00:00:00 2001 From: Elliott Hughes Date: Mon, 29 Oct 2012 14:27:10 -0700 Subject: [PATCH] Clean up the implementation a little, bring in tests. Most of these tests were in system/extras, but I've added more to cover other cases explicitly mentioned by POSIX. Change-Id: I5e8d77e4179028d77306935cceadbb505515dcde --- libc/Android.mk | 5 +- libc/bionic/basename.c | 49 ------------ libc/bionic/basename_r.c | 82 -------------------- libc/bionic/dirname.c | 50 ------------ libc/bionic/dirname_r.c | 88 --------------------- libc/bionic/libgen.cpp | 163 +++++++++++++++++++++++++++++++++++++++ tests/Android.mk | 1 + tests/libgen_test.cpp | 117 ++++++++++++++++++++++++++++ 8 files changed, 282 insertions(+), 273 deletions(-) delete mode 100644 libc/bionic/basename.c delete mode 100644 libc/bionic/basename_r.c delete mode 100644 libc/bionic/dirname.c delete mode 100644 libc/bionic/dirname_r.c create mode 100644 libc/bionic/libgen.cpp create mode 100644 tests/libgen_test.cpp diff --git a/libc/Android.mk b/libc/Android.mk index bb3fd00f3..a64287a48 100644 --- a/libc/Android.mk +++ b/libc/Android.mk @@ -149,16 +149,12 @@ libc_common_src_files := \ bionic/atoi.c \ bionic/atol.c \ bionic/atoll.c \ - bionic/basename.c \ - bionic/basename_r.c \ bionic/bindresvport.c \ bionic/bionic_clone.c \ bionic/brk.c \ bionic/clearenv.c \ bionic/cpuacct.c \ bionic/daemon.c \ - bionic/dirname.c \ - bionic/dirname_r.c \ bionic/err.c \ bionic/ether_aton.c \ bionic/ether_ntoa.c \ @@ -283,6 +279,7 @@ libc_bionic_src_files := \ bionic/eventfd.cpp \ bionic/__fgets_chk.cpp \ bionic/getcwd.cpp \ + bionic/libgen.cpp \ bionic/__memcpy_chk.cpp \ bionic/__memmove_chk.cpp \ bionic/__memset_chk.cpp \ diff --git a/libc/bionic/basename.c b/libc/bionic/basename.c deleted file mode 100644 index 8aaae538d..000000000 --- a/libc/bionic/basename.c +++ /dev/null @@ -1,49 +0,0 @@ -/* - * Copyright (C) 2008 The Android Open Source Project - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the - * distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE - * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, - * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS - * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED - * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT - * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - */ -#include - -#include -#include -#include -#include -#include - -char* -basename(const char* path) -{ - static char* bname = NULL; - int ret; - - if (bname == NULL) { - bname = (char *)malloc(MAXPATHLEN); - if (bname == NULL) - return(NULL); - } - ret = basename_r(path, bname, MAXPATHLEN); - return (ret < 0) ? NULL : bname; -} diff --git a/libc/bionic/basename_r.c b/libc/bionic/basename_r.c deleted file mode 100644 index e9080f058..000000000 --- a/libc/bionic/basename_r.c +++ /dev/null @@ -1,82 +0,0 @@ -/* - * Copyright (C) 2008 The Android Open Source Project - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the - * distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE - * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, - * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS - * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED - * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT - * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - */ -#include -#include -#include -#include - -int -basename_r(const char* path, char* buffer, size_t bufflen) -{ - const char *endp, *startp; - int len, result; - char temp[2]; - - /* Empty or NULL string gets treated as "." */ - if (path == NULL || *path == '\0') { - startp = "."; - len = 1; - goto Exit; - } - - /* Strip trailing slashes */ - endp = path + strlen(path) - 1; - while (endp > path && *endp == '/') - endp--; - - /* All slashes becomes "/" */ - if (endp == path && *endp == '/') { - startp = "/"; - len = 1; - goto Exit; - } - - /* Find the start of the base */ - startp = endp; - while (startp > path && *(startp - 1) != '/') - startp--; - - len = endp - startp +1; - -Exit: - result = len; - if (buffer == NULL) { - return result; - } - if (len > (int)bufflen-1) { - len = (int)bufflen-1; - result = -1; - errno = ERANGE; - } - - if (len >= 0) { - memcpy( buffer, startp, len ); - buffer[len] = 0; - } - return result; -} diff --git a/libc/bionic/dirname.c b/libc/bionic/dirname.c deleted file mode 100644 index 8a1db9054..000000000 --- a/libc/bionic/dirname.c +++ /dev/null @@ -1,50 +0,0 @@ -/* - * Copyright (C) 2008 The Android Open Source Project - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the - * distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE - * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, - * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS - * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED - * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT - * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - */ -#include - -#include -#include -#include -#include -#include - -char* -dirname(const char* path) -{ - static char* bname = NULL; - int ret; - - if (bname == NULL) { - bname = (char *)malloc(MAXPATHLEN); - if (bname == NULL) - return(NULL); - } - - ret = dirname_r(path, bname, MAXPATHLEN); - return (ret < 0) ? NULL : bname; -} diff --git a/libc/bionic/dirname_r.c b/libc/bionic/dirname_r.c deleted file mode 100644 index df2e9bf7b..000000000 --- a/libc/bionic/dirname_r.c +++ /dev/null @@ -1,88 +0,0 @@ -/* - * Copyright (C) 2008 The Android Open Source Project - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the - * distribution. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE - * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, - * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS - * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED - * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT - * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - */ -#include -#include -#include -#include - -int -dirname_r(const char* path, char* buffer, size_t bufflen) -{ - const char *endp; - int result, len; - - /* Empty or NULL string gets treated as "." */ - if (path == NULL || *path == '\0') { - path = "."; - len = 1; - goto Exit; - } - - /* Strip trailing slashes */ - endp = path + strlen(path) - 1; - while (endp > path && *endp == '/') - endp--; - - /* Find the start of the dir */ - while (endp > path && *endp != '/') - endp--; - - /* Either the dir is "/" or there are no slashes */ - if (endp == path) { - path = (*endp == '/') ? "/" : "."; - len = 1; - goto Exit; - } - - do { - endp--; - } while (endp > path && *endp == '/'); - - len = endp - path +1; - -Exit: - result = len; - if (len+1 > MAXPATHLEN) { - errno = ENAMETOOLONG; - return -1; - } - if (buffer == NULL) - return result; - - if (len > (int)bufflen-1) { - len = (int)bufflen-1; - result = -1; - errno = ERANGE; - } - - if (len >= 0) { - memcpy( buffer, path, len ); - buffer[len] = 0; - } - return result; -} diff --git a/libc/bionic/libgen.cpp b/libc/bionic/libgen.cpp new file mode 100644 index 000000000..f7181e7e1 --- /dev/null +++ b/libc/bionic/libgen.cpp @@ -0,0 +1,163 @@ +/* + * Copyright (C) 2008 The Android Open Source Project + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +#include + +#include +#include +#include +#include +#include + +#include "ThreadLocalBuffer.h" + +GLOBAL_INIT_THREAD_LOCAL_BUFFER(basename); +GLOBAL_INIT_THREAD_LOCAL_BUFFER(dirname); + +char* basename(const char* path) { + LOCAL_INIT_THREAD_LOCAL_BUFFER(char*, basename, MAXPATHLEN); + int rc = basename_r(path, basename_tls_buffer, basename_tls_buffer_size); + return (rc < 0) ? NULL : basename_tls_buffer; +} + +char* dirname(const char* path) { + LOCAL_INIT_THREAD_LOCAL_BUFFER(char*, dirname, MAXPATHLEN); + int rc = dirname_r(path, dirname_tls_buffer, dirname_tls_buffer_size); + return (rc < 0) ? NULL : dirname_tls_buffer; +} + +int basename_r(const char* path, char* buffer, size_t buffer_size) { + const char* startp = NULL; + const char* endp = NULL; + int len; + int result; + + // Empty or NULL string gets treated as ".". + if (path == NULL || *path == '\0') { + startp = "."; + len = 1; + goto Exit; + } + + // Strip trailing slashes. + endp = path + strlen(path) - 1; + while (endp > path && *endp == '/') { + endp--; + } + + // All slashes becomes "/". + if (endp == path && *endp == '/') { + startp = "/"; + len = 1; + goto Exit; + } + + // Find the start of the base. + startp = endp; + while (startp > path && *(startp - 1) != '/') { + startp--; + } + + len = endp - startp +1; + + Exit: + result = len; + if (buffer == NULL) { + return result; + } + if (len > static_cast(buffer_size) - 1) { + len = buffer_size - 1; + result = -1; + errno = ERANGE; + } + + if (len >= 0) { + memcpy(buffer, startp, len); + buffer[len] = 0; + } + return result; +} + +int dirname_r(const char* path, char* buffer, size_t buffer_size) { + const char* endp = NULL; + int len; + int result; + + // Empty or NULL string gets treated as ".". + if (path == NULL || *path == '\0') { + path = "."; + len = 1; + goto Exit; + } + + // Strip trailing slashes. + endp = path + strlen(path) - 1; + while (endp > path && *endp == '/') { + endp--; + } + + // Find the start of the dir. + while (endp > path && *endp != '/') { + endp--; + } + + // Either the dir is "/" or there are no slashes. + if (endp == path) { + path = (*endp == '/') ? "/" : "."; + len = 1; + goto Exit; + } + + do { + endp--; + } while (endp > path && *endp == '/'); + + len = endp - path + 1; + + Exit: + result = len; + if (len + 1 > MAXPATHLEN) { + errno = ENAMETOOLONG; + return -1; + } + if (buffer == NULL) { + return result; + } + + if (len > static_cast(buffer_size) - 1) { + len = buffer_size - 1; + result = -1; + errno = ERANGE; + } + + if (len >= 0) { + memcpy(buffer, path, len); + buffer[len] = 0; + } + return result; +} diff --git a/tests/Android.mk b/tests/Android.mk index f948fea74..68dee102e 100644 --- a/tests/Android.mk +++ b/tests/Android.mk @@ -27,6 +27,7 @@ test_c_flags = \ test_src_files = \ dirent_test.cpp \ getcwd_test.cpp \ + libgen_test.cpp \ pthread_test.cpp \ regex_test.cpp \ stack_protector_test.cpp \ diff --git a/tests/libgen_test.cpp b/tests/libgen_test.cpp new file mode 100644 index 000000000..c2c01f6b8 --- /dev/null +++ b/tests/libgen_test.cpp @@ -0,0 +1,117 @@ +/* + * Copyright (C) 2012 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include + +#include + +#include + +static void TestBasename(const char* in, const char* expected_out) { + char* writable_in = (in != NULL) ? strdup(in) : NULL; + errno = 0; + const char* out = basename(&writable_in[0]); + ASSERT_STREQ(expected_out, out) << in; + ASSERT_EQ(0, errno) << in; + free(writable_in); +} + +static void TestDirname(const char* in, const char* expected_out) { + char* writable_in = (in != NULL) ? strdup(in) : NULL; + errno = 0; + const char* out = dirname(&writable_in[0]); + ASSERT_STREQ(expected_out, out) << in; + ASSERT_EQ(0, errno) << in; + free(writable_in); +} + +TEST(libgen, basename) { + TestBasename(NULL, "."); + TestBasename("", "."); + TestBasename("/usr/lib", "lib"); + TestBasename("/usr/", "usr"); + TestBasename("usr", "usr"); + TestBasename("/", "/"); + TestBasename(".", "."); + TestBasename("..", ".."); + TestBasename("///", "/"); + TestBasename("//usr//lib//", "lib"); +} + +TEST(libgen, dirname) { + TestDirname(NULL, "."); + TestDirname("", "."); + TestDirname("/usr/lib", "/usr"); + TestDirname("/usr/", "/"); + TestDirname("usr", "."); + TestDirname(".", "."); + TestDirname("..", "."); + TestDirname("/", "/"); +} + +#if __BIONIC__ + +static void TestBasename(const char* in, const char* expected_out, int expected_rc, + char* buf, size_t buf_size, int expected_errno) { + errno = 0; + int rc = basename_r(in, buf, buf_size); + ASSERT_EQ(expected_rc, rc) << in; + if (rc != -1 && buf != NULL) { + ASSERT_STREQ(expected_out, buf) << in; + } + ASSERT_EQ(expected_errno, errno) << in; +} + +static void TestDirname(const char* in, const char* expected_out, int expected_rc, + char* buf, size_t buf_size, int expected_errno) { + errno = 0; + int rc = dirname_r(in, buf, buf_size); + ASSERT_EQ(expected_rc, rc) << in; + if (rc != -1 && buf != NULL) { + ASSERT_STREQ(expected_out, buf) << in; + } + ASSERT_EQ(expected_errno, errno) << in; +} + +TEST(libgen, basename_r) { + char buf[256]; + TestBasename("", ".", 1, NULL, 0, 0); + TestBasename("", ".", -1, buf, 0, ERANGE); + TestBasename("", ".", -1, buf, 1, ERANGE); + TestBasename("", ".", 1, buf, 2, 0); + TestBasename("", ".", 1, buf, sizeof(buf), 0); + TestBasename("/usr/lib", "lib", 3, buf, sizeof(buf), 0); + TestBasename("/usr/", "usr", 3, buf, sizeof(buf), 0); + TestBasename("usr", "usr", 3, buf, sizeof(buf), 0); + TestBasename("/", "/", 1, buf, sizeof(buf), 0); + TestBasename(".", ".", 1, buf, sizeof(buf), 0); + TestBasename("..", "..", 2, buf, sizeof(buf), 0); +} + +TEST(libgen, dirname_r) { + char buf[256]; + TestDirname("", ".", 1, NULL, 0, 0); + TestDirname("", ".", -1, buf, 0, ERANGE); + TestDirname("", ".", -1, buf, 1, ERANGE); + TestDirname("", ".", 1, buf, 2, 0); + TestDirname("/usr/lib", "/usr", 4, buf, sizeof(buf), 0); + TestDirname("/usr/", "/", 1, buf, sizeof(buf), 0); + TestDirname("usr", ".", 1, buf, sizeof(buf), 0); + TestDirname(".", ".", 1, buf, sizeof(buf), 0); + TestDirname("..", ".", 1, buf, sizeof(buf), 0); +} + +#endif