nginx/src/core/ngx_string.h

   1
   2 /*
   3  * Copyright (C) Igor Sysoev
   4  */
   5
   6
   7 #ifndef _NGX_STRING_H_INCLUDED_
   8 #define _NGX_STRING_H_INCLUDED_
   9
  10
  11 #include <ngx_config.h>
  12 #include <ngx_core.h>
  13
  14
  15 typedef struct {
  16     size_t      len;
  17     u_char     *data;
  18 } ngx_str_t;
  19
  20
  21 typedef struct {
  22     ngx_str_t   key;
  23     ngx_str_t   value;
  24 } ngx_keyval_t;
  25
  26
  27 typedef struct {
  28     unsigned    len:28;
  29
  30     unsigned    valid:1;
  31     unsigned    no_cacheable:1;
  32     unsigned    not_found:1;
  33     unsigned    escape:1;
  34
  35     u_char     *data;
  36 } ngx_variable_value_t;
  37
  38
  39 #define ngx_string(str)     { sizeof(str) - 1, (u_char *) str }
  40 #define ngx_null_string     { 0, NULL }
  41
  42
  43 #define ngx_tolower(c)      (u_char) ((c >= 'A' && c <= 'Z') ? (c | 0x20) : c)
  44 #define ngx_toupper(c)      (u_char) ((c >= 'a' && c <= 'z') ? (c & ~0x20) : c)
  45
  46 void ngx_strlow(u_char *dst, u_char *src, size_t n);
  47
  48
  49 #define ngx_strncmp(s1, s2, n)  strncmp((const char *) s1, (const char *) s2, n)
  50
  51
  52 /* msvc and icc7 compile strcmp() to inline loop */
  53 #define ngx_strcmp(s1, s2)  strcmp((const char *) s1, (const char *) s2)
  54
  55
  56 #define ngx_strstr(s1, s2)  strstr((const char *) s1, (const char *) s2)
  57 #define ngx_strlen(s)       strlen((const char *) s)
  58
  59 #define ngx_strchr(s1, c)   strchr((const char *) s1, (int) c)
  60
  61 static ngx_inline u_char *
  62 ngx_strlchr(u_char *p, u_char *last, u_char c)
  63 {
  64     while (p < last) {
  65
  66         if (*p == c) {
  67             return p;
  68         }
  69
  70         p++;
  71     }
  72
  73     return NULL;
  74 }
  75
  76
  77 /*
  78  * msvc and icc7 compile memset() to the inline "rep stos"
  79  * while ZeroMemory() and bzero() are the calls.
  80  * icc7 may also inline several mov's of a zeroed register for small blocks.
  81  */
  82 #define ngx_memzero(buf, n)       (void) memset(buf, 0, n)
  83 #define ngx_memset(buf, c, n)     (void) memset(buf, c, n)
  84
  85
  86 #if (NGX_MEMCPY_LIMIT)
  87
  88 void *ngx_memcpy(void *dst, void *src, size_t n);
  89 #define ngx_cpymem(dst, src, n)   ((u_char *) ngx_memcpy(dst, src, n)) + (n)
  90
  91 #else
  92
  93 /*
  94  * gcc3, msvc, and icc7 compile memcpy() to the inline "rep movs".
  95  * gcc3 compiles memcpy(d, s, 4) to the inline "mov"es.
  96  * icc8 compile memcpy(d, s, 4) to the inline "mov"es or XMM moves.
  97  */
  98 #define ngx_memcpy(dst, src, n)   (void) memcpy(dst, src, n)
  99 #define ngx_cpymem(dst, src, n)   ((u_char *) memcpy(dst, src, n)) + (n)
 100
 101 #endif
 102
 103
 104 #if ( __INTEL_COMPILER >= 800 )
 105
 106 /*
 107  * the simple inline cycle copies the variable length strings up to 16
 108  * bytes faster than icc8 autodetecting _intel_fast_memcpy()
 109  */
 110
 111 static ngx_inline u_char *
 112 ngx_copy(u_char *dst, u_char *src, size_t len)
 113 {
 114     if (len < 17) {
 115
 116         while (len) {
 117             *dst++ = *src++;
 118             len--;
 119         }
 120
 121         return dst;
 122
 123     } else {
 124         return ngx_cpymem(dst, src, len);
 125     }
 126 }
 127
 128 #else
 129
 130 #define ngx_copy                  ngx_cpymem
 131
 132 #endif
 133
 134
 135 /* msvc and icc7 compile memcmp() to the inline loop */
 136 #define ngx_memcmp(s1, s2, n)  memcmp((const char *) s1, (const char *) s2, n)
 137
 138
 139 u_char *ngx_cpystrn(u_char *dst, u_char *src, size_t n);
 140 u_char *ngx_pstrdup(ngx_pool_t *pool, ngx_str_t *src);
 141 u_char * ngx_cdecl ngx_sprintf(u_char *buf, const char *fmt, ...);
 142 u_char * ngx_cdecl ngx_snprintf(u_char *buf, size_t max, const char *fmt, ...);
 143 u_char *ngx_vsnprintf(u_char *buf, size_t max, const char *fmt, va_list args);
 144
 145 ngx_int_t ngx_strcasecmp(u_char *s1, u_char *s2);
 146 ngx_int_t ngx_strncasecmp(u_char *s1, u_char *s2, size_t n);
 147
 148 u_char *ngx_strnstr(u_char *s1, char *s2, size_t n);
 149
 150 u_char *ngx_strstrn(u_char *s1, char *s2, size_t n);
 151 u_char *ngx_strcasestrn(u_char *s1, char *s2, size_t n);
 152
 153 ngx_int_t ngx_rstrncmp(u_char *s1, u_char *s2, size_t n);
 154 ngx_int_t ngx_rstrncasecmp(u_char *s1, u_char *s2, size_t n);
 155 ngx_int_t ngx_memn2cmp(u_char *s1, u_char *s2, size_t n1, size_t n2);
 156
 157 ngx_int_t ngx_atoi(u_char *line, size_t n);
 158 ssize_t ngx_atosz(u_char *line, size_t n);
 159 off_t ngx_atoof(u_char *line, size_t n);
 160 time_t ngx_atotm(u_char *line, size_t n);
 161 ngx_int_t ngx_hextoi(u_char *line, size_t n);
 162
 163 u_char *ngx_hex_dump(u_char *dst, u_char *src, size_t len);
 164
 165
 166 #define ngx_base64_encoded_length(len)  (((len + 2) / 3) * 4)
 167 #define ngx_base64_decoded_length(len)  (((len + 3) / 4) * 3)
 168
 169 void ngx_encode_base64(ngx_str_t *dst, ngx_str_t *src);
 170 ngx_int_t ngx_decode_base64(ngx_str_t *dst, ngx_str_t *src);
 171
 172 uint32_t ngx_utf8_decode(u_char **p, size_t n);
 173 size_t ngx_utf8_length(u_char *p, size_t n);
 174 u_char *ngx_utf8_cpystrn(u_char *dst, u_char *src, size_t n, size_t len);
 175
 176
 177 #define NGX_ESCAPE_URI         0
 178 #define NGX_ESCAPE_ARGS        1
 179 #define NGX_ESCAPE_HTML        2
 180 #define NGX_ESCAPE_REFRESH     3
 181 #define NGX_ESCAPE_MEMCACHED   4
 182 #define NGX_ESCAPE_MAIL_AUTH   5
 183
 184 #define NGX_UNESCAPE_URI       1
 185 #define NGX_UNESCAPE_REDIRECT  2
 186
 187 uintptr_t ngx_escape_uri(u_char *dst, u_char *src, size_t size,
 188     ngx_uint_t type);
 189 void ngx_unescape_uri(u_char **dst, u_char **src, size_t size, ngx_uint_t type);
 190 uintptr_t ngx_escape_html(u_char *dst, u_char *src, size_t size);
 191
 192
 193
 194 void ngx_sort(void *base, size_t n, size_t size,
 195     ngx_int_t (*cmp)(const void *, const void *));
 196 #define ngx_qsort             qsort
 197
 198
 199 #define ngx_value_helper(n)   #n
 200 #define ngx_value(n)          ngx_value_helper(n)
 201
 202
 203 #endif /* _NGX_STRING_H_INCLUDED_ */