Apache Portable Runtime
|
00001 /* Licensed to the Apache Software Foundation (ASF) under one or more 00002 * contributor license agreements. See the NOTICE file distributed with 00003 * this work for additional information regarding copyright ownership. 00004 * The ASF licenses this file to You under the Apache License, Version 2.0 00005 * (the "License"); you may not use this file except in compliance with 00006 * the License. You may obtain a copy of the License at 00007 * 00008 * http://www.apache.org/licenses/LICENSE-2.0 00009 * 00010 * Unless required by applicable law or agreed to in writing, software 00011 * distributed under the License is distributed on an "AS IS" BASIS, 00012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00013 * See the License for the specific language governing permissions and 00014 * limitations under the License. 00015 */ 00016 00017 /* This header file is where you should put ANY platform specific information. 00018 * This should be the only header file that programs need to include that 00019 * actually has platform dependent code which refers to the . 00020 */ 00021 #ifndef APR_PORTABLE_H 00022 #define APR_PORTABLE_H 00023 /** 00024 * @file apr_portable.h 00025 * @brief APR Portability Routines 00026 */ 00027 00028 #include "apr.h" 00029 #include "apr_pools.h" 00030 #include "apr_thread_proc.h" 00031 #include "apr_file_io.h" 00032 #include "apr_network_io.h" 00033 #include "apr_errno.h" 00034 #include "apr_global_mutex.h" 00035 #include "apr_proc_mutex.h" 00036 #include "apr_time.h" 00037 #include "apr_dso.h" 00038 #include "apr_shm.h" 00039 00040 #if APR_HAVE_DIRENT_H 00041 #include <dirent.h> 00042 #endif 00043 #if APR_HAVE_FCNTL_H 00044 #include <fcntl.h> 00045 #endif 00046 #if APR_HAVE_PTHREAD_H 00047 #include <pthread.h> 00048 #endif 00049 #if APR_HAVE_SEMAPHORE_H 00050 #include <semaphore.h> 00051 #endif 00052 00053 #ifdef __cplusplus 00054 extern "C" { 00055 #endif /* __cplusplus */ 00056 00057 /** 00058 * @defgroup apr_portabile Portability Routines 00059 * @ingroup APR 00060 * @{ 00061 */ 00062 00063 #ifdef WIN32 00064 /* The primitives for Windows types */ 00065 typedef HANDLE apr_os_file_t; 00066 typedef HANDLE apr_os_dir_t; 00067 typedef SOCKET apr_os_sock_t; 00068 typedef HANDLE apr_os_proc_mutex_t; 00069 typedef HANDLE apr_os_thread_t; 00070 typedef HANDLE apr_os_proc_t; 00071 typedef DWORD apr_os_threadkey_t; 00072 typedef FILETIME apr_os_imp_time_t; 00073 typedef SYSTEMTIME apr_os_exp_time_t; 00074 typedef HANDLE apr_os_dso_handle_t; 00075 typedef HANDLE apr_os_shm_t; 00076 00077 #elif defined(OS2) 00078 typedef HFILE apr_os_file_t; 00079 typedef HDIR apr_os_dir_t; 00080 typedef int apr_os_sock_t; 00081 typedef HMTX apr_os_proc_mutex_t; 00082 typedef TID apr_os_thread_t; 00083 typedef PID apr_os_proc_t; 00084 typedef PULONG apr_os_threadkey_t; 00085 typedef struct timeval apr_os_imp_time_t; 00086 typedef struct tm apr_os_exp_time_t; 00087 typedef HMODULE apr_os_dso_handle_t; 00088 typedef void* apr_os_shm_t; 00089 00090 #elif defined(__BEOS__) 00091 #include <kernel/OS.h> 00092 #include <kernel/image.h> 00093 00094 struct apr_os_proc_mutex_t { 00095 sem_id sem; 00096 int32 ben; 00097 }; 00098 00099 typedef int apr_os_file_t; 00100 typedef DIR apr_os_dir_t; 00101 typedef int apr_os_sock_t; 00102 typedef struct apr_os_proc_mutex_t apr_os_proc_mutex_t; 00103 typedef thread_id apr_os_thread_t; 00104 typedef thread_id apr_os_proc_t; 00105 typedef int apr_os_threadkey_t; 00106 typedef struct timeval apr_os_imp_time_t; 00107 typedef struct tm apr_os_exp_time_t; 00108 typedef image_id apr_os_dso_handle_t; 00109 typedef void* apr_os_shm_t; 00110 00111 #elif defined(NETWARE) 00112 typedef int apr_os_file_t; 00113 typedef DIR apr_os_dir_t; 00114 typedef int apr_os_sock_t; 00115 typedef NXMutex_t apr_os_proc_mutex_t; 00116 typedef NXThreadId_t apr_os_thread_t; 00117 typedef long apr_os_proc_t; 00118 typedef NXKey_t apr_os_threadkey_t; 00119 typedef struct timeval apr_os_imp_time_t; 00120 typedef struct tm apr_os_exp_time_t; 00121 typedef void * apr_os_dso_handle_t; 00122 typedef void* apr_os_shm_t; 00123 00124 #else 00125 /* Any other OS should go above this one. This is the lowest common 00126 * denominator typedefs for all UNIX-like systems. :) 00127 */ 00128 00129 /** Basic OS process mutex structure. */ 00130 struct apr_os_proc_mutex_t { 00131 #if APR_HAS_SYSVSEM_SERIALIZE || APR_HAS_FCNTL_SERIALIZE || APR_HAS_FLOCK_SERIALIZE 00132 /** Value used for SYS V Semaphore, FCNTL and FLOCK serialization */ 00133 int crossproc; 00134 #endif 00135 #if APR_HAS_PROC_PTHREAD_SERIALIZE 00136 /** Value used for PTHREAD serialization */ 00137 pthread_mutex_t *pthread_interproc; 00138 #endif 00139 #if APR_HAS_THREADS 00140 /* If no threads, no need for thread locks */ 00141 #if APR_USE_PTHREAD_SERIALIZE 00142 /** This value is currently unused within APR and Apache */ 00143 pthread_mutex_t *intraproc; 00144 #endif 00145 #endif 00146 #if APR_HAS_POSIXSEM_SERIALIZE 00147 /** Value used for POSIX semaphores serialization */ 00148 sem_t *psem_interproc; 00149 #endif 00150 }; 00151 00152 typedef int apr_os_file_t; /**< native file */ 00153 typedef DIR apr_os_dir_t; /**< native dir */ 00154 typedef int apr_os_sock_t; /**< native dir */ 00155 typedef struct apr_os_proc_mutex_t apr_os_proc_mutex_t; /**< native process 00156 * mutex 00157 */ 00158 #if APR_HAS_THREADS && APR_HAVE_PTHREAD_H 00159 typedef pthread_t apr_os_thread_t; /**< native thread */ 00160 typedef pthread_key_t apr_os_threadkey_t; /**< native thread address 00161 * space */ 00162 #endif 00163 typedef pid_t apr_os_proc_t; /**< native pid */ 00164 typedef struct timeval apr_os_imp_time_t; /**< native timeval */ 00165 typedef struct tm apr_os_exp_time_t; /**< native tm */ 00166 /** @var apr_os_dso_handle_t 00167 * native dso types 00168 */ 00169 #if defined(HPUX) || defined(HPUX10) || defined(HPUX11) 00170 #include <dl.h> 00171 typedef shl_t apr_os_dso_handle_t; 00172 #elif defined(DARWIN) 00173 #include <mach-o/dyld.h> 00174 typedef NSModule apr_os_dso_handle_t; 00175 #else 00176 typedef void * apr_os_dso_handle_t; 00177 #endif 00178 typedef void* apr_os_shm_t; /**< native SHM */ 00179 00180 #endif 00181 00182 /** 00183 * @typedef apr_os_sock_info_t 00184 * @brief alias for local OS socket 00185 */ 00186 /** 00187 * everything APR needs to know about an active socket to construct 00188 * an APR socket from it; currently, this is platform-independent 00189 */ 00190 struct apr_os_sock_info_t { 00191 apr_os_sock_t *os_sock; /**< always required */ 00192 struct sockaddr *local; /**< NULL if not yet bound */ 00193 struct sockaddr *remote; /**< NULL if not connected */ 00194 int family; /**< always required (APR_INET, APR_INET6, etc.) */ 00195 int type; /**< always required (SOCK_STREAM, SOCK_DGRAM, etc.) */ 00196 int protocol; /**< 0 or actual protocol (APR_PROTO_SCTP, APR_PROTO_TCP, etc.) */ 00197 }; 00198 00199 typedef struct apr_os_sock_info_t apr_os_sock_info_t; 00200 00201 #if APR_PROC_MUTEX_IS_GLOBAL || defined(DOXYGEN) 00202 /** Opaque global mutex type */ 00203 #define apr_os_global_mutex_t apr_os_proc_mutex_t 00204 /** @return apr_os_global_mutex */ 00205 #define apr_os_global_mutex_get apr_os_proc_mutex_get 00206 #else 00207 /** Thread and process mutex for those platforms where process mutexes 00208 * are not held in threads. 00209 */ 00210 struct apr_os_global_mutex_t { 00211 apr_pool_t *pool; 00212 apr_proc_mutex_t *proc_mutex; 00213 #if APR_HAS_THREADS 00214 apr_thread_mutex_t *thread_mutex; 00215 #endif /* APR_HAS_THREADS */ 00216 }; 00217 typedef struct apr_os_global_mutex_t apr_os_global_mutex_t; 00218 00219 APR_DECLARE(apr_status_t) apr_os_global_mutex_get(apr_os_global_mutex_t *ospmutex, 00220 apr_global_mutex_t *pmutex); 00221 #endif 00222 00223 00224 /** 00225 * convert the file from apr type to os specific type. 00226 * @param thefile The os specific file we are converting to 00227 * @param file The apr file to convert. 00228 * @remark On Unix, it is only possible to get a file descriptor from 00229 * an apr file type. 00230 */ 00231 APR_DECLARE(apr_status_t) apr_os_file_get(apr_os_file_t *thefile, 00232 apr_file_t *file); 00233 00234 /** 00235 * convert the dir from apr type to os specific type. 00236 * @param thedir The os specific dir we are converting to 00237 * @param dir The apr dir to convert. 00238 */ 00239 APR_DECLARE(apr_status_t) apr_os_dir_get(apr_os_dir_t **thedir, 00240 apr_dir_t *dir); 00241 00242 /** 00243 * Convert the socket from an apr type to an OS specific socket 00244 * @param thesock The socket to convert. 00245 * @param sock The os specific equivalent of the apr socket.. 00246 */ 00247 APR_DECLARE(apr_status_t) apr_os_sock_get(apr_os_sock_t *thesock, 00248 apr_socket_t *sock); 00249 00250 /** 00251 * Convert the proc mutex from apr type to os specific type 00252 * @param ospmutex The os specific proc mutex we are converting to. 00253 * @param pmutex The apr proc mutex to convert. 00254 */ 00255 APR_DECLARE(apr_status_t) apr_os_proc_mutex_get(apr_os_proc_mutex_t *ospmutex, 00256 apr_proc_mutex_t *pmutex); 00257 00258 /** 00259 * Convert the proc mutex from apr type to os specific type, also 00260 * providing the mechanism used by the apr mutex. 00261 * @param ospmutex The os specific proc mutex we are converting to. 00262 * @param pmutex The apr proc mutex to convert. 00263 * @param mech The mechanism used by the apr proc mutex (if not NULL). 00264 * @remark Allows for disambiguation for platforms with multiple mechanisms 00265 * available. 00266 */ 00267 APR_DECLARE(apr_status_t) apr_os_proc_mutex_get_ex(apr_os_proc_mutex_t *ospmutex, 00268 apr_proc_mutex_t *pmutex, 00269 apr_lockmech_e *mech); 00270 00271 /** 00272 * Get the exploded time in the platforms native format. 00273 * @param ostime the native time format 00274 * @param aprtime the time to convert 00275 */ 00276 APR_DECLARE(apr_status_t) apr_os_exp_time_get(apr_os_exp_time_t **ostime, 00277 apr_time_exp_t *aprtime); 00278 00279 /** 00280 * Get the imploded time in the platforms native format. 00281 * @param ostime the native time format 00282 * @param aprtime the time to convert 00283 */ 00284 APR_DECLARE(apr_status_t) apr_os_imp_time_get(apr_os_imp_time_t **ostime, 00285 apr_time_t *aprtime); 00286 00287 /** 00288 * convert the shm from apr type to os specific type. 00289 * @param osshm The os specific shm representation 00290 * @param shm The apr shm to convert. 00291 */ 00292 APR_DECLARE(apr_status_t) apr_os_shm_get(apr_os_shm_t *osshm, 00293 apr_shm_t *shm); 00294 00295 #if APR_HAS_THREADS || defined(DOXYGEN) 00296 /** 00297 * @defgroup apr_os_thread Thread portability Routines 00298 * @{ 00299 */ 00300 /** 00301 * convert the thread to os specific type from apr type. 00302 * @param thethd The apr thread to convert 00303 * @param thd The os specific thread we are converting to 00304 */ 00305 APR_DECLARE(apr_status_t) apr_os_thread_get(apr_os_thread_t **thethd, 00306 apr_thread_t *thd); 00307 00308 /** 00309 * convert the thread private memory key to os specific type from an apr type. 00310 * @param thekey The apr handle we are converting from. 00311 * @param key The os specific handle we are converting to. 00312 */ 00313 APR_DECLARE(apr_status_t) apr_os_threadkey_get(apr_os_threadkey_t *thekey, 00314 apr_threadkey_t *key); 00315 00316 /** 00317 * convert the thread from os specific type to apr type. 00318 * @param thd The apr thread we are converting to. 00319 * @param thethd The os specific thread to convert 00320 * @param cont The pool to use if it is needed. 00321 */ 00322 APR_DECLARE(apr_status_t) apr_os_thread_put(apr_thread_t **thd, 00323 apr_os_thread_t *thethd, 00324 apr_pool_t *cont); 00325 00326 /** 00327 * convert the thread private memory key from os specific type to apr type. 00328 * @param key The apr handle we are converting to. 00329 * @param thekey The os specific handle to convert 00330 * @param cont The pool to use if it is needed. 00331 */ 00332 APR_DECLARE(apr_status_t) apr_os_threadkey_put(apr_threadkey_t **key, 00333 apr_os_threadkey_t *thekey, 00334 apr_pool_t *cont); 00335 /** 00336 * Get the thread ID 00337 */ 00338 APR_DECLARE(apr_os_thread_t) apr_os_thread_current(void); 00339 00340 /** 00341 * Compare two thread id's 00342 * @param tid1 1st Thread ID to compare 00343 * @param tid2 2nd Thread ID to compare 00344 * @return non-zero if the two threads are equal, zero otherwise 00345 */ 00346 APR_DECLARE(int) apr_os_thread_equal(apr_os_thread_t tid1, 00347 apr_os_thread_t tid2); 00348 00349 /** @} */ 00350 #endif /* APR_HAS_THREADS */ 00351 00352 /** 00353 * convert the file from os specific type to apr type. 00354 * @param file The apr file we are converting to. 00355 * @param thefile The os specific file to convert 00356 * @param flags The flags that were used to open this file. 00357 * @param cont The pool to use if it is needed. 00358 * @remark On Unix, it is only possible to put a file descriptor into 00359 * an apr file type. 00360 */ 00361 APR_DECLARE(apr_status_t) apr_os_file_put(apr_file_t **file, 00362 apr_os_file_t *thefile, 00363 apr_int32_t flags, apr_pool_t *cont); 00364 00365 /** 00366 * convert the file from os specific type to apr type. 00367 * @param file The apr file we are converting to. 00368 * @param thefile The os specific pipe to convert 00369 * @param cont The pool to use if it is needed. 00370 * @remark On Unix, it is only possible to put a file descriptor into 00371 * an apr file type. 00372 */ 00373 APR_DECLARE(apr_status_t) apr_os_pipe_put(apr_file_t **file, 00374 apr_os_file_t *thefile, 00375 apr_pool_t *cont); 00376 00377 /** 00378 * convert the file from os specific type to apr type. 00379 * @param file The apr file we are converting to. 00380 * @param thefile The os specific pipe to convert 00381 * @param register_cleanup A cleanup will be registered on the apr_file_t 00382 * to issue apr_file_close(). 00383 * @param cont The pool to use if it is needed. 00384 * @remark On Unix, it is only possible to put a file descriptor into 00385 * an apr file type. 00386 */ 00387 APR_DECLARE(apr_status_t) apr_os_pipe_put_ex(apr_file_t **file, 00388 apr_os_file_t *thefile, 00389 int register_cleanup, 00390 apr_pool_t *cont); 00391 00392 /** 00393 * convert the dir from os specific type to apr type. 00394 * @param dir The apr dir we are converting to. 00395 * @param thedir The os specific dir to convert 00396 * @param cont The pool to use when creating to apr directory. 00397 */ 00398 APR_DECLARE(apr_status_t) apr_os_dir_put(apr_dir_t **dir, 00399 apr_os_dir_t *thedir, 00400 apr_pool_t *cont); 00401 00402 /** 00403 * Convert a socket from the os specific type to the APR type. If 00404 * sock points to NULL, a socket will be created from the pool 00405 * provided. If **sock does not point to NULL, the structure pointed 00406 * to by sock will be reused and updated with the given socket. 00407 * @param sock The pool to use. 00408 * @param thesock The socket to convert to. 00409 * @param cont The socket we are converting to an apr type. 00410 * @remark If it is a true socket, it is best to call apr_os_sock_make() 00411 * and provide APR with more information about the socket. 00412 */ 00413 APR_DECLARE(apr_status_t) apr_os_sock_put(apr_socket_t **sock, 00414 apr_os_sock_t *thesock, 00415 apr_pool_t *cont); 00416 00417 /** 00418 * Create a socket from an existing descriptor and local and remote 00419 * socket addresses. 00420 * @param apr_sock The new socket that has been set up 00421 * @param os_sock_info The os representation of the socket handle and 00422 * other characteristics of the socket 00423 * @param cont The pool to use 00424 * @remark If you only know the descriptor/handle or if it isn't really 00425 * a true socket, use apr_os_sock_put() instead. 00426 */ 00427 APR_DECLARE(apr_status_t) apr_os_sock_make(apr_socket_t **apr_sock, 00428 apr_os_sock_info_t *os_sock_info, 00429 apr_pool_t *cont); 00430 00431 /** 00432 * Convert the proc mutex from os specific type to apr type 00433 * @param pmutex The apr proc mutex we are converting to. 00434 * @param ospmutex The os specific proc mutex to convert. 00435 * @param cont The pool to use if it is needed. 00436 */ 00437 APR_DECLARE(apr_status_t) apr_os_proc_mutex_put(apr_proc_mutex_t **pmutex, 00438 apr_os_proc_mutex_t *ospmutex, 00439 apr_pool_t *cont); 00440 00441 /** 00442 * Convert the proc mutex from os specific type to apr type, using the 00443 * specified mechanism. 00444 * @param pmutex The apr proc mutex we are converting to. 00445 * @param ospmutex The os specific proc mutex to convert. 00446 * @param mech The apr mutex locking mechanism 00447 * @param register_cleanup Whether to destroy the os mutex with the apr 00448 * one (either on explicit destroy or pool cleanup). 00449 * @param cont The pool to use if it is needed. 00450 * @remark Allows for disambiguation for platforms with multiple mechanisms 00451 * available. 00452 */ 00453 APR_DECLARE(apr_status_t) apr_os_proc_mutex_put_ex(apr_proc_mutex_t **pmutex, 00454 apr_os_proc_mutex_t *ospmutex, 00455 apr_lockmech_e mech, 00456 int register_cleanup, 00457 apr_pool_t *cont); 00458 00459 /** 00460 * Put the imploded time in the APR format. 00461 * @param aprtime the APR time format 00462 * @param ostime the time to convert 00463 * @param cont the pool to use if necessary 00464 */ 00465 APR_DECLARE(apr_status_t) apr_os_imp_time_put(apr_time_t *aprtime, 00466 apr_os_imp_time_t **ostime, 00467 apr_pool_t *cont); 00468 00469 /** 00470 * Put the exploded time in the APR format. 00471 * @param aprtime the APR time format 00472 * @param ostime the time to convert 00473 * @param cont the pool to use if necessary 00474 */ 00475 APR_DECLARE(apr_status_t) apr_os_exp_time_put(apr_time_exp_t *aprtime, 00476 apr_os_exp_time_t **ostime, 00477 apr_pool_t *cont); 00478 00479 /** 00480 * convert the shared memory from os specific type to apr type. 00481 * @param shm The apr shm representation of osshm 00482 * @param osshm The os specific shm identity 00483 * @param cont The pool to use if it is needed. 00484 * @remark On fork()ed architectures, this is typically nothing more than 00485 * the memory block mapped. On non-fork architectures, this is typically 00486 * some internal handle to pass the mapping from process to process. 00487 */ 00488 APR_DECLARE(apr_status_t) apr_os_shm_put(apr_shm_t **shm, 00489 apr_os_shm_t *osshm, 00490 apr_pool_t *cont); 00491 00492 00493 #if APR_HAS_DSO || defined(DOXYGEN) 00494 /** 00495 * @defgroup apr_os_dso DSO (Dynamic Loading) Portability Routines 00496 * @{ 00497 */ 00498 /** 00499 * convert the dso handle from os specific to apr 00500 * @param dso The apr handle we are converting to 00501 * @param thedso the os specific handle to convert 00502 * @param pool the pool to use if it is needed 00503 */ 00504 APR_DECLARE(apr_status_t) apr_os_dso_handle_put(apr_dso_handle_t **dso, 00505 apr_os_dso_handle_t thedso, 00506 apr_pool_t *pool); 00507 00508 /** 00509 * convert the apr dso handle into an os specific one 00510 * @param aprdso The apr dso handle to convert 00511 * @param dso The os specific dso to return 00512 */ 00513 APR_DECLARE(apr_status_t) apr_os_dso_handle_get(apr_os_dso_handle_t *dso, 00514 apr_dso_handle_t *aprdso); 00515 00516 /** @} */ 00517 #endif /* APR_HAS_DSO */ 00518 00519 00520 #if APR_HAS_OS_UUID 00521 /** 00522 * Private: apr-util's apr_uuid module when supported by the platform 00523 */ 00524 APR_DECLARE(apr_status_t) apr_os_uuid_get(unsigned char *uuid_data); 00525 #endif 00526 00527 00528 /** 00529 * Get the name of the system default character set. 00530 * @param pool the pool to allocate the name from, if needed 00531 */ 00532 APR_DECLARE(const char*) apr_os_default_encoding(apr_pool_t *pool); 00533 00534 00535 /** 00536 * Get the name of the current locale character set. 00537 * @param pool the pool to allocate the name from, if needed 00538 * @remark Defers to apr_os_default_encoding if the current locale's 00539 * data can't be retrieved on this system. 00540 */ 00541 APR_DECLARE(const char*) apr_os_locale_encoding(apr_pool_t *pool); 00542 00543 /** @} */ 00544 00545 #ifdef __cplusplus 00546 } 00547 #endif 00548 00549 #endif /* ! APR_PORTABLE_H */