Home > Articles > Programming > C/C++

  • Print
  • + Share This
Like this article? We recommend

Reworking an Example in C Using Metrics

Let’s review a C code snippet and refactor it following a metrics analysis. I chose C for this example because it’s essentially a legacy language, and the majority of modern programmers won’t be overly familiar with it.

Here’s the original C code:

int main() {
 char* a=(char*)malloc(MEMORY_BLOCK_SIZE);
 memset(a, 'a', MEMORY_BLOCK_SIZE);
 char *b = (char*)malloc(MEMORY_BLOCK_SIZE);
 memset(b, 'b', MEMORY_BLOCK_SIZE);
 char* c = (char*)malloc(MEMORY_BLOCK_SIZE);
 memset(c, 'c', MEMORY_BLOCK_SIZE);
 return 0;
}

Listing 1 shows my first effort at a reworked version of the code. Taking the 11 code metrics as a reference, I’ve tried to fix some of the most basic metrics-related problems: variable naming, spacing, inconsistent parameter-type definition, and exception/error handling.

Listing 1 Reworked post-metrics C code.

int main() {
 char *blockA = (char*)malloc(MEMORY_BLOCK_SIZE);
 if (blockA) {
    memset(blockA, 'a', MEMORY_BLOCK_SIZE);
 }
 char *blockB = (char*)malloc(MEMORY_BLOCK_SIZE);
 if (blockB) {
    memset(blockB, 'b', MEMORY_BLOCK_SIZE);
 }
 char *blockC = (char*)malloc(MEMORY_BLOCK_SIZE);
 if (blockC) {
    memset(blockC, 'c', MEMORY_BLOCK_SIZE);
 }
 return 0;
}

Now let’s see how the first iteration of modified code stacks up against our 11 metrics.

Metric

Result in Modified Code (Listing 1)

Variable names that are too short and provide no usage context

Better. Parameter a is now blockA, b is now blockB, and c is now blockC.

Code that provides no context or obvious purpose

Not much better.

Inconsistent spacing

Better. Notice the use of spaces to improve readability.

Inconsistent parameter-type definition

Better. The pointers all use the same format: char *blockA.

Incomprehensible code

A little better.

Code that’s too long

Not much better.

No exception handling

Better. I now check that the calls to malloc succeeded.

No automatic resource management

Not much better.

External calls that are not contained in separate methods

Not much better.

Inadequate abstraction (need for higher-level code)

Not much better.

Code that’s difficult or impossible to change

Not much better.

We’ve made some progress with four of our metrics in the code. But there’s still scope for improvement. Now let’s make some more minor changes to try to satisfy the metrics more fully. In Listing 2, I introduce a block allocator function to take care of the memory allocations, thereby improving resource management and the level of abstraction (metrics 8–11).

Listing 2 Second attempt at reworked post-metrics C code (adding a block allocator).

char* blockAllocator(int blockSize)
 /* Pass in a required block size and attempt to allocate the memory. If allocation fails, log it and return NULL.*/
{
 char* blockAllocated = (char*)malloc(blockSize);
 if (blockAllocated) {
   return blockAllocated;
 } else {
   /* Log the memory allocation error */
   return NULL;
 }
}

int main() {
 /* Allocate 3 memory blocks for use in caching */
 char* blockA = blockAllocator(MEMORY_BLOCK_SIZE);
 if (blockA) {
   memset(blockA, 'a', MEMORY_BLOCK_SIZE);
  }
  char* blockB = blockAllocator(MEMORY_BLOCK_SIZE);
  if (blockB) {
    memset(blockB, 'b', MEMORY_BLOCK_SIZE);
  }
  char* blockC = blockAllocator(MEMORY_BLOCK_SIZE);
  if (blockC) {
    memset(blockC, 'c', MEMORY_BLOCK_SIZE);
  }
  return 0;
}

After this change, let’s see how the metrics stack up.

Metric

Result in Modified Code (Listing 2)

Variable names that are too short and provide no usage context

Better.

Code that provides no context or obvious purpose

Better.

Inconsistent spacing

Better.

Inconsistent parameter-type definition

Better.

Incomprehensible code

Better.

Code that’s too long

Better.

No exception handling

Better.

No automatic resource management

A little bit better.

External calls that are not contained in separate methods

Better.

Inadequate abstraction (need for higher-level code)

Better.

Code that’s difficult or impossible to change

Better.

The code has improved now that the resource allocations happen in a separate function. In fact, the addition of a block allocator has incorporated nearly all of the metrics. The main code is easier to understand now that resource allocation has been separated into its own function. This change has also helped make the code more specific to solving the business problem, rather than handling memory allocation issues. (This is what I mean by improving the abstraction level.) Also, the code is now more changeable because of the improved separation of concerns. This use of standard design patterns is a big help in improving the code quality.

However, there is still a little more room for improvement; we really should add a block de-allocator function to take care of returning the allocated memory to the free pool. Listing 3 shows a simple example of adding such a block de-allocator function.

