/src/gdal/frmts/gtiff/libtiff/tif_close.c

Source (jump to first uncovered line)
/*
 * Copyright (c) 1988-1997 Sam Leffler
 * Copyright (c) 1991-1997 Silicon Graphics, Inc.
 *
 * Permission to use, copy, modify, distribute, and sell this software and
 * its documentation for any purpose is hereby granted without fee, provided
 * that (i) the above copyright notices and this permission notice appear in
 * all copies of the software and related documentation, and (ii) the names of
 * Sam Leffler and Silicon Graphics may not be used in any advertising or
 * publicity relating to the software without the specific, prior written
 * permission of Sam Leffler and Silicon Graphics.
 *
 * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
 * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
 * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THIS SOFTWARE.
 */

/*
 * TIFF Library.
 */
#include "tiffiop.h"
#include <string.h>

/************************************************************************/
/*                            TIFFCleanup()                             */
/************************************************************************/

/**
 * Auxiliary function to free the TIFF structure. Given structure will be
 * completely freed, so you should save opened file handle and pointer
 * to the close procedure in external variables before calling
 * _TIFFCleanup(), if you will need these ones to close the file.
 *
 * @param tif A TIFF pointer.
 */

void TIFFCleanup(TIFF *tif)
{
    /*
     * Flush buffered data and directory (if dirty).
     */
    if (tif->tif_mode != O_RDONLY)
        TIFFFlush(tif);
    TIFFFreeDirectory(tif);

    _TIFFCleanupIFDOffsetAndNumberMaps(tif);

    /*
     * Clean up client info links.
     */
    while (tif->tif_clientinfo)
    {
        TIFFClientInfoLink *psLink = tif->tif_clientinfo;

        tif->tif_clientinfo = psLink->next;
        _TIFFfreeExt(tif, psLink->name);
        _TIFFfreeExt(tif, psLink);
    }

    if (tif->tif_rawdata && (tif->tif_flags & TIFF_MYBUFFER))
        _TIFFfreeExt(tif, tif->tif_rawdata);
    if (isMapped(tif))
        TIFFUnmapFileContents(tif, tif->tif_base, (toff_t)tif->tif_size);

    /*
     * Clean up custom fields.
     */
    if (tif->tif_fields && tif->tif_nfields > 0)
    {
        uint32_t i;

        for (i = 0; i < tif->tif_nfields; i++)
        {
            TIFFField *fld = tif->tif_fields[i];
            if (fld->field_name != NULL)
            {
                if (fld->field_bit == FIELD_CUSTOM &&
                    /* caution: tif_fields[i] must not be the beginning of a
                     * fields-array. Otherwise the following tags are also freed
                     * with the first free().
                     */
                    TIFFFieldIsAnonymous(fld))
                {
                    _TIFFfreeExt(tif, fld->field_name);
                    _TIFFfreeExt(tif, fld);
                }
            }
        }

        _TIFFfreeExt(tif, tif->tif_fields);
    }

    if (tif->tif_nfieldscompat > 0)
    {
        uint32_t i;

        for (i = 0; i < tif->tif_nfieldscompat; i++)
        {
            if (tif->tif_fieldscompat[i].allocated_size)
                _TIFFfreeExt(tif, tif->tif_fieldscompat[i].fields);
        }
        _TIFFfreeExt(tif, tif->tif_fieldscompat);
    }

    if (tif->tif_cur_cumulated_mem_alloc != 0)
    {
        TIFFErrorExtR(tif, "TIFFCleanup",
                      "tif_cur_cumulated_mem_alloc = %" PRIu64 " whereas it "
                      "should be 0",
                      (uint64_t)tif->tif_cur_cumulated_mem_alloc);
    }

    _TIFFfreeExt(NULL, tif);
}

/************************************************************************/
/*                    _TIFFCleanupIFDOffsetAndNumberMaps()              */
/************************************************************************/

void _TIFFCleanupIFDOffsetAndNumberMaps(TIFF *tif)
{
    if (tif->tif_map_dir_offset_to_number)
    {
        TIFFHashSetDestroy(tif->tif_map_dir_offset_to_number);
        tif->tif_map_dir_offset_to_number = NULL;
    }
    if (tif->tif_map_dir_number_to_offset)
    {
        TIFFHashSetDestroy(tif->tif_map_dir_number_to_offset);
        tif->tif_map_dir_number_to_offset = NULL;
    }
}

/************************************************************************/
/*                            TIFFClose()                               */
/************************************************************************/

/**
 * Close a previously opened TIFF file.
 *
 * TIFFClose closes a file that was previously opened with TIFFOpen().
 * Any buffered data are flushed to the file, including the contents of
 * the current directory (if modified); and all resources are reclaimed.
 *
 * @param tif A TIFF pointer.
 */

