include/atalk/util.h

   1 /*!
   2  * @file
   3  * Netatalk utility functions
   4  *
   5  * Utility functions for these areas: \n
   6  * * sockets \n
   7  * * locking \n
   8  * * misc UNIX function wrappers, eg for getcwd
   9  */
  10
  11 #ifndef _ATALK_UTIL_H
  12 #define _ATALK_UTIL_H 1
  13
  14 #include <sys/types.h>
  15 #include <sys/socket.h>
  16 #include <unistd.h>
  17 #include <poll.h>
  18
  19 #include <atalk/unicode.h>
  20 #include <atalk/bstrlib.h>
  21
  22 /* exit error codes */
  23 #define EXITERR_CLNT 1  /* client related error */
  24 #define EXITERR_CONF 2  /* error in config files/cmd line parameters */
  25 #define EXITERR_SYS  3  /* local system error */
  26
  27 /* Print a SBT and exit */
  28 #define AFP_PANIC(why) \
  29     do {                                            \
  30         netatalk_panic(why);                        \
  31         abort();                                    \
  32     } while(0);
  33
  34 /* LOG assert errors */
  35 #ifndef NDEBUG
  36 #define AFP_ASSERT(b) \
  37     do {                                                                \
  38         if (!(b)) {                                                     \
  39             AFP_PANIC(#b);                                              \
  40         } \
  41     } while(0);
  42 #else
  43 #define AFP_ASSERT(b)
  44 #endif /* NDEBUG */
  45
  46 #ifndef MIN
  47 #define MIN(a, b)  ((a) < (b) ? (a) : (b))
  48 #endif
  49
  50 #ifndef MAX
  51 #define MAX(a, b)  ((a) > (b) ? (a) : (b))
  52 #endif
  53
  54 #define STRCMP(a,b,c) (strcmp(a,c) b 0)
  55 #define ZERO_STRUCT(a) memset(&(a), 0, sizeof(a))
  56 #define ZERO_STRUCTP(a) memset((a), 0, sizeof(a))
  57 #ifndef MAX
  58 #define MAX(a,b) ((a) > (b) ? a : b)
  59 #endif
  60 #ifndef MIN
  61 #define MIN(a,b) ((a) < (b) ? a : b)
  62 #endif
  63
  64 #ifdef WORDS_BIGENDIAN
  65 #define hton64(x)       (x)
  66 #define ntoh64(x)       (x)
  67 #else
  68 #define hton64(x)       ((uint64_t) (htonl(((x) >> 32) & 0xffffffffLL)) | \
  69                          (uint64_t) ((htonl(x) & 0xffffffffLL) << 32))
  70 #define ntoh64(x)       (hton64(x))
  71 #endif
  72
  73 #ifdef WITH_SENDFILE
  74 extern ssize_t sys_sendfile (int __out_fd, int __in_fd, off_t *__offset,size_t __count);
  75 #endif
  76
  77 extern const int _diacasemap[], _dialowermap[];
  78
  79 extern char **getifacelist(void);
  80 extern void freeifacelist(char **);
  81
  82 #define diatolower(x)     _dialowermap[(unsigned char) (x)]
  83 #define diatoupper(x)     _diacasemap[(unsigned char) (x)]
  84 extern void bprint        (char *, int);
  85 extern int strdiacasecmp  (const char *, const char *);
  86 extern int strndiacasecmp (const char *, const char *, size_t);
  87 extern pid_t server_lock  (char * /*program*/, char * /*file*/, int /*debug*/);
  88 extern int check_lockfile (const char *program, const char *pidfile);
  89 extern int create_lockfile(const char *program, const char *pidfile);
  90 extern void fault_setup   (void (*fn)(void *));
  91 extern void netatalk_panic(const char *why);
  92 #define server_unlock(x)  (unlink(x))
  93
  94 #ifndef HAVE_DLFCN_H
  95 extern void *mod_open    (const char *);
  96 extern void *mod_symbol  (void *, const char *);
  97 extern void mod_close    (void *);
  98 #define mod_error()      ""
  99 #else /* ! HAVE_DLFCN_H */
 100 #include <dlfcn.h>
 101
 102 #ifndef RTLD_NOW
 103 #define RTLD_NOW 1
 104 #endif /* ! RTLD_NOW */
 105
 106 /* NetBSD doesn't like RTLD_NOW for dlopen (it fails). Use RTLD_LAZY.
 107  * OpenBSD currently does not use the second arg for dlopen(). For
 108  * future compatibility we define DL_LAZY */
 109 #ifdef __NetBSD__
 110 #define mod_open(a)      dlopen(a, RTLD_LAZY)
 111 #elif defined(__OpenBSD__)
 112 #define mod_open(a)      dlopen(a, DL_LAZY)
 113 #else /* ! __NetBSD__ && ! __OpenBSD__ */
 114 #define mod_open(a)      dlopen(a, RTLD_NOW)
 115 #endif /* __NetBSD__ */
 116
 117 #ifndef DLSYM_PREPEND_UNDERSCORE
 118 #define mod_symbol(a, b) dlsym(a, b)
 119 #else /* ! DLSYM_PREPEND_UNDERSCORE */
 120 extern void *mod_symbol  (void *, const char *);
 121 #endif /* ! DLSYM_PREPEND_UNDERSCORE */
 122 #define mod_error()      dlerror()
 123 #define mod_close(a)     dlclose(a)
 124 #endif /* ! HAVE_DLFCN_H */
 125
 126 /******************************************************************
 127  * locking.c
 128  ******************************************************************/
 129
 130 extern int lock_reg(int fd, int cmd, int type, off_t offest, int whence, off_t len);
 131 #define read_lock(fd, offset, whence, len) \
 132     lock_reg((fd), F_SETLK, F_RDLCK, (offset), (whence), (len))
 133 #define write_lock(fd, offset, whence, len) \
 134     lock_reg((fd), F_SETLK, F_WRLCK, (offset), (whence), (len))
 135 #define unlock(fd, offset, whence, len) \
 136     lock_reg((fd), F_SETLK, F_UNLCK, (offset), (whence), (len))
 137
 138 /******************************************************************
 139  * socket.c
 140  ******************************************************************/
 141
 142 extern int setnonblock(int fd, int cmd);
 143 extern ssize_t readt(int socket, void *data, const size_t length, int setnonblocking, int timeout);
 144 extern ssize_t writet(int socket, void *data, const size_t length, int setnonblocking, int timeout);
 145 extern const char *getip_string(const struct sockaddr *sa);
 146 extern unsigned int getip_port(const struct sockaddr *sa);
 147 extern void apply_ip_mask(struct sockaddr *ai, int maskbits);
 148 extern int compare_ip(const struct sockaddr *sa1, const struct sockaddr *sa2);
 149
 150 /* Structures and functions dealing with dynamic pollfd arrays */
 151 enum fdtype {IPC_FD, LISTEN_FD, DISASOCIATED_IPC_FD};
 152 struct polldata {
 153     enum fdtype fdtype; /* IPC fd or listening socket fd                 */
 154     void *data;         /* pointer to AFPconfig for listening socket and *
 155                          * pointer to afp_child_t for IPC fd             */
 156 };
 157
 158 extern void fdset_add_fd(int maxconns,
 159                          struct pollfd **fdsetp,
 160                          struct polldata **polldatap,
 161                          int *fdset_usedp,
 162                          int *fdset_sizep,
 163                          int fd,
 164                          enum fdtype fdtype,
 165                          void *data);
 166 extern void fdset_del_fd(struct pollfd **fdsetp,
 167                          struct polldata **polldatap,
 168                          int *fdset_usedp,
 169                          int *fdset_sizep,
 170                          int fd);
 171 extern int send_fd(int socket, int fd);
 172 extern int recv_fd(int fd, int nonblocking);
 173
 174 /******************************************************************
 175  * unix.c
 176  *****************************************************************/
 177
 178 extern const char *getcwdpath(void);
 179 extern const char *fullpathname(const char *);
 180 extern char *stripped_slashes_basename(char *p);
 181 extern int lchdir(const char *dir);
 182 extern void randombytes(void *buf, int n);
 183 extern int daemonize(int nochdir, int noclose);
 184 extern int run_cmd(const char *cmd, char **cmd_argv);
 185 extern char *realpath_safe(const char *path);
 186 extern const char *basename_safe(const char *path);
 187 extern char *strtok_quote (char *s, const char *delim);
 188
 189 /******************************************************************
 190  * cnid.c
 191  *****************************************************************/
 192
 193 extern bstring rel_path_in_vol(const char *path, const char *volpath);
 194
 195 /******************************************************************
 196  * cnid.c
 197  *****************************************************************/
 198
 199 extern void initline   (int, char *);
 200 extern int  parseline  (int, char *);
 201
 202 #endif  /* _ATALK_UTIL_H */