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