home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277222_apr_portable.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  19KB  |  505 lines
  1. /* Copyright 2000-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  */
  15.  
  16. /* This header file is where you should put ANY platform specific information.
  17.  * This should be the only header file that programs need to include that 
  18.  * actually has platform dependant code which refers to the .
  19.  */
  20. #ifndef APR_PORTABLE_H
  21. #define APR_PORTABLE_H
  22. /**
  23.  * @file apr_portable.h
  24.  * @brief APR Portability Routines
  25.  */
  26.  
  27. #include "apr.h"
  28. #include "apr_pools.h"
  29. #include "apr_thread_proc.h"
  30. #include "apr_file_io.h"
  31. #include "apr_network_io.h"
  32. #include "apr_errno.h"
  33. #include "apr_global_mutex.h"
  34. #include "apr_proc_mutex.h"
  35. #include "apr_time.h"
  36. #include "apr_dso.h"
  37. #include "apr_shm.h"
  38.  
  39. #if APR_HAVE_DIRENT_H
  40. #include <dirent.h>
  41. #endif
  42. #if APR_HAVE_FCNTL_H
  43. #include <fcntl.h>
  44. #endif
  45. #if APR_HAVE_PTHREAD_H
  46. #include <pthread.h>
  47. #endif
  48.  
  49. #ifdef __cplusplus
  50. extern "C" {
  51. #endif /* __cplusplus */
  52.  
  53. /**
  54.  * @defgroup apr_portabile Portability Routines
  55.  * @ingroup APR 
  56.  * @{
  57.  */
  58.  
  59. #ifdef WIN32
  60. /* The primitives for Windows types */
  61. typedef HANDLE                apr_os_file_t;
  62. typedef HANDLE                apr_os_dir_t;
  63. typedef SOCKET                apr_os_sock_t;
  64. typedef HANDLE                apr_os_proc_mutex_t;
  65. typedef HANDLE                apr_os_thread_t;
  66. typedef HANDLE                apr_os_proc_t;
  67. typedef DWORD                 apr_os_threadkey_t; 
  68. typedef FILETIME              apr_os_imp_time_t;
  69. typedef SYSTEMTIME            apr_os_exp_time_t;
  70. typedef HANDLE                apr_os_dso_handle_t;
  71. typedef HANDLE                apr_os_shm_t;
  72.  
  73. #elif defined(OS2)
  74. typedef HFILE                 apr_os_file_t;
  75. typedef HDIR                  apr_os_dir_t;
  76. typedef int                   apr_os_sock_t;
  77. typedef HMTX                  apr_os_proc_mutex_t;
  78. typedef TID                   apr_os_thread_t;
  79. typedef PID                   apr_os_proc_t;
  80. typedef PULONG                apr_os_threadkey_t; 
  81. typedef struct timeval        apr_os_imp_time_t;
  82. typedef struct tm             apr_os_exp_time_t;
  83. typedef HMODULE               apr_os_dso_handle_t;
  84. typedef void*                 apr_os_shm_t;
  85.  
  86. #elif defined(__BEOS__)
  87. #include <kernel/OS.h>
  88. #include <kernel/image.h>
  89.  
  90. struct apr_os_proc_mutex_t {
  91.     sem_id sem;
  92.     int32  ben;
  93. };
  94.  
  95. typedef int                   apr_os_file_t;
  96. typedef DIR                   apr_os_dir_t;
  97. typedef int                   apr_os_sock_t;
  98. typedef struct apr_os_proc_mutex_t  apr_os_proc_mutex_t;
  99. typedef thread_id             apr_os_thread_t;
  100. typedef thread_id             apr_os_proc_t;
  101. typedef int                   apr_os_threadkey_t;
  102. typedef struct timeval        apr_os_imp_time_t;
  103. typedef struct tm             apr_os_exp_time_t;
  104. typedef image_id              apr_os_dso_handle_t;
  105. typedef void*                 apr_os_shm_t;
  106.  
  107. #elif defined(NETWARE)
  108. typedef int                   apr_os_file_t;
  109. typedef DIR                   apr_os_dir_t;
  110. typedef int                   apr_os_sock_t;
  111. typedef NXMutex_t             apr_os_proc_mutex_t;
  112. typedef NXThreadId_t          apr_os_thread_t;
  113. typedef long                  apr_os_proc_t;
  114. typedef NXKey_t               apr_os_threadkey_t; 
  115. typedef struct timeval        apr_os_imp_time_t;
  116. typedef struct tm             apr_os_exp_time_t;
  117. typedef void *                apr_os_dso_handle_t;
  118. typedef void*                 apr_os_shm_t;
  119.  
  120. #else
  121. /* Any other OS should go above this one.  This is the lowest common
  122.  * denominator typedefs for  all UNIX-like systems.  :)
  123.  */
  124.  
  125. /** Basic OS process mutex structure. */
  126. struct apr_os_proc_mutex_t {
  127. #if APR_HAS_SYSVSEM_SERIALIZE || APR_HAS_FCNTL_SERIALIZE || APR_HAS_FLOCK_SERIALIZE
  128.     int crossproc;
  129. #endif
  130. #if APR_HAS_PROC_PTHREAD_SERIALIZE
  131.     pthread_mutex_t *pthread_interproc;
  132. #endif
  133. #if APR_HAS_THREADS
  134.     /* If no threads, no need for thread locks */
  135. #if APR_USE_PTHREAD_SERIALIZE
  136.     pthread_mutex_t *intraproc;
  137. #endif
  138. #endif
  139. };
  140.  
  141. typedef int                   apr_os_file_t;        /**< native file */
  142. typedef DIR                   apr_os_dir_t;         /**< native dir */
  143. typedef int                   apr_os_sock_t;        /**< native dir */
  144. typedef struct apr_os_proc_mutex_t  apr_os_proc_mutex_t; /**< native proces
  145.                                                           *   mutex
  146.                                                           */
  147. #if APR_HAS_THREADS && APR_HAVE_PTHREAD_H 
  148. typedef pthread_t             apr_os_thread_t;      /**< native thread */
  149. typedef pthread_key_t         apr_os_threadkey_t;   /**< native thread address
  150.                                                      *   space */
  151. #endif
  152. typedef pid_t                 apr_os_proc_t;        /**< native pid */
  153. typedef struct timeval        apr_os_imp_time_t;    /**< native timeval */
  154. typedef struct tm             apr_os_exp_time_t;    /**< native tm */
  155. /** @var apr_os_dso_handle_t
  156.  * native dso types
  157.  */
  158. #if defined(HPUX) || defined(HPUX10) || defined(HPUX11)
  159. #include <dl.h>
  160. typedef shl_t                 apr_os_dso_handle_t;
  161. #elif defined(DARWIN)
  162. #include <mach-o/dyld.h>
  163. typedef NSModule              apr_os_dso_handle_t;
  164. #else
  165. typedef void *                apr_os_dso_handle_t;
  166. #endif
  167. typedef void*                 apr_os_shm_t;         /**< native SHM */
  168.  
  169. #endif
  170.  
  171. /**
  172.  * @typedef apr_os_sock_info_t
  173.  * @brief alias for local OS socket
  174.  */
  175. /**
  176.  * everything APR needs to know about an active socket to construct
  177.  * an APR socket from it; currently, this is platform-independent
  178.  */
  179. struct apr_os_sock_info_t {
  180.     apr_os_sock_t *os_sock; /**< always required */
  181.     struct sockaddr *local; /**< NULL if not yet bound */
  182.     struct sockaddr *remote; /**< NULL if not connected */
  183.     int family;             /**< always required (APR_INET, APR_INET6, etc.) */
  184.     int type;               /**< always required (SOCK_STREAM, SOCK_DGRAM, etc.) */
  185. #ifdef APR_ENABLE_FOR_1_0   /**< enable with APR 1.0 */
  186.     int protocol;           /**< 0 or actual protocol (APR_PROTO_SCTP, APR_PROTO_TCP, etc.) */
  187. #endif
  188. };
  189.  
  190. typedef struct apr_os_sock_info_t apr_os_sock_info_t;
  191.  
  192. #if APR_PROC_MUTEX_IS_GLOBAL || defined(DOXYGEN)
  193. /** Opaque global mutex type */
  194. #define apr_os_global_mutex_t apr_os_proc_mutex_t
  195. /** @return apr_os_global_mutex */
  196. #define apr_os_global_mutex_get apr_os_proc_mutex_get
  197. #else
  198.     /** Thread and process mutex for those platforms where process mutexes
  199.      *  are not held in threads.
  200.      */
  201.     struct apr_os_global_mutex_t {
  202.         apr_pool_t *pool;
  203.         apr_proc_mutex_t *proc_mutex;
  204. #if APR_HAS_THREADS
  205.         apr_thread_mutex_t *thread_mutex;
  206. #endif /* APR_HAS_THREADS */
  207.     };
  208.     typedef struct apr_os_global_mutex_t apr_os_global_mutex_t;
  209.  
  210. APR_DECLARE(apr_status_t) apr_os_global_mutex_get(apr_os_global_mutex_t *ospmutex, 
  211.                                                 apr_global_mutex_t *pmutex);
  212. #endif
  213.  
  214.  
  215. /**
  216.  * convert the file from apr type to os specific type.
  217.  * @param thefile The os specific file we are converting to
  218.  * @param file The apr file to convert.
  219.  * @remark On Unix, it is only possible to get a file descriptor from 
  220.  *         an apr file type.
  221.  */
  222. APR_DECLARE(apr_status_t) apr_os_file_get(apr_os_file_t *thefile,
  223.                                           apr_file_t *file);
  224.  
  225. /**
  226.  * convert the dir from apr type to os specific type.
  227.  * @param thedir The os specific dir we are converting to
  228.  * @param dir The apr dir to convert.
  229.  */   
  230. APR_DECLARE(apr_status_t) apr_os_dir_get(apr_os_dir_t **thedir, 
  231.                                          apr_dir_t *dir);
  232.  
  233. /**
  234.  * Convert the socket from an apr type to an OS specific socket
  235.  * @param thesock The socket to convert.
  236.  * @param sock The os specifc equivelant of the apr socket..
  237.  */
  238. APR_DECLARE(apr_status_t) apr_os_sock_get(apr_os_sock_t *thesock,
  239.                                           apr_socket_t *sock);
  240.  
  241. /**
  242.  * Convert the proc mutex from os specific type to apr type
  243.  * @param ospmutex The os specific proc mutex we are converting to.
  244.  * @param pmutex The apr proc mutex to convert.
  245.  */
  246. APR_DECLARE(apr_status_t) apr_os_proc_mutex_get(apr_os_proc_mutex_t *ospmutex, 
  247.                                                 apr_proc_mutex_t *pmutex);
  248.  
  249. /**
  250.  * Get the exploded time in the platforms native format.
  251.  * @param ostime the native time format
  252.  * @param aprtime the time to convert
  253.  */
  254. APR_DECLARE(apr_status_t) apr_os_exp_time_get(apr_os_exp_time_t **ostime,
  255.                                  apr_time_exp_t *aprtime);
  256.  
  257. /**
  258.  * Get the imploded time in the platforms native format.
  259.  * @param ostime  the native time format
  260.  * @param aprtime the time to convert
  261.  */
  262. APR_DECLARE(apr_status_t) apr_os_imp_time_get(apr_os_imp_time_t **ostime, 
  263.                                               apr_time_t *aprtime);
  264.  
  265. /**
  266.  * convert the shm from apr type to os specific type.
  267.  * @param osshm The os specific shm representation
  268.  * @param shm The apr shm to convert.
  269.  */   
  270. APR_DECLARE(apr_status_t) apr_os_shm_get(apr_os_shm_t *osshm,
  271.                                          apr_shm_t *shm);
  272.  
  273. #if APR_HAS_THREADS || defined(DOXYGEN)
  274. /** 
  275.  * @defgroup apr_os_thread Thread portability Routines
  276.  * @{ 
  277.  */
  278. /**
  279.  * convert the thread to os specific type from apr type.
  280.  * @param thethd The apr thread to convert
  281.  * @param thd The os specific thread we are converting to
  282.  */
  283. APR_DECLARE(apr_status_t) apr_os_thread_get(apr_os_thread_t **thethd, 
  284.                                             apr_thread_t *thd);
  285.  
  286. /**
  287.  * convert the thread private memory key to os specific type from an apr type.
  288.  * @param thekey The apr handle we are converting from.
  289.  * @param key The os specific handle we are converting to.
  290.  */
  291. APR_DECLARE(apr_status_t) apr_os_threadkey_get(apr_os_threadkey_t *thekey,
  292.                                                apr_threadkey_t *key);
  293.  
  294. /**
  295.  * convert the thread from os specific type to apr type.
  296.  * @param thd The apr thread we are converting to.
  297.  * @param thethd The os specific thread to convert
  298.  * @param cont The pool to use if it is needed.
  299.  */
  300. APR_DECLARE(apr_status_t) apr_os_thread_put(apr_thread_t **thd,
  301.                                             apr_os_thread_t *thethd,
  302.                                             apr_pool_t *cont);
  303.  
  304. /**
  305.  * convert the thread private memory key from os specific type to apr type.
  306.  * @param key The apr handle we are converting to.
  307.  * @param thekey The os specific handle to convert
  308.  * @param cont The pool to use if it is needed.
  309.  */
  310. APR_DECLARE(apr_status_t) apr_os_threadkey_put(apr_threadkey_t **key,
  311.                                                apr_os_threadkey_t *thekey,
  312.                                                apr_pool_t *cont);
  313. /**
  314.  * Get the thread ID
  315.  */
  316. APR_DECLARE(apr_os_thread_t) apr_os_thread_current(void);
  317.  
  318. /**
  319.  * Compare two thread id's
  320.  * @param tid1 1st Thread ID to compare
  321.  * @param tid2 2nd Thread ID to compare
  322.  */ 
  323. APR_DECLARE(int) apr_os_thread_equal(apr_os_thread_t tid1, 
  324.                                      apr_os_thread_t tid2);
  325.  
  326. /** @} */
  327. #endif /* APR_HAS_THREADS */
  328.  
  329. /**
  330.  * convert the file from os specific type to apr type.
  331.  * @param file The apr file we are converting to.
  332.  * @param thefile The os specific file to convert
  333.  * @param flags The flags that were used to open this file.
  334.  * @param cont The pool to use if it is needed.
  335.  * @remark On Unix, it is only possible to put a file descriptor into
  336.  *         an apr file type.
  337.  */
  338. APR_DECLARE(apr_status_t) apr_os_file_put(apr_file_t **file,
  339.                                           apr_os_file_t *thefile,
  340.                                           apr_int32_t flags, apr_pool_t *cont); 
  341.  
  342. /**
  343.  * convert the file from os specific type to apr type.
  344.  * @param file The apr file we are converting to.
  345.  * @param thefile The os specific pipe to convert
  346.  * @param cont The pool to use if it is needed.
  347.  * @remark On Unix, it is only possible to put a file descriptor into
  348.  *         an apr file type.
  349.  */
  350. APR_DECLARE(apr_status_t) apr_os_pipe_put(apr_file_t **file,
  351.                                           apr_os_file_t *thefile,
  352.                                           apr_pool_t *cont);
  353.  
  354. /**
  355.  * convert the file from os specific type to apr type.
  356.  * @param file The apr file we are converting to.
  357.  * @param thefile The os specific pipe to convert
  358.  * @param register_cleanup A cleanup will be registered on the apr_file_t
  359.  *   to issue apr_file_close().
  360.  * @param cont The pool to use if it is needed.
  361.  * @remark On Unix, it is only possible to put a file descriptor into
  362.  *         an apr file type.
  363.  */
  364. APR_DECLARE(apr_status_t) apr_os_pipe_put_ex(apr_file_t **file,
  365.                                              apr_os_file_t *thefile,
  366.                                              int register_cleanup,
  367.                                              apr_pool_t *cont);
  368.  
  369. /**
  370.  * convert the dir from os specific type to apr type.
  371.  * @param dir The apr dir we are converting to.
  372.  * @param thedir The os specific dir to convert
  373.  * @param cont The pool to use when creating to apr directory.
  374.  */
  375. APR_DECLARE(apr_status_t) apr_os_dir_put(apr_dir_t **dir,
  376.                                          apr_os_dir_t *thedir,
  377.                                          apr_pool_t *cont); 
  378.  
  379. /**
  380.  * Convert a socket from the os specific type to the apr type
  381.  * @param sock The pool to use.
  382.  * @param thesock The socket to convert to.
  383.  * @param cont The socket we are converting to an apr type.
  384.  * @remark If it is a true socket, it is best to call apr_os_sock_make()
  385.  *         and provide APR with more information about the socket.
  386.  */
  387. APR_DECLARE(apr_status_t) apr_os_sock_put(apr_socket_t **sock, 
  388.                                           apr_os_sock_t *thesock, 
  389.                                           apr_pool_t *cont);
  390.  
  391. /**
  392.  * Create a socket from an existing descriptor and local and remote
  393.  * socket addresses.
  394.  * @param apr_sock The new socket that has been set up
  395.  * @param os_sock_info The os representation of the socket handle and
  396.  *        other characteristics of the socket
  397.  * @param cont The pool to use
  398.  * @remark If you only know the descriptor/handle or if it isn't really
  399.  *         a true socket, use apr_os_sock_put() instead.
  400.  */
  401. APR_DECLARE(apr_status_t) apr_os_sock_make(apr_socket_t **apr_sock,
  402.                                            apr_os_sock_info_t *os_sock_info,
  403.                                            apr_pool_t *cont);
  404.  
  405. /**
  406.  * Convert the proc mutex from os specific type to apr type
  407.  * @param pmutex The apr proc mutex we are converting to.
  408.  * @param ospmutex The os specific proc mutex to convert.
  409.  * @param cont The pool to use if it is needed.
  410.  */
  411. APR_DECLARE(apr_status_t) apr_os_proc_mutex_put(apr_proc_mutex_t **pmutex,
  412.                                                 apr_os_proc_mutex_t *ospmutex,
  413.                                                 apr_pool_t *cont); 
  414.  
  415. /**
  416.  * Put the imploded time in the APR format.
  417.  * @param aprtime the APR time format
  418.  * @param ostime the time to convert
  419.  * @param cont the pool to use if necessary
  420.  */
  421. APR_DECLARE(apr_status_t) apr_os_imp_time_put(apr_time_t *aprtime,
  422.                                               apr_os_imp_time_t **ostime,
  423.                                               apr_pool_t *cont); 
  424.  
  425. /**
  426.  * Put the exploded time in the APR format.
  427.  * @param aprtime the APR time format
  428.  * @param ostime the time to convert
  429.  * @param cont the pool to use if necessary
  430.  */
  431. APR_DECLARE(apr_status_t) apr_os_exp_time_put(apr_time_exp_t *aprtime,
  432.                                               apr_os_exp_time_t **ostime,
  433.                                               apr_pool_t *cont); 
  434.  
  435. /**
  436.  * convert the shared memory from os specific type to apr type.
  437.  * @param shm The apr shm representation of osshm
  438.  * @param osshm The os specific shm identity
  439.  * @param cont The pool to use if it is needed.
  440.  * @remark On fork()ed architectures, this is typically nothing more than
  441.  * the memory block mapped.  On non-fork architectures, this is typically
  442.  * some internal handle to pass the mapping from process to process.
  443.  */
  444. APR_DECLARE(apr_status_t) apr_os_shm_put(apr_shm_t **shm,
  445.                                          apr_os_shm_t *osshm,
  446.                                          apr_pool_t *cont); 
  447.  
  448.  
  449. #if APR_HAS_DSO || defined(DOXYGEN)
  450. /** 
  451.  * @defgroup apr_os_dso DSO (Dynamic Loading) Portabiliity Routines
  452.  * @{
  453.  */
  454. /**
  455.  * convert the dso handle from os specific to apr
  456.  * @param dso The apr handle we are converting to
  457.  * @param thedso the os specific handle to convert
  458.  * @param pool the pool to use if it is needed
  459.  */
  460. APR_DECLARE(apr_status_t) apr_os_dso_handle_put(apr_dso_handle_t **dso,
  461.                                                 apr_os_dso_handle_t thedso,
  462.                                                 apr_pool_t *pool);
  463.  
  464. /**
  465.  * convert the apr dso handle into an os specific one
  466.  * @param aprdso The apr dso handle to convert
  467.  * @param dso The os specific dso to return
  468.  */
  469. APR_DECLARE(apr_status_t) apr_os_dso_handle_get(apr_os_dso_handle_t *dso,
  470.                                                 apr_dso_handle_t *aprdso);
  471.  
  472. #if APR_HAS_OS_UUID
  473. /**
  474.  * Private: apr-util's apr_uuid module when supported by the platform
  475.  */
  476. APR_DECLARE(apr_status_t) apr_os_uuid_get(unsigned char *uuid_data);
  477. #endif
  478.  
  479. /** @} */
  480. #endif /* APR_HAS_DSO */
  481.  
  482.  
  483. /**
  484.  * Get the name of the system default characer set.
  485.  * @param pool the pool to allocate the name from, if needed
  486.  */
  487. APR_DECLARE(const char*) apr_os_default_encoding(apr_pool_t *pool);
  488.  
  489.  
  490. /**
  491.  * Get the name of the current locale character set.
  492.  * @param pool the pool to allocate the name from, if needed
  493.  * @remark Defers to apr_os_default_encoding if the current locale's
  494.  * data can't be retreved on this system.
  495.  */
  496. APR_DECLARE(const char*) apr_os_locale_encoding(apr_pool_t *pool);
  497.  
  498. /** @} */
  499.  
  500. #ifdef __cplusplus
  501. }
  502. #endif
  503.  
  504. #endif  /* ! APR_PORTABLE_H */
  505.