1 /* 2 * Automated Testing Framework (atf) 3 * 4 * Copyright (c) 2008 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND 17 * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY 21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 23 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 25 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 26 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 27 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 */ 29 30 #if !defined(ATF_C_FS_H) 31 #define ATF_C_FS_H 32 33 #include <sys/types.h> 34 #include <sys/stat.h> 35 36 #include <stdarg.h> 37 #include <stdbool.h> 38 39 #include <atf-c/defs.h> 40 #include <atf-c/error_fwd.h> 41 42 #include "dynstr.h" 43 44 /* --------------------------------------------------------------------- 45 * The "atf_fs_path" type. 46 * --------------------------------------------------------------------- */ 47 48 struct atf_fs_path { 49 atf_dynstr_t m_data; 50 }; 51 typedef struct atf_fs_path atf_fs_path_t; 52 53 /* Constructors/destructors. */ 54 atf_error_t atf_fs_path_init_ap(atf_fs_path_t *, const char *, va_list) 55 ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(2, 0); 56 atf_error_t atf_fs_path_init_fmt(atf_fs_path_t *, const char *, ...) 57 ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(2, 3); 58 atf_error_t atf_fs_path_copy(atf_fs_path_t *, const atf_fs_path_t *); 59 void atf_fs_path_fini(atf_fs_path_t *); 60 61 /* Getters. */ 62 atf_error_t atf_fs_path_branch_path(const atf_fs_path_t *, atf_fs_path_t *); 63 const char *atf_fs_path_cstring(const atf_fs_path_t *); 64 atf_error_t atf_fs_path_leaf_name(const atf_fs_path_t *, atf_dynstr_t *); 65 bool atf_fs_path_is_absolute(const atf_fs_path_t *); 66 bool atf_fs_path_is_root(const atf_fs_path_t *); 67 68 /* Modifiers. */ 69 atf_error_t atf_fs_path_append_ap(atf_fs_path_t *, const char *, va_list) 70 ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(2, 0); 71 atf_error_t atf_fs_path_append_fmt(atf_fs_path_t *, const char *, ...) 72 ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(2, 3); 73 atf_error_t atf_fs_path_append_path(atf_fs_path_t *, const atf_fs_path_t *); 74 atf_error_t atf_fs_path_to_absolute(const atf_fs_path_t *, atf_fs_path_t *); 75 76 /* Operators. */ 77 bool atf_equal_fs_path_fs_path(const atf_fs_path_t *, 78 const atf_fs_path_t *); 79 80 /* --------------------------------------------------------------------- 81 * The "atf_fs_stat" type. 82 * --------------------------------------------------------------------- */ 83 84 struct atf_fs_stat { 85 int m_type; 86 struct stat m_sb; 87 }; 88 typedef struct atf_fs_stat atf_fs_stat_t; 89 90 /* Constants. */ 91 extern const int atf_fs_stat_blk_type; 92 extern const int atf_fs_stat_chr_type; 93 extern const int atf_fs_stat_dir_type; 94 extern const int atf_fs_stat_fifo_type; 95 extern const int atf_fs_stat_lnk_type; 96 extern const int atf_fs_stat_reg_type; 97 extern const int atf_fs_stat_sock_type; 98 extern const int atf_fs_stat_wht_type; 99 100 /* Constructors/destructors. */ 101 atf_error_t atf_fs_stat_init(atf_fs_stat_t *, const atf_fs_path_t *); 102 void atf_fs_stat_copy(atf_fs_stat_t *, const atf_fs_stat_t *); 103 void atf_fs_stat_fini(atf_fs_stat_t *); 104 105 /* Getters. */ 106 dev_t atf_fs_stat_get_device(const atf_fs_stat_t *); 107 ino_t atf_fs_stat_get_inode(const atf_fs_stat_t *); 108 mode_t atf_fs_stat_get_mode(const atf_fs_stat_t *); 109 off_t atf_fs_stat_get_size(const atf_fs_stat_t *); 110 int atf_fs_stat_get_type(const atf_fs_stat_t *); 111 bool atf_fs_stat_is_owner_readable(const atf_fs_stat_t *); 112 bool atf_fs_stat_is_owner_writable(const atf_fs_stat_t *); 113 bool atf_fs_stat_is_owner_executable(const atf_fs_stat_t *); 114 bool atf_fs_stat_is_group_readable(const atf_fs_stat_t *); 115 bool atf_fs_stat_is_group_writable(const atf_fs_stat_t *); 116 bool atf_fs_stat_is_group_executable(const atf_fs_stat_t *); 117 bool atf_fs_stat_is_other_readable(const atf_fs_stat_t *); 118 bool atf_fs_stat_is_other_writable(const atf_fs_stat_t *); 119 bool atf_fs_stat_is_other_executable(const atf_fs_stat_t *); 120 121 /* --------------------------------------------------------------------- 122 * Free functions. 123 * --------------------------------------------------------------------- */ 124 125 extern const int atf_fs_access_f; 126 extern const int atf_fs_access_r; 127 extern const int atf_fs_access_w; 128 extern const int atf_fs_access_x; 129 130 atf_error_t atf_fs_eaccess(const atf_fs_path_t *, int); 131 atf_error_t atf_fs_exists(const atf_fs_path_t *, bool *); 132 atf_error_t atf_fs_getcwd(atf_fs_path_t *); 133 atf_error_t atf_fs_mkdtemp(atf_fs_path_t *); 134 atf_error_t atf_fs_mkstemp(atf_fs_path_t *, int *); 135 atf_error_t atf_fs_rmdir(const atf_fs_path_t *); 136 atf_error_t atf_fs_unlink(const atf_fs_path_t *); 137 138 #endif /* !defined(ATF_C_FS_H) */ 139