tmpfile.cpp File Reference

#include <corecrt_internal_stdio.h>
#include <sys/stat.h>

Include dependency graph for tmpfile.cpp:

Go to the source code of this file.

Namespaces
namespace	anonymous_namespace{tmpfile.cpp}

Enumerations
enum class	anonymous_namespace{tmpfile.cpp}::buffer_id { anonymous_namespace{tmpfile.cpp}::tmpnam , anonymous_namespace{tmpfile.cpp}::tmpfile , anonymous_namespace{tmpfile.cpp}::tmpnam_s , anonymous_namespace{tmpfile.cpp}::count }

Functions
void __cdecl	__acrt_stdio_free_tmpfile_name_buffers_nolock ()
static char *&__cdecl	get_tmpfile_buffer_pointer_nolock (buffer_id const id, char) throw ()
static wchar_t *&__cdecl	get_tmpfile_buffer_pointer_nolock (buffer_id const id, wchar_t) throw ()
template<typename Character >
	_Success_ (return !=nullptr) static Character *__cdecl get_tmpfile_buffer_nolock(buffer_id const id) throw ()
template<typename Character >
	_Success_ (return==true) static bool __cdecl initialize_tmpfile_buffer_nolock(buffer_id const buffer_id) throw ()
_In_ size_t const file_name_count	throw ()
static char **__cdecl	get_tmpnam_ptd_buffer (char) throw ()
static wchar_t **__cdecl	get_tmpnam_ptd_buffer (wchar_t) throw ()
	_Success_ (return==0) static errno_t __cdecl common_tmpfile_nolock(_Out_ FILE **const stream
errno_t __cdecl	tmpnam_s (char *const result_buffer, size_t const result_buffer_count)
errno_t __cdecl	_wtmpnam_s (wchar_t *const result_buffer, size_t const result_buffer_count)
char *__cdecl	tmpnam (char *const result_buffer)
wchar_t *__cdecl	_wtmpnam (wchar_t *const result_buffer)
FILE *__cdecl	tmpfile ()
errno_t __cdecl	tmpfile_s (FILE **const stream)
void	__acrt_force_use_of_tmpfile ()

Variables
static char *	narrow_tmpfile_buffer_pointers [static_cast< size_t >(buffer_id::count)]
static wchar_t *	wide_tmpfile_buffer_pointers [static_cast< size_t >(buffer_id::count)]
size_t const	result_buffer_count
_In_ size_t const _In_ buffer_id const	buffer_id
unsigned	__acrt_tmpfile_used

Function Documentation

__acrt_force_use_of_tmpfile()

void __acrt_force_use_of_tmpfile

(

)

Definition at line 507 of file tmpfile.cpp.

    {
        ++__acrt_tmpfile_used;
    }

__acrt_stdio_free_tmpfile_name_buffers_nolock()

void __cdecl __acrt_stdio_free_tmpfile_name_buffers_nolock

(

)

Definition at line 49 of file tmpfile.cpp.

{
    for (char*& p : narrow_tmpfile_buffer_pointers)
    {
        _free_crt(p);
        p = nullptr;
    }
 
    for (wchar_t*& p : wide_tmpfile_buffer_pointers)
    {
        _free_crt(p);
        p = nullptr;
    }
}

Referenced by __acrt_uninitialize_tmpfile(), and __DEFINE_CPP_OVERLOAD_STANDARD_FUNC_0_0().

_Success_() [1/3]

template<typename Character >

_Success_	(	return !	= nullptr	)	const
throw	(
	)

Definition at line 75 of file tmpfile.cpp.

{
    Character*& buffer_pointer = get_tmpfile_buffer_pointer_nolock(id, Character());
    if (!buffer_pointer)
    {
        buffer_pointer = _calloc_crt_t(Character, L_tmpnam).detach();
    }
 
    return buffer_pointer;
}

_Success_() [2/3]

_Success_

(

return

= = 0

)

const

_Success_() [3/3]

template<typename Character >

_Success_	(	return	= = true	)	const
throw	(
	)

Definition at line 88 of file tmpfile.cpp.

{
    typedef __acrt_stdio_char_traits<Character> stdio_traits;
 
    Character* const buffer       = get_tmpfile_buffer_nolock<Character>(buffer_id);
    size_t     const buffer_count = L_tmpnam;
 
    if (!buffer)
    {
        return false;
    }
 
    // The temporary path must be short enough so that we can append a file name
    // of the form [buffer id][process id].[unique id], which is at most 21
    // characters in length (plus we must leave room for the null terminator).
    //    1 Buffer Id              ("s", "t", or "u")
    //    7 Base-36 Process Id     (maximum: "1z141z3")
    //   13 Base-36 Unique File Id (maximum: "3w5e11264sgsf")
    DWORD const max_supported_temp_path_length = buffer_count - 22;
  
    // Generate the path prefix; make sure it ends with a slash or backslash:
    // CRT_REFACTOR TODO We need to use the WinRT temp path logic here.
    DWORD const temp_path_length = stdio_traits::get_temp_path(static_cast<DWORD>(buffer_count), buffer);
    if (temp_path_length == 0 || temp_path_length > max_supported_temp_path_length)
    {
        buffer[0] = '\0';
        return false;
    }
 
    Character* tail = buffer + temp_path_length;
 
    auto tail_count = [&](){ return buffer_count - (tail - buffer); };
 
    // Append the buffer identifier part of the file name:
    switch (buffer_id)
    {
    case buffer_id::tmpnam:   *tail++ = sizeof(Character) == 1 ? 's' : 'v'; break;
    case buffer_id::tmpfile:  *tail++ = sizeof(Character) == 1 ? 't' : 'w'; break;
    case buffer_id::tmpnam_s: *tail++ = sizeof(Character) == 1 ? 'u' : 'x'; break;
    }
 
    // Append the process identifier part of the file name:
    _ERRCHECK(stdio_traits::ulltot_s(GetCurrentProcessId(), tail, tail_count(), 36));
    tail += stdio_traits::tcslen(tail);
 
    // Append the dot part of the file name and the initial unique id:
    *tail++ = '.';
    *tail++ = '0';
    *tail++ = '\0';
 
    return true;
}

_wtmpnam()

wchar_t *__cdecl _wtmpnam

(

wchar_t *const

result_buffer

)

Definition at line 474 of file tmpfile.cpp.

{
    wchar_t* result = nullptr;
    common_tmpnam(result_buffer, L_tmpnam, buffer_id::tmpnam, &result);
    return result;
}

_wtmpnam_s()

errno_t __cdecl _wtmpnam_s	(	wchar_t *const	result_buffer,
		size_t const	result_buffer_count
	)

Definition at line 457 of file tmpfile.cpp.

{
    wchar_t* result = nullptr;
    _VALIDATE_RETURN_ERRCODE(result_buffer != nullptr, EINVAL);
    return common_tmpnam(result_buffer, result_buffer_count, buffer_id::tmpnam_s, &result);
}

get_tmpfile_buffer_pointer_nolock() [1/2]

static char *&__cdecl get_tmpfile_buffer_pointer_nolock ( buffer_id const  id, char    ) throw ( )

static

Definition at line 64 of file tmpfile.cpp.

{
    return narrow_tmpfile_buffer_pointers[static_cast<size_t>(id)];
}

Referenced by _Success_().

get_tmpfile_buffer_pointer_nolock() [2/2]

static wchar_t *&__cdecl get_tmpfile_buffer_pointer_nolock ( buffer_id const  id, wchar_t    ) throw ( )

static

Definition at line 69 of file tmpfile.cpp.

{
    return wide_tmpfile_buffer_pointers[static_cast<size_t>(id)];
}

get_tmpnam_ptd_buffer() [1/2]

static char **__cdecl get_tmpnam_ptd_buffer ( char  ) throw ( )

static

Definition at line 172 of file tmpfile.cpp.

{
    __acrt_ptd* const ptd = __acrt_getptd_noexit();
    if (ptd == nullptr)
        return nullptr;
 
    return &ptd->_tmpnam_narrow_buffer;
}

get_tmpnam_ptd_buffer() [2/2]

static wchar_t **__cdecl get_tmpnam_ptd_buffer ( wchar_t  ) throw ( )

static

Definition at line 181 of file tmpfile.cpp.

{
    __acrt_ptd* const ptd = __acrt_getptd_noexit();
    if (ptd == nullptr)
        return nullptr;
 
    return &ptd->_tmpnam_wide_buffer;
}

throw()

_In_ size_t const file_name_count throw

(

)

Definition at line 149 of file tmpfile.cpp.

{
    typedef __acrt_stdio_char_traits<Character> stdio_traits;
 
    Character* const dot = reinterpret_cast<Character*>(stdio_traits::tcsrchr(file_name, '.'));
    _VALIDATE_RETURN_NOERRNO(dot != nullptr,                                         false);
    _VALIDATE_RETURN_NOERRNO(dot >= file_name,                                       false);
    _VALIDATE_RETURN_NOERRNO(file_name_count > static_cast<size_t>(dot - file_name), false);
 
    Character* const unique_id = dot + 1;
    size_t     const unique_id_count = file_name_count - (unique_id - file_name);
 
    uint64_t const next_identifier = stdio_traits::tcstoull(unique_id, nullptr, 36) + 1;
    if (next_identifier == 0)
        return false;
 
#pragma warning(disable:__WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) // 26036 Prefast doesn't understand perfect forwarding.
    _ERRCHECK(stdio_traits::ulltot_s(next_identifier, unique_id, unique_id_count, 36));
    return true;
}

tmpfile()

FILE *__cdecl tmpfile

(

void

)

Definition at line 484 of file tmpfile.cpp.

{
    FILE* stream = nullptr;
    common_tmpfile(&stream, _SH_DENYNO);
    return stream;
}

Referenced by CCFDATAStorage::Create(), create_temp_binary(), HANDLE_CustomType7(), jpeg_open_backing_store(), JSPROXY_InternetInitializeAutoProxyDll(), open_file_test(), patch_file(), test_color_contexts(), test_CreateDirectoryA(), test_CryptCATAdminAddRemoveCatalog(), test_GetNamedSecurityInfoA(), test_install_class(), test_retrieveObjectByUrl(), test_SetupCopyOEMInf(), transfer_file_http(), CCFDATAStorage::Truncate(), VerInstallFileA(), and VerInstallFileW().

tmpfile_s()

errno_t __cdecl tmpfile_s

(

FILE **const

stream

)

Definition at line 495 of file tmpfile.cpp.

{
    return common_tmpfile(stream, _SH_DENYRW);
}

tmpnam()

char *__cdecl tmpnam

(

char *const

result_buffer

)

Definition at line 467 of file tmpfile.cpp.

{
    char* result = nullptr;
    common_tmpnam(result_buffer, L_tmpnam, buffer_id::tmpnam, &result);
    return result;
}

tmpnam_s()

errno_t __cdecl tmpnam_s	(	char *const	result_buffer,
		size_t const	result_buffer_count
	)

Definition at line 447 of file tmpfile.cpp.

{
    char* result = nullptr;
    _VALIDATE_RETURN_ERRCODE(result_buffer != nullptr, EINVAL);
    return common_tmpnam(result_buffer, result_buffer_count, buffer_id::tmpnam_s, &result);
}

Variable Documentation

__acrt_tmpfile_used

unsigned __acrt_tmpfile_used

Definition at line 505 of file tmpfile.cpp.

Referenced by __acrt_force_use_of_tmpfile().

buffer_id

_In_ size_t const _In_ buffer_id const buffer_id

Definition at line 283 of file tmpfile.cpp.

narrow_tmpfile_buffer_pointers

char* narrow_tmpfile_buffer_pointers[static_cast< size_t >(buffer_id::count)]

static

Definition at line 46 of file tmpfile.cpp.

Referenced by __acrt_stdio_free_tmpfile_name_buffers_nolock(), and get_tmpfile_buffer_pointer_nolock().

result_buffer_count

_In_ size_t const result_buffer_count

Definition at line 196 of file tmpfile.cpp.

Referenced by __acrt_fp_format(), _In_range_(), _wtmpnam_s(), if(), throw(), and tmpnam_s().

wide_tmpfile_buffer_pointers

wchar_t* wide_tmpfile_buffer_pointers[static_cast< size_t >(buffer_id::count)]

static

Definition at line 47 of file tmpfile.cpp.

Referenced by __acrt_stdio_free_tmpfile_name_buffers_nolock(), and get_tmpfile_buffer_pointer_nolock().