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
|
/*
* mem.h - Routines to cleanup memory after use.
*
* Copyright 2002-2004,2007 Jonathan McDowell <noodles@earth.li>
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc., 51
* Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __MEM_H_
#define __MEM_H_
#include "keystructs.h"
#include "stats.h"
/**
* packet_dup - duplicate an OpenPGP packet.
* @packet: The packet to duplicate.
*
* This function takes an OpenPGP packet structure and duplicates it,
* including the data part. It returns NULL if there is a problem
* allocating memory for the duplicate.
*/
struct openpgp_packet *packet_dup(struct openpgp_packet *packet);
/**
* packet_list_add - Adds an OpenPGP packet list to another.
* @list: The packet list to add to.
* @list_end: The end of the packet list to add to.
* @packet_list: The packet list to add.
*
* This function takes an OpenPGP packet list and adds it to another list,
* duplicating it in the process. The list to add to need not exists to
* begin with, in which case the function simply duplicates the supplied
* list.
*/
void packet_list_add(struct openpgp_packet_list **list,
struct openpgp_packet_list **list_end,
struct openpgp_packet_list *packet_list);
/**
* free_packet - free the memory used by an OpenPGP packet.
* @packet: The packet to free.
*
* Takes an OpenPGP packet structure and frees the memory used by it,
* including the data part.
*/
void free_packet(struct openpgp_packet *packet);
/**
* free_packet_list - free the memory used by an OpenPGP packet list.
* @packet_list: The packet list to free.
*
* Takes an OpenPGP packet list structure and frees the memory used by the
* packets in it and the linked list overhead.
*/
void free_packet_list(struct openpgp_packet_list *packet_list);
/**
* free_signedpacket_list - free an OpenPGP signed packet list.
* @signedpacket_list: The packet list to free.
*
* Takes an OpenPGP signed packet list structure and frees the memory used
* by the packets and signatures it and the linked list overhead.
*/
void free_signedpacket_list(
struct openpgp_signedpacket_list *signedpacket_list);
/**
* free_publickey - free an OpenPGP public key structure.
* @key: The key to free.
*
* Takes an OpenPGP key and frees the memory used by all the structures it
* contains.
*/
void free_publickey(struct openpgp_publickey *key);
/**
* free_statskey - free an stats key structure.
* @key: The key to free.
*
* Takes a stats key and frees the memory used by it and the linked list
* of sigs under it. Doesn't recurse into the list as it's assumed all the
* objects referenced also exist in the hash.
*/
void free_statskey(struct stats_key *key);
#endif /* __MEM_H_ */
|