Files
@ d0a14f973771
Branch filter:
Location: vmkdrivers/BLD/build/HEADERS/vmkapi-current-all-public/vmkernel64/release/lib/vmkapi_libc.h
d0a14f973771
18.2 KiB
text/x-chdr
ESXi-5.0-U1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 | /* **********************************************************
* Copyright 2004 - 2009 VMware, Inc. All rights reserved.
* **********************************************************/
/*
* @VMKAPIMOD_LICENSE@
*/
/*
***********************************************************************
* LibC */ /**
* \addtogroup Lib
* @{
* \defgroup LibC C-Library-Style Interfaces
*
* @{
***********************************************************************
*/
#ifndef _VMKAPI_LIBC_H_
#define _VMKAPI_LIBC_H_
/** \cond never */
#ifndef VMK_HEADER_INCLUDED_FROM_VMKAPI_H
#error This vmkapi file should never be included directly but only via vmkapi.h
#endif
/** \endcond never */
#include <stdarg.h>
/*
***********************************************************************
* vmk_Strnlen -- */ /**
*
* \brief Determine the length of a string up to a maximum number
* of bytes.
*
* \note This function will not block.
*
* \param[in] src String whose length is to be determined.
* \param[in] maxLen Maximum number of bytes to check.
*
* \return Length of the string in bytes.
*
***********************************************************************
*/
vmk_ByteCount vmk_Strnlen (
const char *src,
vmk_ByteCount maxLen);
/*
***********************************************************************
* vmk_Strcpy -- */ /**
*
* \brief Copy a string.
*
* \note This function will not block.
*
* \deprecated Use vmk_StringCopy() instead.
*
* \param[out] dst String to copy to.
* \param[in] src String to copy from.
*
* \return Pointer to src.
*
***********************************************************************
*/
char *vmk_Strcpy(
char *dst,
const char *src);
/*
***********************************************************************
* vmk_Strncpy -- */ /**
*
* \brief Copy a string up to a maximum number of bytes.
*
* \note This function will not block.
*
* \deprecated Use vmk_StringCopy() instead.
*
* \param[out] dst String to copy to.
* \param[in] src String to copy from.
* \param[in] maxLen Maximum number of bytes to copy into dst.
*
* \warning A copied string is not automatically nul-terminated.
* Users should take care to ensure that the destination
* is large enough to hold the string and the nul-terminator.
*
* \return Pointer src.
*
***********************************************************************
*/
char *vmk_Strncpy(
char *dst,
const char *src,
vmk_ByteCount maxLen);
/*
***********************************************************************
* vmk_Strlcpy -- */ /**
*
* \brief Copy a string and ensure nul termination.
*
* \note This function will not block.
*
* \deprecated Use vmk_StringLCopy() instead.
*
* \param[out] dst String to copy to.
* \param[in] src String to copy from.
* \param[in] size Maximum number of bytes to store a string in dst.
*
* \note At most size-1 bytes will be copied. All copies will
* be terminated with a nul unless size is set to zero.
*
* \return The length of src. If the return value is greater than
* or equal to size, then truncation has occured during
* the copy.
*
***********************************************************************
*/
vmk_ByteCount vmk_Strlcpy(
char *dst,
const char *src,
vmk_ByteCount size);
/*
***********************************************************************
* vmk_Strcmp -- */ /**
*
* \brief Compare two strings.
*
* \note This function will not block.
*
* \param[in] src1 First string to compare.
* \param[in] src2 Second string to compare.
*
* \return A value greater than, less than or equal to 0 depending on
* the lexicographical difference between the strings.
*
***********************************************************************
*/
int vmk_Strcmp(
const char *src1,
const char *src2);
/*
***********************************************************************
* vmk_Strncmp -- */ /**
*
* \brief Compare two strings up to a maximum number of bytes.
*
* \note This function will not block.
*
* \param[in] src1 First string to compare.
* \param[in] src2 Second string to compare.
* \param[in] maxLen Maximum number of bytes to compare.
*
* \return A value greater than, less than or equal to 0 depending on
* the lexicographical difference between the strings.
*
***********************************************************************
*/
int vmk_Strncmp(
const char *src1,
const char *src2,
vmk_ByteCount maxLen);
/*
***********************************************************************
* vmk_Strncasecmp -- */ /**
*
* \brief Compare two strings while disregarding case.
*
* \note This function will not block.
*
* \param[in] src1 First string to compare.
* \param[in] src2 Second string to compare.
* \param[in] maxLen Maximum number of bytes to compare.
*
* \return A value greater than, less than or equal to 0 depending on
* the lexicographical difference between the strings as if
* all characters in the string are lower-case.
*
***********************************************************************
*/
int vmk_Strncasecmp(
const char *src1,
const char *src2,
vmk_ByteCount maxLen);
/*
***********************************************************************
* vmk_Strchr -- */ /**
*
* \brief Forward search through a string for a character.
*
* \note This function will not block.
*
* \param[in] src String to search forward.
* \param[in] c Character to search for.
*
* \return Pointer to the offset in src where c was found or NULL
* if c was not found in src.
*
***********************************************************************
*/
char *vmk_Strchr(
const void *src,
int c);
/*
***********************************************************************
* vmk_Strrchr -- */ /**
*
* \brief Reverse search through a string for a character.
*
* \note This function will not block.
*
* \param[in] src String to search backward.
* \param[in] c Character to search for.
*
* \return Pointer to the offset in src where c was found or NULL
* if c was not found in src.
*
***********************************************************************
*/
char *vmk_Strrchr(
const void *src,
int c);
/*
***********************************************************************
* vmk_Strstr -- */ /**
*
* \brief Search for a substring in a string.
*
* \note This function will not block.
*
* \param[in] s1 String to search.
* \param[in] s2 String to search for.
*
* \return Pointer to the offset in s1 where s2 was found or NULL
* if s2 was not found in s1.
*
***********************************************************************
*/
char *vmk_Strstr(
const void *s1,
const void *s2);
/*
***********************************************************************
* vmk_Strtol -- */ /**
*
* \brief Convert a string to a signed long integer.
*
* \note This function will not block.
*
* \param[in] str String to convert
* \param[out] end If non-NULL, the address of the first invalid
* character or the value of str if there are no
* digits in the string.
* \param[in] base Base of the number being converted which may be
* between 2 and 36, or 0 may be supplied such
* that strtol will attempt to detect the base
* of the number in the string.
*
* \return Numeric value of the string.
*
***********************************************************************
*/
long vmk_Strtol(
const char *str,
char **end,
int base);
/*
***********************************************************************
* vmk_Strtoul -- */ /**
*
* \brief Convert a string to an unsigned long integer.
*
* \note This function will not block.
*
* \param[in] str String to convert
* \param[out] end If non-NULL, the address of the first invalid
* character or the value of str if there are no
* digits in the string.
* \param[in] base Base of the number being converted which may be
* between 2 and 36, or 0 may be supplied such
* that strtoul will attempt to detect the base
* of the number in the string.
*
* \return Numeric value of the string.
*
***********************************************************************
*/
unsigned long vmk_Strtoul(
const char *str,
char **end,
int base);
/*
***********************************************************************
* vmk_Sprintf -- */ /**
*
* \brief Formatted print to a string.
*
* \note This function will not block.
*
* \deprecated Use vmk_StringFormat() instead.
*
* \printformatstringdoc
*
* \param[in] str Buffer in which to place output.
* \param[in] format Printf-style format string.
*
* \return Number of bytes in the output string, not including the
* terminating nul character.
*
***********************************************************************
*/
int vmk_Sprintf(
char *str,
const char *format,
...)
VMK_ATTRIBUTE_PRINTF(2,3);
/*
***********************************************************************
* vmk_Snprintf -- */ /**
*
* \brief Formatted print to a string with a maximum bound.
*
* \note This function will not block.
*
* \deprecated Use vmk_StringFormat() instead.
*
* \printformatstringdoc
*
* \param[in] str Buffer in which to place output.
* \param[in] size Maximum number of bytes to output.
* \param[in] format Printf-style format string.
*
* \return Number of bytes required to format the output string, not
* including the terminating nul character.
*
* \note If the return value is less than the specified size, the
* string has been formatted completely. If the return value is
* equal to or greater than the specified size, the output has
* been truncated. The output will always be nul terminated
* unless the specified size is zero.
*
***********************************************************************
*/
int vmk_Snprintf(
char *str,
vmk_ByteCount size,
const char *format,
...)
VMK_ATTRIBUTE_PRINTF(3,4);
/*
***********************************************************************
* vmk_Vsprintf -- */ /**
*
* \brief Formatted print to a string using varargs.
*
* \note This function will not block.
*
* \deprecated Use vmk_StringVFormat() instead.
*
* \printformatstringdoc
*
* \param[in] str Buffer in which to place output.
* \param[in] format Printf-style format string.
* \param[in] ap Varargs for format.
*
* \return Number of bytes in the output string, not including the
* terminating nul character.
*
***********************************************************************
*/
int
vmk_Vsprintf(
char *str,
const char *format,
va_list ap);
/*
************************************************************************
* vmk_Vsnprintf -- */ /**
*
* \brief Formatted print to a string with a maximum bound using varargs.
*
* \note This function will not block.
*
* \deprecated Use vmk_StringVFormat() instead.
*
* \printformatstringdoc
*
* \param[in] str Buffer in which to place output.
* \param[in] size Maximum number of bytes to output.
* \param[in] format Printf-style format string.
* \param[in] ap Varargs for format.
*
* \return Number of bytes required to format the output string, not
* including the terminating nul character.
*
* \note If the return value is less than the specified size, the
* string has been formatted completely. If the return value is
* equal to or greater than the specified size, the output has
* been truncated. The output will always be nul terminated
* unless the specified size is zero.
*
***********************************************************************
*/
int
vmk_Vsnprintf(
char *str,
vmk_ByteCount size,
const char *format,
va_list ap);
/*
***********************************************************************
* vmk_Vsscanf -- */ /**
*
* \brief Formatted scan of a string using varargs.
*
* \note This function will not block.
*
* \scanformatstringdoc
*
* \param[in] inp Buffer to scan.
* \param[in] fmt0 Scanf-style format string.
* \param[in] ap Varargs that hold input values for format.
*
* \return Number of input values assigned.
*
***********************************************************************
*/
int
vmk_Vsscanf(
const char *inp,
char const *fmt0,
va_list ap);
/*
***********************************************************************
* vmk_Sscanf -- */ /**
*
* \brief Formatted scan of a string.
*
* \note This function will not block.
*
* \scanformatstringdoc
*
* \param[in] ibuf Buffer to scan.
* \param[in] fmt Scanf-style format string.
*
* \return Number of input values assigned.
*
***********************************************************************
*/
int
vmk_Sscanf(
const char *ibuf,
const char *fmt,
...)
VMK_ATTRIBUTE_SCANF(2, 3);
/*
***********************************************************************
* vmk_Memset -- */ /**
*
* \brief Set bytes in a buffer to a particular value.
*
* \note This function will not block.
*
* \param[in] dst Destination buffer to set.
* \param[in] byte Value to set each byte to.
* \param[in] len Number of bytes to set.
*
* \return Original value of dst.
*
***********************************************************************
*/
void *vmk_Memset(
void *dst,
int byte,
vmk_ByteCount len);
/*
***********************************************************************
* vmk_Memcpy -- */ /**
*
* \brief Copy bytes from one buffer to another.
*
* \note This function will not block.
*
* \param[in] dst Destination buffer to copy to.
* \param[in] src Source buffer to copy from.
* \param[in] len Number of bytes to copy.
*
* \return Original value of dst.
*
***********************************************************************
*/
void *vmk_Memcpy(
void *dst,
const void *src,
vmk_ByteCount len);
/*
***********************************************************************
* vmk_Memcmp -- */ /**
*
* \brief Compare bytes between two buffers.
*
* \note This function will not block.
*
* \param[in] src1 Buffer to compare.
* \param[in] src2 Other buffer to compare.
* \param[in] len Number of bytes to compare.
*
* \return Difference between the first two differing bytes or
* zero if the buffers are identical over the specified length.
*
***********************************************************************
*/
int vmk_Memcmp(
const void *src1,
const void *src2,
vmk_ByteCount len);
/*
***********************************************************************
* vmk_Rand -- */ /**
*
* \brief Generate the next number in a pseudorandom sequence.
*
* \note This function will not block.
*
* \warning This function's pseudorandom numbers do not have high
* enough quality for cryptographic purposes.
*
* \note The values returned are in the range 0 < n <= 0x7fffffff,
* and the seed supplied must also be in this range.
*
* \param[in] seed The previous number in the sequence, if any. To
* start a new sequence at a random point, call
* vmk_GetRandSeed to get the initial seed. To
* start a new sequence at a deterministic point,
* choose any fixed value in range for the initial
* seed.
*
* \return A pseudorandom number.
*
***********************************************************************
*/
vmk_uint32 vmk_Rand(
vmk_uint32 seed);
/*
***********************************************************************
* vmk_GetRandSeed -- */ /**
*
* \brief Generate a random initial seed for vmk_Rand()
*
* \note This function will not block.
*
* \warning This function should be called only occasionally, to start
* a sequence of pseudorandom numbers generated by
* vmk_Rand(). Attempting to use this function frequently to
* generate individual random numbers will result in values
* with very poor randomness. Even when this function is
* called only occasionally, its random numbers do not have
* high enough quality for cryptographic purposes.
*
* \return A random seed value suitable to start a new pseudorandom
* sequence.
*
***********************************************************************
*/
vmk_uint32
vmk_GetRandSeed(
void);
/*
***********************************************************************
* vmk_IsPrint -- */ /**
*
* \brief Determine if a character is printable.
*
* \note This function will not block.
*
* \param[in] c Character to check.
*
* \retval VMK_TRUE Supplied character is printable.
* \retval VMK_FALSE Supplied character is not printable.
*
***********************************************************************
*/
vmk_Bool
vmk_IsPrint(
int c);
#endif /* _VMKAPI_LIBC_H_ */
/** @} */
/** @} */
|