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  */
  27
  28 #ifndef SDB_UTILS_OS_H
  29 #define SDB_UTILS_OS_H 1
  30
  31 #include <sys/types.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /*
  38  * sysdb_mkdir_all:
  39  * Recursively create the directory 'pathname' (similar to 'mkdir -p' on the
  40  * command line) using file permissions as specified by 'mode'.
  41  *
  42  * Returns:
  43  *  - 0 on success
  44  *  - a negative value else
  45  */
  46 int
  47 sdb_mkdir_all(const char *pathname, mode_t mode);
  48
  49 /*
  50  * sdb_remove_all:
  51  * Recursively deletes the specified path from the filesystem.
  52  *
  53  * Returns:
  54  *  - 0 on success
  55  *  - a negative value else
  56  */
  57 int
  58 sdb_remove_all(const char *pathname);
  59
  60 /*
  61  * sdb_get_current_user:
  62  * Returns the name of the current user. The string is allocated dynamically
  63  * and has to be freed by the caller.
  64  *
  65  * Returns:
  66  *  - the username on success
  67  *  - NULL else
  68  */
  69 char *
  70 sdb_get_current_user(void);
  71
  72 enum {
  73         SDB_SELECTIN = 0,
  74         SDB_SELECTOUT,
  75         SDB_SELECTERR,
  76 };
  77
  78 /*
  79  * sdb_select:
  80  * Wait for a file-descriptor to become ready for I/O operations of the
  81  * specified type. This is a simple wrapper around the select() system call.
  82  * The type argument may be any of the SDB_SELECT* constants.
  83  *
  84  * Returns:
  85  *  - the number of file descriptors ready for I/O
  86  *  - a negative value on error
  87  */
  88 int
  89 sdb_select(int fd, int type);
  90
  91 /*
  92  * sdb_write:
  93  * Write a message to a file-descriptor. This is a simple wrapper around the
  94  * write() system call ensuring that all data is written on success.
  95  *
  96  * Returns:
  97  *  - the number of bytes written
  98  *  - a negative value on error
  99  */
 100 ssize_t
 101 sdb_write(int fd, size_t msg_len, const void *msg);
 102
 103 #ifdef __cplusplus
 104 } /* extern "C" */
 105 #endif
 106
 107 #endif /* ! SDB_UTILS_OS_H */
 108
 109 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 110