image Struct Reference

An executable or loadable image. More...

#include <image.h>

Data Fields
struct refcnt	refcnt
	Reference count.
struct list_head	list
	List of registered images.
struct uri *	uri
	URI of image.
char	name [16]
	Name.
unsigned int	flags
	Flags.
char *	cmdline
	Command line to pass to image.
userptr_t	data
	Raw file image.
size_t	len
	Length of raw file image.
struct image_type *	type
	Image type, if known.
union {
physaddr_t   phys
userptr_t   user
unsigned long   ul
}	priv
	Image type private data.
struct image *	replacement
	Replacement image.

---

Detailed Description

An executable or loadable image.

Definition at line 22 of file image.h.

---

Field Documentation

struct refcnt image::refcnt [read]

Reference count.

Definition at line 24 of file image.h.

Referenced by alloc_image(), image_get(), and image_put().

struct list_head image::list [read]

List of registered images.

Definition at line 27 of file image.h.

Referenced by find_image(), imgfree_exec(), register_image(), and unregister_image().

struct uri* image::uri [read]

URI of image.

Definition at line 30 of file image.h.

Referenced by free_image(), image_exec(), and image_set_uri().

char image::name[16]

Name.

Definition at line 32 of file image.h.

Referenced by com32_identify(), com32_load(), comboot_identify(), comboot_load(), digest_exec(), embedded_init(), find_image(), image_set_name(), image_set_uri(), imgexec_exec(), imgstat(), multiboot_build_module_list(), multiboot_exec(), and register_image().

unsigned int image::flags

Flags.

Definition at line 34 of file image.h.

Referenced by image_exec(), image_load_type(), imgautoselect(), and imgstat().

char* image::cmdline

Command line to pass to image.

Definition at line 37 of file image.h.

Referenced by bzimage_exec(), bzimage_load_initrd(), com32_exec(), com32_load(), comboot_copy_cmdline(), image_set_cmdline(), imgstat(), multiboot_build_module_list(), and multiboot_exec().

userptr_t image::data

Raw file image.

Definition at line 39 of file image.h.

Referenced by bzimage_load(), bzimage_load_initrd(), bzimage_load_initrds(), com32_identify(), comboot_load_image(), comboot_prepare_segment(), digest_exec(), downloader_ensure_size(), downloader_xfer_deliver_iob(), efi_image_exec(), efi_image_load(), elf_load(), elf_load_segment(), elfboot_load(), eltorito_exec(), eltorito_load_disk(), eltorito_read_catalog(), eltorito_read_voldesc(), embedded_init(), free_image(), multiboot_build_module_list(), multiboot_find_header(), multiboot_load_raw(), nbi_load(), nbi_load_segment(), nbi_process_segments(), pxe_load(), register_image(), script_exec(), and script_load().

size_t image::len

Length of raw file image.

Definition at line 41 of file image.h.

Referenced by bzimage_load_initrd(), bzimage_load_initrds(), bzimage_parse_header(), com32_exec(), com32_identify(), comboot_load(), comboot_load_image(), comboot_prepare_segment(), digest_exec(), downloader_ensure_size(), downloader_job_progress(), efi_image_exec(), efi_image_load(), elf_load(), elf_load_segment(), eltorito_exec(), eltorito_load_disk(), eltorito_read_catalog(), eltorito_read_voldesc(), embedded_init(), imgstat(), int22(), multiboot_build_module_list(), multiboot_find_header(), multiboot_load_raw(), nbi_load(), nbi_process_segments(), pxe_load(), register_image(), script_exec(), script_load(), and shuffle().

struct image_type* image::type [read]

Image type, if known.

Definition at line 44 of file image.h.

Referenced by bzimage_load(), com32_load(), comboot_load(), efi_image_load(), elf_load(), elfboot_load(), eltorito_load(), image_autoload(), image_exec(), image_load(), imgfetch_core_exec(), imgstat(), multiboot_load(), nbi_load(), pxe_load(), and script_load().

physaddr_t image::phys

Definition at line 47 of file image.h.

Referenced by elf_load(), elf_load_segment(), elfboot_exec(), multiboot_exec(), and multiboot_load_raw().

userptr_t image::user

Definition at line 48 of file image.h.

Referenced by bzimage_exec(), bzimage_load(), nbi_exec(), and nbi_load().

unsigned long image::ul

Definition at line 49 of file image.h.

Referenced by eltorito_exec(), and eltorito_load().

union { ... } image::priv

Image type private data.

Referenced by bzimage_exec(), bzimage_load(), elf_load(), elf_load_segment(), elfboot_exec(), eltorito_exec(), eltorito_load(), multiboot_exec(), multiboot_load_raw(), nbi_exec(), and nbi_load().

struct image* image::replacement [read]

Replacement image.

An image wishing to replace itself with another image (in a style similar to a Unix exec() call) should return from its exec() method with the replacement image set to point to the new image. The new image must already be in a suitable state for execution (i.e. loaded).

If an image unregisters itself as a result of being executed, it must make sure that its replacement image (if any) is registered, otherwise the replacement is likely to be freed before it can be executed.

Definition at line 65 of file image.h.

Referenced by com32_exec(), comboot_exec(), free_image(), and image_exec().

---

The documentation for this struct was generated from the following file:

• include/gpxe/image.h