sftpcommon.h

/*
 * This file is part of the Green End SFTP Server.
 * Copyright (C) 2007, 2011, 2014 Richard Kettlewell
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */

#ifndef SFTPCOMMON_H
#  define SFTPCOMMON_H

/** @file sftpcommon.h @brief Common definitions */

#  include <config.h>
#  include <inttypes.h>
#  include <sys/types.h>

#  if HAVE_ENDIAN_H
#    include <endian.h>
#  endif

#  ifndef ASM
#    define ASM 1
#  endif

#  if __GNUC__ && __amd64__ && ASM
/** @brief Byte-swap a 64-bit value */
#    define BSWAP64(N)                                                         \
      ({                                                                       \
        uint64_t __n = (N);                                                    \
        __asm__("bswap %0" : "+q"(__n));                                       \
        __n;                                                                   \
      })
#  endif

#  if __GNUC__ && !defined BSWAP64
/** @brief Byte-swap a 64-bit value */
#    define BSWAP64(N)                                                         \
      ({                                                                       \
        uint64_t __n = (N);                                                    \
        __n = ntohl(__n >> 32) | ((uint64_t)ntohl(__n) << 32);                 \
        __n;                                                                   \
      })
#  endif

#  if WORDS_BIGENDIAN
/** @brief Convert a 64-bit value to network byte order */
#    define NTOHLL(n) (n)
/** @brief Convert a 64-bit value to host byte order */
#    define HTONLL(n) (n)
#  endif

#  if HAVE_DECL_BE64TOH && !defined NTOHLL
/** @brief Convert a 64-bit value to network byte order */
#    define NTOHLL be64toh
#  endif
#  if HAVE_DECL_HTOBE64 && !defined HTONLL
/** @brief Convert a 64-bit value to host byte order */
#    define HTONLL htobe64
#  endif

#  if defined BSWAP64 && !defined NTOHLL
/** @brief Convert a 64-bit value to network byte order */
#    define NTOHLL BSWAP64
#  endif
#  if defined BSWAP64 && !defined HTONLL
/** @brief Convert a 64-bit value to host byte order */
#    define HTONLL BSWAP64
#  endif

struct queue;
struct allocator;
struct handleid;
struct sftpjob;
struct sftpattr;
struct worker;
struct stat;

/** @brief Return a human-readable description of @p status
 * @param status SFTP status code
 * @return Human-readable string
 */
const char *status_to_string(uint32_t status);

/** @brief Possible SFTP service states */
enum sftp_state {
  sftp_state_run = 0,
  sftp_state_stop = 1,
};

/** @brief Get the current SFTP service state
 * @return State value
 */
enum sftp_state sftp_state_get(void);

/** @brief Set the SFTP service state
 * @param s New state value
 */
void sftp_state_set(enum sftp_state s);

#endif /* SFTPCOMMON_H */

/*
Local Variables:
c-basic-offset:2
comment-column:40
fill-column:79
indent-tabs-mode:nil
End:
*/