Listing 3 Third attempt at reworked post-metrics C code (adding a block de-allocator).

char* blockAllocator(int blockSize)
 /* Pass in a required block size and attempt to allocate the memory. If allocation fails, log it and return NULL.*/
{
 char* blockAllocated = (char*)malloc(blockSize);
 if (blockAllocated) {
   return blockAllocated;
 } else {
   /* Log the memory allocation error */
   return NULL;
 }
}

int blockDeAllocator(char* memoryBlock)
  /* Pass in a block to de-allocate and attempt to de-allocate it. If de-allocation fails, log it and return -1, otherwise return 0.*/
{
 if(memoryBlock) {
   free(memoryBlock);
 } else {
  /* Log the memory attempt to de-allocate a NULL block */
  return -1;
 }
 return 0;
}

int main() {
  /* Allocate memory blocks for use in caching */
  char* blockA = blockAllocator(MEMORY_BLOCK_SIZE);
  if (blockA) {
    memset(blockA, 'a', MEMORY_BLOCK_SIZE);
  }
  char* blockB = blockAllocator(MEMORY_BLOCK_SIZE);
  if (blockB) {
    memset(blockB, 'b', MEMORY_BLOCK_SIZE);
  }
  char* blockC = blockAllocator(MEMORY_BLOCK_SIZE);
  if (blockC) {
    memset(blockC, 'c', MEMORY_BLOCK_SIZE);
  }

  // Lots more code in here

  blockDeAllocator(blockA);
  blockDeAllocator(blockB);
  blockDeAllocator(blockC);

  return 0;
}

What do you think is missing in the calls to blockDeAllocator, in main() in Listing 3? What about a check on the return code? This would be a good idea in order to make certain that the de-allocation occurred as planned. One other thing to add would be to set the block pointers to NULL. This last addition would serve to ensure that the pointers are returned to a known state. With this last set of changes (minus the setting to NULL), the finished code looks like Listing 4.

Listing 4 Final iteration of the reworked post-metrics C code (checking the de-allocator result).

char* blockAllocator(int blockSize)
 /* Pass in a required block size and attempt to allocate the memory. If allocation fails, log it and return NULL.*/
{
 char* blockAllocated = (char*)malloc(blockSize);
 if (blockAllocated) {
   return blockAllocated;
 } else {
   /* Log the memory allocation error */
   return NULL;
 }
}

int blockDeAllocator(char* memoryBlock)
 /* Pass in a block to de-allocate and attempt to de-allocate it. If de-allocation fails, log it and return -1, otherwise return 0.*/
{
 if(memoryBlock) {
   free(memoryBlock);
 } else {
   /* Log the memory attempt to de-allocate a NULL block */
+  return -1;
 }
 return 0;
}

int main() {
  /* Allocate memory blocks for use in caching */
  char* blockA = blockAllocator(MEMORY_BLOCK_SIZE);
  if (blockA) {
    memset(blockA, 'a', MEMORY_BLOCK_SIZE);
  }
  char* blockB = blockAllocator(MEMORY_BLOCK_SIZE);
  if (blockB) {
    memset(blockB, 'b', MEMORY_BLOCK_SIZE);
  }
  char* blockC = blockAllocator(MEMORY_BLOCK_SIZE);
  if (blockC) {
    memset(blockC, 'c', MEMORY_BLOCK_SIZE);
  }

  // Lots more code here

  if (blockDeAllocator(blockA) != 0) {
    cout << "We got an error with blockA" << endl;
  } else {
    cout << "No error with blockA" << endl;
  }
  if (blockDeAllocator(blockB) != 0) {
    cout << "We got an error with blockB" << endl;
  } else {
    cout << "No error with blockB" << endl;
  }
  if (blockDeAllocator(blockC) != 0) {
    cout << "We got an error with blockC" << endl;
  } else {
    cout << "No error with blockC" << endl;
  }
  return 0;
}

Clearly the code in Listing 4 is still not finished! We really should add a logging function to the blockAllocator and blockDeAllocator functions. This change would typically write the results to disk of all allocation and de-allocation operations. Also, we could invoke memset inside the allocator function.

An important point to note is that once the code has been modularized as we’ve just seen, it can then be further improved with minimal risk. In other words, the use of metrics helps to produce a more robust solution, in a nice controlled, iterative fashion.

All this metrics application probably seems like a lot of work. What do we gain from this exercise in metrics consultation and refactoring? Well, for one thing we can now accurately track all memory resource allocations and de-allocations in our original C code. This might not seem to be a big deal on a powerful developer workstation or a large production server. But memory scarcity is often a fact of life on modern embedded platforms such as smartphones or tablet devices. Such machines can run short of memory, and at least now you have the potential for extracting some details if problems occur. The guideline: Memory leaks should always be fixed.

We’ve seen how well metrics work with a difficult legacy language such as C. What about a more modern mainstream language, such as Java?

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020