sourcepawn/decompiler/file_format.cpp
author GoD-Tony <aangione@gmail.com>
Sun Aug 04 10:03:40 2013 -0400 (2013-08-04)
changeset 3971 d2e8100b2814
parent 2325 7a24ee5557fb
permissions -rw-r--r--
Added ISDKHooks interface with entity listeners (bug 5602, r=psychonic).
     1 #include <stdio.h>
     2 #include <string.h>
     3 #include <stdlib.h>
     4 #include "zlib.h"
     5 #include "file_format.h"
     6 
     7 void Sp_FreePlugin(sp_file_t *plugin)
     8 {
     9 	if (plugin == NULL)
    10 	{
    11 		return;
    12 	}
    13 
    14 	free(plugin->base);
    15 	delete [] plugin->publics;
    16 	delete [] plugin->pubvars;
    17 	delete [] plugin->natives;
    18 	delete plugin;
    19 }
    20 
    21 sp_file_t *Sp_ReadPlugin(const char *file, int *err)
    22 {
    23 	sp_file_t *plugin;
    24 	sp_file_hdr_t hdr;
    25 	uint8_t *base;
    26 	int z_result;
    27 	int error;
    28 
    29 	FILE *fp = fopen(file, "rb");
    30 
    31 	plugin = NULL;
    32 
    33 	if (!fp)
    34 	{
    35 		error = SP_ERROR_NOT_FOUND;
    36 		goto return_error;
    37 	}
    38 
    39 	/* Rewind for safety */
    40 	fread(&hdr, sizeof(sp_file_hdr_t), 1, fp);
    41 
    42 	if (hdr.magic != SPFILE_MAGIC)
    43 	{
    44 		error = SP_ERROR_FILE_FORMAT;
    45 		goto return_error;
    46 	}
    47 
    48 	switch (hdr.compression)
    49 	{
    50 	case SPFILE_COMPRESSION_GZ:
    51 		{
    52 			uint32_t uncompsize = hdr.imagesize - hdr.dataoffs;
    53 			uint32_t compsize = hdr.disksize - hdr.dataoffs;
    54 			uint32_t sectsize = hdr.dataoffs - sizeof(sp_file_hdr_t);
    55 			uLongf destlen = uncompsize;
    56 
    57 			char *tempbuf = (char *)malloc(compsize);
    58 			void *uncompdata = malloc(uncompsize);
    59 			void *sectheader = malloc(sectsize);
    60 
    61 			fread(sectheader, sectsize, 1, fp);
    62 			fread(tempbuf, compsize, 1, fp);
    63 
    64 			z_result = uncompress((Bytef *)uncompdata, &destlen, (Bytef *)tempbuf, compsize);
    65 			free(tempbuf);
    66 			if (z_result != Z_OK)
    67 			{
    68 				free(sectheader);
    69 				free(uncompdata);
    70 				error = SP_ERROR_DECOMPRESSOR;
    71 				goto return_error;
    72 			}
    73 
    74 			base = (uint8_t *)malloc(hdr.imagesize);
    75 			memcpy(base, &hdr, sizeof(sp_file_hdr_t));
    76 			memcpy(base + sizeof(sp_file_hdr_t), sectheader, sectsize);
    77 			free(sectheader);
    78 			memcpy(base + hdr.dataoffs, uncompdata, uncompsize);
    79 			free(uncompdata);
    80 			break;
    81 		}
    82 	case SPFILE_COMPRESSION_NONE:
    83 		{
    84 			base = (uint8_t *)malloc(hdr.imagesize);
    85 			rewind(fp);
    86 			fread(base, hdr.imagesize, 1, fp);
    87 			break;
    88 		}
    89 	default:
    90 		{
    91 			error = SP_ERROR_DECOMPRESSOR;
    92 			goto return_error;
    93 		}
    94 	}
    95 
    96 	plugin = new sp_file_t;
    97 	memset(plugin, 0, sizeof(sp_file_t));
    98 	plugin->base = base;
    99 
   100 	{
   101 		int set_err;
   102 		char *nameptr;
   103 		uint8_t sectnum = 0;
   104 		sp_file_section_t *secptr = (sp_file_section_t *)(base + sizeof(sp_file_hdr_t));
   105 
   106 		plugin->base_size = hdr.imagesize;
   107 		set_err = SP_ERROR_NONE;
   108 
   109 		/* We have to read the name section first */
   110 		for (sectnum = 0; sectnum < hdr.sections; sectnum++)
   111 		{
   112 			nameptr = (char *)(base + hdr.stringtab + secptr[sectnum].nameoffs);
   113 			if (strcmp(nameptr, ".names") == 0)
   114 			{
   115 				plugin->stringbase = (const char *)(base + secptr[sectnum].dataoffs);
   116 				break;
   117 			}
   118 		}
   119 
   120 		sectnum = 0;
   121 
   122 		/* Now read the rest of the sections */
   123 		while (sectnum < hdr.sections)
   124 		{
   125 			nameptr = (char *)(base + hdr.stringtab + secptr->nameoffs);
   126 
   127 			if (!(plugin->pcode) && !strcmp(nameptr, ".code"))
   128 			{
   129 				sp_file_code_t *cod = (sp_file_code_t *)(base + secptr->dataoffs);
   130 
   131 				if (cod->codeversion < SP_CODEVERS_JIT1)
   132 				{
   133 					error = SP_ERROR_CODE_TOO_OLD;
   134 					goto return_error;
   135 				}
   136 				else if (cod->codeversion > SP_CODEVERS_JIT2)
   137 				{
   138 					error = SP_ERROR_CODE_TOO_NEW;
   139 					goto return_error;
   140 				}
   141 
   142 				plugin->pcode = base + secptr->dataoffs + cod->code;
   143 				plugin->pcode_size = cod->codesize;
   144 				plugin->flags = cod->flags;
   145 				plugin->pcode_version = cod->codeversion;
   146 			}
   147 			else if (!(plugin->data) && !strcmp(nameptr, ".data"))
   148 			{
   149 				sp_file_data_t *dat = (sp_file_data_t *)(base + secptr->dataoffs);
   150 				plugin->data = base + secptr->dataoffs + dat->data;
   151 				plugin->data_size = dat->datasize;
   152 				plugin->mem_size = dat->memsize;
   153 			}
   154 			else if ((plugin->publics == NULL) && !strcmp(nameptr, ".publics"))
   155 			{
   156 				sp_file_publics_t *publics;
   157 
   158 				publics = (sp_file_publics_t *)(base + secptr->dataoffs);
   159 				plugin->num_publics = secptr->size / sizeof(sp_file_publics_t);
   160 
   161 				if (plugin->num_publics > 0)
   162 				{
   163 					plugin->publics = new sp_public_t[plugin->num_publics];
   164 
   165 					for (uint32_t i = 0; i < plugin->num_publics; i++)
   166 					{
   167 						plugin->publics[i].code_offs = publics[i].address;
   168 						plugin->publics[i].funcid = (i << 1) | 1;
   169 						plugin->publics[i].name = plugin->stringbase + publics[i].name;
   170 					}
   171 				}
   172 			}
   173 			else if ((plugin->pubvars == NULL) && !strcmp(nameptr, ".pubvars"))
   174 			{
   175 				sp_file_pubvars_t *pubvars;
   176 
   177 				pubvars = (sp_file_pubvars_t *)(base + secptr->dataoffs);
   178 				plugin->num_pubvars = secptr->size / sizeof(sp_file_pubvars_t);
   179 
   180 				if (plugin->num_pubvars > 0)
   181 				{
   182 					plugin->pubvars = new sp_pubvar_t[plugin->num_pubvars];
   183 
   184 					for (uint32_t i = 0; i < plugin->num_pubvars; i++)
   185 					{
   186 						plugin->pubvars[i].name = plugin->stringbase + pubvars[i].name;
   187 						plugin->pubvars[i].offs = (cell_t *)(plugin->data + pubvars[i].address);
   188 					}
   189 				}
   190 			}
   191 			else if ((plugin->natives == NULL) && !strcmp(nameptr, ".natives"))
   192 			{
   193 				sp_file_natives_t *natives;
   194 
   195 				natives = (sp_file_natives_t *)(base + secptr->dataoffs);
   196 				plugin->num_natives = secptr->size / sizeof(sp_file_natives_t);
   197 
   198 				if (plugin->num_natives > 0)
   199 				{
   200 					plugin->natives = new sp_native_t[plugin->num_natives];
   201 
   202 					for (uint32_t i = 0; i < plugin->num_natives; i++)
   203 					{
   204 						plugin->natives[i].flags = 0;
   205 						plugin->natives[i].pfn = NULL;
   206 						plugin->natives[i].status = SP_NATIVE_UNBOUND;
   207 						plugin->natives[i].user = NULL;
   208 						plugin->natives[i].name = plugin->stringbase + natives[i].name;
   209 					}
   210 				}
   211 			}
   212 			else if ((plugin->tags == NULL) && !strcmp(nameptr, ".tags"))
   213 			{
   214 				sp_file_tag_s *tags;
   215 
   216 				tags = (sp_file_tag_s *)(base + secptr->dataoffs);
   217 				plugin->num_tags = secptr->size / sizeof(sp_file_tag_s);
   218 
   219 				if (plugin->num_tags > 0)
   220 				{
   221 					plugin->tags = new sp_tag_t[plugin->num_tags];
   222 
   223 					for (uint32_t i = 0; i < plugin->num_tags; i++)
   224 					{
   225 						plugin->tags[i].id = tags[i].tag_id;
   226 						plugin->tags[i].name = plugin->stringbase + tags[i].name;
   227 					}
   228 				}
   229 			}
   230 			else if (!(plugin->debug.files) && !strcmp(nameptr, ".dbg.files"))
   231 			{
   232 				plugin->debug.files = (sp_fdbg_file_t *)(base + secptr->dataoffs);
   233 			}
   234 			else if (!(plugin->debug.lines) && !strcmp(nameptr, ".dbg.lines"))
   235 			{
   236 				plugin->debug.lines = (sp_fdbg_line_t *)(base + secptr->dataoffs);
   237 			}
   238 			else if (!(plugin->debug.symbols) && !strcmp(nameptr, ".dbg.symbols"))
   239 			{
   240 				plugin->debug.symbols = (sp_fdbg_symbol_t *)(base + secptr->dataoffs);
   241 			}
   242 			else if (!(plugin->debug.lines_num) && !strcmp(nameptr, ".dbg.info"))
   243 			{
   244 				sp_fdbg_info_t *inf = (sp_fdbg_info_t *)(base + secptr->dataoffs);
   245 				plugin->debug.files_num = inf->num_files;
   246 				plugin->debug.lines_num = inf->num_lines;
   247 				plugin->debug.syms_num = inf->num_syms;
   248 			}
   249 			else if (plugin->debug.ntv == NULL && !strcmp(nameptr, ".dbg.natives"))
   250 			{
   251 				plugin->debug.ntv = (sp_fdbg_ntvtab_s *)(base + secptr->dataoffs);
   252 			}
   253 			else if (!(plugin->debug.stringbase) && !strcmp(nameptr, ".dbg.strings"))
   254 			{
   255 				plugin->debug.stringbase = (const char *)(base + secptr->dataoffs);
   256 			}
   257 
   258 			secptr++;
   259 			sectnum++;
   260 		}
   261 
   262 		if (plugin->pcode == NULL || plugin->data == NULL)
   263 		{
   264 			error = SP_ERROR_FILE_FORMAT;
   265 			goto return_error;
   266 		}
   267 
   268 		if ((plugin->flags & SP_FLAG_DEBUG) && (!(plugin->debug.files) || !(plugin->debug.lines) || !(plugin->debug.symbols)))
   269 		{
   270 			error = SP_ERROR_FILE_FORMAT;
   271 			goto return_error;
   272 		}
   273 	}
   274 
   275 	fclose(fp);
   276 
   277 	return plugin;
   278 
   279 return_error:
   280 	Sp_FreePlugin(plugin);
   281 	*err = error;
   282 	fclose(fp);
   283 
   284 	return NULL;
   285 }
   286 
   287 sp_fdbg_symbol_t *Sp_FindFunctionSym(sp_file_t *plugin, ucell_t addr)
   288 {
   289 	uint32_t iter;
   290 	sp_fdbg_symbol_t *sym;
   291 	uint8_t *cursor = (uint8_t *)(plugin->debug.symbols);
   292 
   293 	for (iter = 0; iter < plugin->debug.syms_num; iter++)
   294 	{
   295 		sym = (sp_fdbg_symbol_t *)cursor;
   296 
   297 		if (sym->ident == SP_SYM_FUNCTION
   298 			&& sym->codestart <= addr
   299 			&& sym->codeend > addr)
   300 		{
   301 			return sym;
   302 		}
   303 
   304 		cursor += sizeof(sp_fdbg_symbol_t);
   305 
   306 		if (sym->dimcount > 0)
   307 		{
   308 			cursor += sizeof(sp_fdbg_arraydim_t) * sym->dimcount;
   309 		}
   310 	}
   311 
   312 	return NULL;
   313 }
   314 
   315 sp_tag_t *Sp_FindTag(sp_file_t *plugin, uint32_t tag_id)
   316 {
   317 	for (uint32_t i = 0; i < plugin->num_tags; i++)
   318 	{
   319 		if ((plugin->tags[i].id & 0xFFFF) == tag_id)
   320 		{
   321 			return &plugin->tags[i];
   322 		}
   323 	}
   324 
   325 	return NULL;
   326 }