Code

utils os: Added sdb_mkdir_all() helper function.
[sysdb.git] / src / include / utils / os.h
1 /*
2  * SysDB - src/include/utils/os.h
3  * Copyright (C) 2014 Sebastian 'tokkee' Harl <sh@tokkee.org>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
28 #ifndef SDB_UTILS_OS_H
29 #define SDB_UTILS_OS_H 1
31 #include <sys/types.h>
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
37 /*
38  * sysdb_mkdir_all:
39  * Recursively create the directory 'pathname' (similar to 'mkdir -p' on the
40  * command line) and ensure that its mode is 'mode'. Any newly created
41  * directories will have permissions according the the specified mode
42  * (modified by the process's umask in the usual way). The function will
43  * always ensure the specified permissions for the specified directory, even
44  * if it exists already.
45  *
46  * Returns:
47  *  - 0 on success
48  *  - a negative value else
49  */
50 int
51 sdb_mkdir_all(const char *pathname, mode_t mode);
53 #ifdef __cplusplus
54 } /* extern "C" */
55 #endif
57 #endif /* ! SDB_UTILS_OS_H */
59 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */