Make sure prototypes are always included, make some functions static and
[tprouty/samba.git] / lib / util / util.h
1 /* 
2    Unix SMB/CIFS implementation.
3    Utility functions for Samba
4    Copyright (C) Andrew Tridgell 1992-1999
5    Copyright (C) Jelmer Vernooij 2005
6     
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef _SAMBA_UTIL_H_
22 #define _SAMBA_UTIL_H_
23
24 #if _SAMBA_BUILD_ == 4
25 #include "lib/charset/charset.h"
26 #endif
27 #include "../lib/util/attr.h"
28
29 /* for TALLOC_CTX */
30 #include <talloc.h>
31
32 /**
33  * @file
34  * @brief Helpful macros
35  */
36
37 struct smbsrv_tcon;
38
39 extern const char *logfile;
40 extern const char *panic_action;
41
42 #include "../lib/util/time.h"
43 #include "../lib/util/data_blob.h"
44 #include "../lib/util/xfile.h"
45 #include "../lib/util/mutex.h"
46 #include "../lib/util/byteorder.h"
47
48 /**
49  * assert macros 
50  */
51 #define SMB_ASSERT(b) do { if (!(b)) { \
52         DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__)); \
53         smb_panic("assert failed"); }} while (0)
54
55 #if defined(VALGRIND)
56 #define strlen(x) valgrind_strlen(x)
57 #endif
58
59 #include "../lib/util/memory.h"
60
61 /**
62  * Write backtrace to debug log
63  */
64 _PUBLIC_ void call_backtrace(void);
65
66 /**
67  Something really nasty happened - panic !
68 **/
69 _PUBLIC_ _NORETURN_ void smb_panic(const char *why);
70
71 /**
72 setup our fault handlers
73 **/
74 _PUBLIC_ void fault_setup(const char *pname);
75
76 /**
77   register a fault handler. 
78   Should only be called once in the execution of smbd.
79 */
80 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
81
82 /* The following definitions come from lib/util/signal.c  */
83
84
85 /**
86  Block sigs.
87 **/
88 void BlockSignals(bool block, int signum);
89
90 /**
91  Catch a signal. This should implement the following semantics:
92
93  1) The handler remains installed after being called.
94  2) The signal should be blocked during handler execution.
95 **/
96 void (*CatchSignal(int signum,void (*handler)(int )))(int);
97
98 /**
99  Ignore SIGCLD via whatever means is necessary for this OS.
100 **/
101 void CatchChild(void);
102
103 /**
104  Catch SIGCLD but leave the child around so it's status can be reaped.
105 **/
106 void CatchChildLeaveStatus(void);
107
108 /* The following definitions come from lib/util/system.c  */
109
110
111 struct in_addr;
112
113 /**************************************************************************
114 A wrapper for gethostbyname() that tries avoids looking up hostnames 
115 in the root domain, which can cause dial-on-demand links to come up for no
116 apparent reason.
117 ****************************************************************************/
118 _PUBLIC_ struct hostent *sys_gethostbyname(const char *name);
119 _PUBLIC_ struct in_addr sys_inet_makeaddr(int net, int host);
120
121 /* The following definitions come from lib/util/genrand.c  */
122
123 /**
124  Copy any user given reseed data.
125 **/
126 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(void *, int *), void *);
127
128 /**
129  * Tell the random number generator it needs to reseed.
130  */
131 _PUBLIC_ void set_need_random_reseed(void);
132
133 /**
134  Interface to the (hopefully) good crypto random number generator.
135  Will use our internal PRNG if more than 40 bytes of random generation
136  has been requested, otherwise tries to read from /dev/random
137 **/
138 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
139
140 /**
141  Interface to the (hopefully) good crypto random number generator.
142  Will always use /dev/urandom if available.
143 **/
144 _PUBLIC_ void generate_secret_buffer(uint8_t *out, int len);
145
146 /**
147   generate a single random uint32_t
148 **/
149 _PUBLIC_ uint32_t generate_random(void);
150
151 /**
152   very basic password quality checker
153 **/
154 _PUBLIC_ bool check_password_quality(const char *s);
155
156 /**
157  Use the random number generator to generate a random string.
158 **/
159 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
160
161 /**
162  * Generate a random text string consisting of the specified length.
163  * The returned string will be allocated.
164  *
165  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
166  */
167 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
168
169 /* The following definitions come from lib/util/dprintf.c  */
170
171 _PUBLIC_ void d_set_iconv(smb_iconv_t);
172 _PUBLIC_ int d_vfprintf(FILE *f, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
173 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
174 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
175 _PUBLIC_ void display_set_stderr(void);
176
177 /* The following definitions come from lib/util/util_str.c  */
178
179
180 /**
181  Trim the specified elements off the front and back of a string.
182 **/
183 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
184
185 /**
186  Find the number of 'c' chars in a string
187 **/
188 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
189
190 /**
191  Safe string copy into a known length string. maxlength does not
192  include the terminating zero.
193 **/
194 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
195
196 /**
197  Safe string cat into a string. maxlength does not
198  include the terminating zero.
199 **/
200 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
201
202 /**
203  Routine to get hex characters and turn them into a 16 byte array.
204  the array can be variable length, and any non-hex-numeric
205  characters are skipped.  "0xnn" or "0Xnn" is specially catered
206  for.
207
208  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
209
210
211 **/
212 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
213
214 /** 
215  * Parse a hex string and return a data blob. 
216  */
217 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
218
219 /**
220  * Routine to print a buffer as HEX digits, into an allocated string.
221  */
222 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
223
224 /**
225  * talloc version of hex_encode()
226  */
227 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
228
229 /**
230  Substitute a string for a pattern in another string. Make sure there is 
231  enough room!
232
233  This routine looks for pattern in s and replaces it with 
234  insert. It may do multiple replacements.
235
236  Any of " ; ' $ or ` in the insert string are replaced with _
237  if len==0 then the string cannot be extended. This is different from the old
238  use of len==0 which was for no length checks to be done.
239 **/
240 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
241
242
243 _PUBLIC_ char *string_sub_talloc(TALLOC_CTX *mem_ctx, const char *s, 
244                                 const char *pattern, const char *insert);
245
246 /**
247  Similar to string_sub() but allows for any character to be substituted. 
248  Use with caution!
249  if len==0 then the string cannot be extended. This is different from the old
250  use of len==0 which was for no length checks to be done.
251 **/
252 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
253
254 /**
255  Unescape a URL encoded string, in place.
256 **/
257 _PUBLIC_ void rfc1738_unescape(char *buf);
258 size_t valgrind_strlen(const char *s);
259
260 /**
261   format a string into length-prefixed dotted domain format, as used in NBT
262   and in some ADS structures
263 **/
264 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
265
266 /**
267  * Add a string to an array of strings.
268  *
269  * num should be a pointer to an integer that holds the current 
270  * number of elements in strings. It will be updated by this function.
271  */
272 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
273                          const char *str, const char ***strings, int *num);
274
275 /**
276   varient of strcmp() that handles NULL ptrs
277 **/
278 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
279
280 /**
281 return the number of bytes occupied by a buffer in ASCII format
282 the result includes the null termination
283 limited by 'n' bytes
284 **/
285 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
286
287 /**
288  Return a string representing a CIFS attribute for a file.
289 **/
290 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib);
291
292 /**
293  Set a boolean variable from the text value stored in the passed string.
294  Returns true in success, false if the passed string does not correctly 
295  represent a boolean.
296 **/
297 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
298
299 /**
300  * Parse a string containing a boolean value.
301  *
302  * val will be set to the read value.
303  *
304  * @retval true if a boolean value was parsed, false otherwise.
305  */
306 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
307
308 /**
309  * Convert a size specification like 16K into an integral number of bytes. 
310  **/
311 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
312
313 /**
314  * Parse a uint64_t value from a string
315  *
316  * val will be set to the value read.
317  *
318  * @retval true if parsing was successful, false otherwise
319  */
320 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
321
322 /**
323 return the number of bytes occupied by a buffer in CH_UTF16 format
324 the result includes the null termination
325 **/
326 _PUBLIC_ size_t utf16_len(const void *buf);
327
328 /**
329 return the number of bytes occupied by a buffer in CH_UTF16 format
330 the result includes the null termination
331 limited by 'n' bytes
332 **/
333 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
334 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
335
336 /**
337 Do a case-insensitive, whitespace-ignoring string compare.
338 **/
339 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
340
341 /**
342  String replace.
343 **/
344 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
345
346 /**
347  * Compare 2 strings.
348  *
349  * @note The comparison is case-insensitive.
350  **/
351 _PUBLIC_ bool strequal(const char *s1, const char *s2);
352
353 /* The following definitions come from lib/util/util_strlist.c  */
354
355
356 /**
357   build a null terminated list of strings from a input string and a
358   separator list. The separator list must contain characters less than
359   or equal to 0x2f for this to work correctly on multi-byte strings
360 */
361 _PUBLIC_ char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
362
363 /**
364  * build a null terminated list of strings from an argv-like input string 
365  * Entries are seperated by spaces and can be enclosed by quotes. 
366  * Does NOT support escaping
367  */
368 _PUBLIC_ const char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
369
370 /**
371  * join a list back to one string 
372  */
373 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char seperator);
374
375 /** join a list back to one (shell-like) string; entries 
376  * seperated by spaces, using quotes where necessary */
377 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
378
379 /**
380   return the number of elements in a string list
381 */
382 _PUBLIC_ size_t str_list_length(const char * const *list);
383
384 /**
385   copy a string list
386 */
387 _PUBLIC_ char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
388
389 /**
390    Return true if all the elements of the list match exactly.
391  */
392 _PUBLIC_ bool str_list_equal(const char **list1, const char **list2);
393
394 /**
395   add an entry to a string list
396 */
397 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
398
399 /**
400   remove an entry from a string list
401 */
402 _PUBLIC_ void str_list_remove(const char **list, const char *s);
403
404 /**
405   return true if a string is in a list
406 */
407 _PUBLIC_ bool str_list_check(const char **list, const char *s);
408
409 /**
410   return true if a string is in a list, case insensitively
411 */
412 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
413
414 /* The following definitions come from lib/util/util_file.c  */
415
416
417 /**
418 read a line from a file with possible \ continuation chars. 
419 Blanks at the start or end of a line are stripped.
420 The string will be allocated if s2 is NULL
421 **/
422 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
423
424 /**
425  * Read one line (data until next newline or eof) and allocate it 
426  */
427 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
428
429 /**
430 load a file into memory from a fd.
431 **/
432 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
433
434
435 char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx);
436
437 /**
438 load a file into memory
439 **/
440 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
441
442 /**
443 mmap (if possible) or read a file
444 **/
445 _PUBLIC_ void *map_file(const char *fname, size_t size);
446
447 /**
448 load a file into memory and return an array of pointers to lines in the file
449 must be freed with talloc_free(). 
450 **/
451 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
452
453 /**
454 load a fd into memory and return an array of pointers to lines in the file
455 must be freed with talloc_free(). If convert is true calls unix_to_dos on
456 the list.
457 **/
458 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
459
460 /**
461 take a list of lines and modify them to produce a list where \ continues
462 a line
463 **/
464 _PUBLIC_ void file_lines_slashcont(char **lines);
465
466 /**
467   save a lump of data into a file. Mostly used for debugging 
468 */
469 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
470 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
471 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
472 _PUBLIC_ bool large_file_support(const char *path);
473
474 /* The following definitions come from lib/util/util.c  */
475
476
477 /**
478  Find a suitable temporary directory. The result should be copied immediately
479  as it may be overwritten by a subsequent call.
480 **/
481 _PUBLIC_ const char *tmpdir(void);
482
483 /**
484  Check if a file exists - call vfs_file_exist for samba files.
485 **/
486 _PUBLIC_ bool file_exist(const char *fname);
487
488 /**
489  Check a files mod time.
490 **/
491 _PUBLIC_ time_t file_modtime(const char *fname);
492
493 /**
494  Check if a directory exists.
495 **/
496 _PUBLIC_ bool directory_exist(const char *dname);
497
498 /**
499  * Try to create the specified directory if it didn't exist.
500  *
501  * @retval true if the directory already existed and has the right permissions 
502  * or was successfully created.
503  */
504 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid, 
505                                mode_t dir_perms);
506
507 /**
508  Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
509  else
510   if SYSV use O_NDELAY
511   if BSD use FNDELAY
512 **/
513 _PUBLIC_ int set_blocking(int fd, bool set);
514
515 /**
516  Sleep for a specified number of milliseconds.
517 **/
518 _PUBLIC_ void msleep(unsigned int t);
519
520 /**
521  Get my own name, return in malloc'ed storage.
522 **/
523 _PUBLIC_ char* get_myname(void);
524
525 /**
526  Return true if a string could be a pure IP address.
527 **/
528 _PUBLIC_ bool is_ipaddress(const char *str);
529
530 /**
531  Interpret an internet address or name into an IP address in 4 byte form.
532 **/
533 _PUBLIC_ uint32_t interpret_addr(const char *str);
534
535 /**
536  A convenient addition to interpret_addr().
537 **/
538 _PUBLIC_ struct in_addr interpret_addr2(const char *str);
539
540 /**
541  Check if an IP is the 0.0.0.0.
542 **/
543 _PUBLIC_ bool is_zero_ip(struct in_addr ip);
544
545 /**
546  Are two IPs on the same subnet?
547 **/
548 _PUBLIC_ bool same_net(struct in_addr ip1,struct in_addr ip2,struct in_addr mask);
549
550 /**
551  Check if a process exists. Does this work on all unixes?
552 **/
553 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
554
555 /**
556  Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
557  is dealt with in posix.c
558 **/
559 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
560
561 /**
562  * Write dump of binary data to the log file.
563  *
564  * The data is only written if the log level is at least level.
565  */
566 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
567
568 /**
569  * Write dump of binary data to the log file.
570  *
571  * The data is only written if the log level is at least level.
572  * 16 zero bytes in a row are ommited
573  */
574 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
575
576 /**
577  malloc that aborts with smb_panic on fail or zero size.
578 **/
579 _PUBLIC_ void *smb_xmalloc(size_t size);
580
581 /**
582  Memdup with smb_panic on fail.
583 **/
584 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
585
586 /**
587  strdup that aborts on malloc fail.
588 **/
589 _PUBLIC_ char *smb_xstrdup(const char *s);
590
591 char *smb_xstrndup(const char *s, size_t n);
592
593 /**
594  Like strdup but for memory.
595 **/
596 _PUBLIC_ void *memdup(const void *p, size_t size);
597
598 /**
599  * Write a password to the log file.
600  *
601  * @note Only actually does something if DEBUG_PASSWORD was defined during 
602  * compile-time.
603  */
604 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
605
606 /**
607  * see if a range of memory is all zero. A NULL pointer is considered
608  * to be all zero 
609  */
610 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
611
612 /**
613   realloc an array, checking for integer overflow in the array size
614 */
615 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
616
617 void *malloc_array(size_t el_size, unsigned int count);
618
619 /* The following definitions come from lib/util/fsusage.c  */
620
621
622 /**
623  * Retrieve amount of free disk space.
624  * this does all of the system specific guff to get the free disk space.
625  * It is derived from code in the GNU fileutils package, but has been
626  * considerably mangled for use here 
627  *
628  * results are returned in *dfree and *dsize, in 512 byte units
629 */
630 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
631
632 /* The following definitions come from lib/util/ms_fnmatch.c  */
633
634
635 /**
636  * @file
637  * @brief MS-style Filename matching
638  */
639
640 /* protocol types. It assumes that higher protocols include lower protocols
641    as subsets. FIXME: Move to one of the smb-specific headers */
642 enum protocol_types {
643         PROTOCOL_NONE,
644         PROTOCOL_CORE,
645         PROTOCOL_COREPLUS,
646         PROTOCOL_LANMAN1,
647         PROTOCOL_LANMAN2,
648         PROTOCOL_NT1,
649         PROTOCOL_SMB2
650 };
651
652 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
653
654 /** a generic fnmatch function - uses for non-CIFS pattern matching */
655 int gen_fnmatch(const char *pattern, const char *string);
656
657 /* The following definitions come from lib/util/mutex.c  */
658
659
660 /**
661   register a set of mutex/rwlock handlers. 
662   Should only be called once in the execution of smbd.
663 */
664 _PUBLIC_ bool register_mutex_handlers(const char *name, struct mutex_ops *ops);
665
666 /* The following definitions come from lib/util/idtree.c  */
667
668
669 /**
670   initialise a idr tree. The context return value must be passed to
671   all subsequent idr calls. To destroy the idr tree use talloc_free()
672   on this context
673  */
674 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
675
676 /**
677   allocate the next available id, and assign 'ptr' into its slot.
678   you can retrieve later this pointer using idr_find()
679 */
680 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
681
682 /**
683    allocate a new id, giving the first available value greater than or
684    equal to the given starting id
685 */
686 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
687
688 /**
689   allocate a new id randomly in the given range
690 */
691 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
692
693 /**
694   find a pointer value previously set with idr_get_new given an id
695 */
696 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
697
698 /**
699   remove an id from the idr tree
700 */
701 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
702
703 /* The following definitions come from lib/util/become_daemon.c  */
704
705 /**
706  Become a daemon, discarding the controlling terminal.
707 **/
708 _PUBLIC_ void become_daemon(bool fork);
709
710 /**
711  * Load a ini-style file.
712  */
713 bool pm_process( const char *fileName,
714                  bool (*sfunc)(const char *, void *),
715                  bool (*pfunc)(const char *, const char *, void *),
716                                  void *userdata);
717
718 /**
719  * Add-on to talloc_get_type
720  */
721 _PUBLIC_ void *talloc_check_name_abort(const void *ptr, const char *name);
722 #define talloc_get_type_abort(ptr, type) \
723         (type *)talloc_check_name_abort(ptr, #type)
724
725 bool unmap_file(void *start, size_t size);
726
727 void print_asc(int level, const uint8_t *buf,int len);
728
729 #endif /* _SAMBA_UTIL_H_ */