include/atalk/util.h

   1 /*
   2  * $Id: util.h,v 1.21 2010/02/28 22:29:16 didg Exp $
   3  */
   4
   5 /*!
   6  * @file
   7  * Netatalk utility functions
   8  *
   9  * Utility functions for these areas: \n
  10  * * sockets \n
  11  * * locking \n
  12  * * misc UNIX function wrappers, eg for getcwd
  13  */
  14
  15 #ifndef _ATALK_UTIL_H
  16 #define _ATALK_UTIL_H 1
  17
  18 #include <sys/cdefs.h>
  19 #include <sys/types.h>
  20 #ifdef HAVE_UNISTD_H
  21 #include <unistd.h>
  22 #endif /* HAVE_UNISTD_H */
  23 #include <netatalk/at.h>
  24 #include <atalk/unicode.h>
  25
  26 /* exit error codes */
  27 #define EXITERR_CLNT 1  /* client related error */
  28 #define EXITERR_CONF 2  /* error in config files/cmd line parameters */
  29 #define EXITERR_SYS  3  /* local system error */
  30
  31 /* Print a SBT and exit */
  32 #define AFP_PANIC(why) \
  33     do {                                            \
  34         netatalk_panic(why);                        \
  35         abort();                                    \
  36     } while(0);
  37
  38 /* LOG assert errors */
  39 #ifndef NDEBUG
  40 #define AFP_ASSERT(b) \
  41     do {                                                                \
  42         if (!(b)) {                                                     \
  43             AFP_PANIC(#b);                                              \
  44         } \
  45     } while(0);
  46 #else
  47 #define AFP_ASSERT(b)
  48 #endif /* NDEBUG */
  49
  50 #ifdef WITH_SENDFILE
  51 extern ssize_t sys_sendfile (int __out_fd, int __in_fd, off_t *__offset,size_t __count);
  52 #endif
  53
  54 extern const int _diacasemap[], _dialowermap[];
  55
  56 extern char **getifacelist(void);
  57 extern void freeifacelist(char **);
  58
  59 #define diatolower(x)     _dialowermap[(unsigned char) (x)]
  60 #define diatoupper(x)     _diacasemap[(unsigned char) (x)]
  61 extern int atalk_aton     (char *, struct at_addr *);
  62 extern void bprint        (char *, int);
  63 extern int strdiacasecmp  (const char *, const char *);
  64 extern int strndiacasecmp (const char *, const char *, size_t);
  65 extern pid_t server_lock  (char * /*program*/, char * /*file*/, int /*debug*/);
  66 extern void fault_setup   (void (*fn)(void *));
  67 extern void netatalk_panic(const char *why);
  68 #define server_unlock(x)  (unlink(x))
  69
  70 /* strlcpy and strlcat are used by pam modules */
  71 #ifndef UAM_MODULE_EXPORT
  72 #define UAM_MODULE_EXPORT
  73 #endif
  74
  75 #ifndef HAVE_STRLCPY
  76 UAM_MODULE_EXPORT size_t strlcpy (char *, const char *, size_t);
  77 #endif
  78
  79 #ifndef HAVE_STRLCAT
  80 UAM_MODULE_EXPORT size_t strlcat (char *, const char *, size_t);
  81 #endif
  82
  83 #ifndef HAVE_DLFCN_H
  84 extern void *mod_open    (const char *);
  85 extern void *mod_symbol  (void *, const char *);
  86 extern void mod_close    (void *);
  87 #define mod_error()      ""
  88 #else /* ! HAVE_DLFCN_H */
  89 #include <dlfcn.h>
  90
  91 #ifndef RTLD_NOW
  92 #define RTLD_NOW 1
  93 #endif /* ! RTLD_NOW */
  94
  95 /* NetBSD doesn't like RTLD_NOW for dlopen (it fails). Use RTLD_LAZY.
  96  * OpenBSD currently does not use the second arg for dlopen(). For
  97  * future compatibility we define DL_LAZY */
  98 #ifdef __NetBSD__
  99 #define mod_open(a)      dlopen(a, RTLD_LAZY)
 100 #elif defined(__OpenBSD__)
 101 #define mod_open(a)      dlopen(a, DL_LAZY)
 102 #else /* ! __NetBSD__ && ! __OpenBSD__ */
 103 #define mod_open(a)      dlopen(a, RTLD_NOW)
 104 #endif /* __NetBSD__ */
 105
 106 #ifndef DLSYM_PREPEND_UNDERSCORE
 107 #define mod_symbol(a, b) dlsym(a, b)
 108 #else /* ! DLSYM_PREPEND_UNDERSCORE */
 109 extern void *mod_symbol  (void *, const char *);
 110 #endif /* ! DLSYM_PREPEND_UNDERSCORE */
 111 #define mod_error()      dlerror()
 112 #define mod_close(a)     dlclose(a)
 113 #endif /* ! HAVE_DLFCN_H */
 114
 115 /******************************************************************
 116  * locking.c
 117  ******************************************************************/
 118
 119 extern int lock_reg(int fd, int cmd, int type, off_t offest, int whence, off_t len);
 120 #define read_lock(fd, offset, whence, len) \
 121     lock_reg((fd), F_SETLK, F_RDLCK, (offset), (whence), (len))
 122 #define write_lock(fd, offset, whence, len) \
 123     lock_reg((fd), F_SETLK, F_WRLCK, (offset), (whence), (len))
 124 #define unlock(fd, offset, whence, len) \
 125     lock_reg((fd), F_SETLK, F_UNLCK, (offset), (whence), (len))
 126
 127 /******************************************************************
 128  * socket.c
 129  ******************************************************************/
 130
 131 extern int setnonblock(int fd, int cmd);
 132 extern const char *getip_string(const struct sockaddr *sa);
 133 extern unsigned int getip_port(const struct sockaddr *sa);
 134 extern void apply_ip_mask(struct sockaddr *ai, int maskbits);
 135 extern int compare_ip(const struct sockaddr *sa1, const struct sockaddr *sa2);
 136
 137 /******************************************************************
 138  * unix.c
 139  *****************************************************************/
 140
 141 extern const char *getcwdpath(void);
 142 extern int lchdir(const char *dir);
 143
 144 #endif  /* _ATALK_UTIL_H */