void TIFFClose(TIFF *tif)
{
    if (tif != NULL)
    {
        TIFFCloseProc closeproc = tif->tif_closeproc;
        thandle_t fd = tif->tif_clientdata;

        TIFFCleanup(tif);
        (void)(*closeproc)(fd);
    }
}

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright (c) 1988-1997 Sam Leffler
3		* Copyright (c) 1991-1997 Silicon Graphics, Inc.
4		*
5		* Permission to use, copy, modify, distribute, and sell this software and
6		* its documentation for any purpose is hereby granted without fee, provided
7		* that (i) the above copyright notices and this permission notice appear in
8		* all copies of the software and related documentation, and (ii) the names of
9		* Sam Leffler and Silicon Graphics may not be used in any advertising or
10		* publicity relating to the software without the specific, prior written
11		* permission of Sam Leffler and Silicon Graphics.
12		*
13		* THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
14		* EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
15		* WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
16		*
17		* IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
18		* ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
19		* OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
20		* WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
21		* LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
22		* OF THIS SOFTWARE.
23		*/
24
25		/*
26		* TIFF Library.
27		*/
28		#include "tiffiop.h"
29		#include <string.h>
30
31		/************************************************************************/
32		/* TIFFCleanup() */
33		/************************************************************************/
34
35		/**
36		* Auxiliary function to free the TIFF structure. Given structure will be
37		* completely freed, so you should save opened file handle and pointer
38		* to the close procedure in external variables before calling
39		* _TIFFCleanup(), if you will need these ones to close the file.
40		*
41		* @param tif A TIFF pointer.
42		*/
43
44		void TIFFCleanup(TIFF *tif)
45	0	{
46		/*
47		* Flush buffered data and directory (if dirty).
48		*/
49	0	if (tif->tif_mode != O_RDONLY)
50	0	TIFFFlush(tif);
51	0	TIFFFreeDirectory(tif);
52
53	0	_TIFFCleanupIFDOffsetAndNumberMaps(tif);
54
55		/*
56		* Clean up client info links.
57		*/
58	0	while (tif->tif_clientinfo)
59	0	{
60	0	TIFFClientInfoLink *psLink = tif->tif_clientinfo;
61
62	0	tif->tif_clientinfo = psLink->next;
63	0	_TIFFfreeExt(tif, psLink->name);
64	0	_TIFFfreeExt(tif, psLink);
65	0	}
66
67	0	if (tif->tif_rawdata && (tif->tif_flags & TIFF_MYBUFFER))
68	0	_TIFFfreeExt(tif, tif->tif_rawdata);
69	0	if (isMapped(tif))
70	0	TIFFUnmapFileContents(tif, tif->tif_base, (toff_t)tif->tif_size);
71
72		/*
73		* Clean up custom fields.
74		*/
75	0	if (tif->tif_fields && tif->tif_nfields > 0)
76	0	{
77	0	uint32_t i;
78
79	0	for (i = 0; i < tif->tif_nfields; i++)
80	0	{
81	0	TIFFField *fld = tif->tif_fields[i];
82	0	if (fld->field_name != NULL)
83	0	{
84	0	if (fld->field_bit == FIELD_CUSTOM &&
85		/* caution: tif_fields[i] must not be the beginning of a
86		* fields-array. Otherwise the following tags are also freed
87		* with the first free().
88		*/
89	0	TIFFFieldIsAnonymous(fld))
90	0	{
91	0	_TIFFfreeExt(tif, fld->field_name);
92	0	_TIFFfreeExt(tif, fld);
93	0	}
94	0	}
95	0	}
96
97	0	_TIFFfreeExt(tif, tif->tif_fields);
98	0	}
99
100	0	if (tif->tif_nfieldscompat > 0)
101	0	{
102	0	uint32_t i;
103
104	0	for (i = 0; i < tif->tif_nfieldscompat; i++)
105	0	{
106	0	if (tif->tif_fieldscompat[i].allocated_size)
107	0	_TIFFfreeExt(tif, tif->tif_fieldscompat[i].fields);
108	0	}
109	0	_TIFFfreeExt(tif, tif->tif_fieldscompat);
110	0	}
111
112	0	if (tif->tif_cur_cumulated_mem_alloc != 0)
113	0	{
114	0	TIFFErrorExtR(tif, "TIFFCleanup",
115	0	"tif_cur_cumulated_mem_alloc = %" PRIu64 " whereas it "
116	0	"should be 0",
117	0	(uint64_t)tif->tif_cur_cumulated_mem_alloc);
118	0	}
119
120	0	_TIFFfreeExt(NULL, tif);
121	0	}
122
123		/************************************************************************/
124		/* _TIFFCleanupIFDOffsetAndNumberMaps() */
125		/************************************************************************/
126
127		void _TIFFCleanupIFDOffsetAndNumberMaps(TIFF *tif)
128	0	{
129	0	if (tif->tif_map_dir_offset_to_number)
130	0	{
131	0	TIFFHashSetDestroy(tif->tif_map_dir_offset_to_number);
132	0	tif->tif_map_dir_offset_to_number = NULL;
133	0	}
134	0	if (tif->tif_map_dir_number_to_offset)
135	0	{
136	0	TIFFHashSetDestroy(tif->tif_map_dir_number_to_offset);
137	0	tif->tif_map_dir_number_to_offset = NULL;
138	0	}
139	0	}
140
141		/************************************************************************/
142		/* TIFFClose() */
143		/************************************************************************/
144
145		/**
146		* Close a previously opened TIFF file.
147		*
148		* TIFFClose closes a file that was previously opened with TIFFOpen().
149		* Any buffered data are flushed to the file, including the contents of
150		* the current directory (if modified); and all resources are reclaimed.
151		*
152		* @param tif A TIFF pointer.
153		*/
154
155		void TIFFClose(TIFF *tif)
156	0	{
157	0	if (tif != NULL)
158	0	{
159	0	TIFFCloseProc closeproc = tif->tif_closeproc;
160	0	thandle_t fd = tif->tif_clientdata;
161
162	0	TIFFCleanup(tif);
163	0	(void)(*closeproc)(fd);
164	0	}
165	0	}

Coverage Report

Created: 2025-06-13 06:18