New files for 0.6.4

gpttext.cc

+/*
+    Copyright (C) <2010>  <Roderick W. Smith>
+
+    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; either version 2 of the License, or
+    (at your option) any later version.
+
+    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.
+
+*/
+
+/* This class implements an interactive text-mode interface atop the
+   GPTData class */
+
+#include <string.h>
+#include <errno.h>
+#include <iostream>
+#include <sstream>
+#include "attributes.h"
+#include "gpttext.h"
+
+using namespace std;
+
+/*******************************************
+*                                          *
+* GPTDataText class and related structures *
+*                                          *
+********************************************/
+
+GPTDataTextUI::GPTDataTextUI(void) : GPTData() {
+} // default constructor
+
+GPTDataTextUI::GPTDataTextUI(string filename) : GPTData(filename) {
+} // constructor passing filename
+
+GPTDataTextUI::~GPTDataTextUI(void) {
+} // default destructor
+
+/*********************************************************************
+ *                                                                   *
+ * The following functions are extended (interactive) versions of    *
+ * simpler functions in the base class....                           *
+ *                                                                   *
+ *********************************************************************/
+
+// Overridden function; calls base-class function and then makes
+// additional queries of the user, if the base-class function can't
+// decide what to do.
+WhichToUse GPTDataTextUI::UseWhichPartitions(void) {
+   WhichToUse which;
+   MBRValidity mbrState;
+   int answer;
+
+   which = GPTData::UseWhichPartitions();
+   if ((which != use_abort) || beQuiet)
+      return which;
+
+   // If we get past here, it means that the non-interactive tests were
+   // inconclusive, so we must ask the user which table to use....
+   mbrState = protectiveMBR.GetValidity();
+
+   if ((state == gpt_valid) && (mbrState == mbr)) {
+      cout << "Found valid MBR and GPT. Which do you want to use?\n";
+      answer = GetNumber(1, 3, 2, " 1 - MBR\n 2 - GPT\n 3 - Create blank GPT\n\nYour answer: ");
+      if (answer == 1) {
+         which = use_mbr;
+      } else if (answer == 2) {
+         which = use_gpt;
+         cout << "Using GPT and creating fresh protective MBR.\n";
+      } else which = use_new;
+   } // if
+
+   // Nasty decisions here -- GPT is present, but corrupt (bad CRCs or other
+   // problems)
+   if (state == gpt_corrupt) {
+      if ((mbrState == mbr) || (mbrState == hybrid)) {
+         cout << "Found valid MBR and corrupt GPT. Which do you want to use? (Using the\n"
+              << "GPT MAY permit recovery of GPT data.)\n";
+         answer = GetNumber(1, 3, 2, " 1 - MBR\n 2 - GPT\n 3 - Create blank GPT\n\nYour answer: ");
+         if (answer == 1) {
+            which = use_mbr;
+         } else if (answer == 2) {
+            which = use_gpt;
+         } else which = use_new;
+      } else if (mbrState == invalid) {
+         cout << "Found invalid MBR and corrupt GPT. What do you want to do? (Using the\n"
+              << "GPT MAY permit recovery of GPT data.)\n";
+         answer = GetNumber(1, 2, 1, " 1 - GPT\n 2 - Create blank GPT\n\nYour answer: ");
+         if (answer == 1) {
+            which = use_gpt;
+         } else which = use_new;
+      } // if/else/else
+   } // if (corrupt GPT)
+
+   return which;
+} // UseWhichPartitions()
+
+// Ask the user for a partition number; and prompt for verification
+// if the requested partition isn't of a known BSD type.
+// Lets the base-class function do the work, and returns its value (the
+// number of converted partitions).
+int GPTDataTextUI::XFormDisklabel(void) {
+   uint32_t partNum;
+   uint16_t hexCode;
+   int goOn = 1, numDone = 0;
+   BSDData disklabel;
+
+   partNum = GetPartNum();
+
+   // Now see if the specified partition has a BSD type code....
+   hexCode = partitions[partNum].GetHexType();
+   if ((hexCode != 0xa500) && (hexCode != 0xa900)) {
+      cout << "Specified partition doesn't have a disklabel partition type "
+           << "code.\nContinue anyway? ";
+      goOn = (GetYN() == 'Y');
+   } // if
+
+   if (goOn)
+      numDone = GPTData::XFormDisklabel(partNum);
+
+   return numDone;
+} // GPTData::XFormDisklabel(int i)
+
+/*********************************************************************
+ *                                                                   *
+ * Begin functions that obtain information from the users, and often *
+ * do something with that information (call other functions)         *
+ *                                                                   *
+ *********************************************************************/
+
+// Prompts user for partition number and returns the result.
+uint32_t GPTDataTextUI::GetPartNum(void) {
+   uint32_t partNum;
+   uint32_t low, high;
+   ostringstream prompt;
+
+   if (GetPartRange(&low, &high) > 0) {
+      prompt << "Partition number (" << low + 1 << "-" << high + 1 << "): ";
+      partNum = GetNumber(low + 1, high + 1, low, prompt.str());
+   } else partNum = 1;
+   return (partNum - 1);
+} // GPTDataTextUI::GetPartNum()
+
+// What it says: Resize the partition table. (Default is 128 entries.)
+void GPTDataTextUI::ResizePartitionTable(void) {
+   int newSize;
+   ostringstream prompt;
+   uint32_t curLow, curHigh;
+
+   cout << "Current partition table size is " << mainHeader.numParts << ".\n";
+   GetPartRange(&curLow, &curHigh);
+   curHigh++; // since GetPartRange() returns numbers starting from 0...
+   // There's no point in having fewer than four partitions....
+   if (curHigh < (blockSize / GPT_SIZE))
+      curHigh = blockSize / GPT_SIZE;
+   prompt << "Enter new size (" << curHigh << " up, default " << NUM_GPT_ENTRIES << "): ";
+   newSize = GetNumber(4, 65535, 128, prompt.str());
+   if (newSize < 128) {
+      cout << "Caution: The partition table size should officially be 16KB or larger,\n"
+           << "which works out to 128 entries. In practice, smaller tables seem to\n"
+           << "work with most OSes, but this practice is risky. I'm proceeding with\n"
+           << "the resize, but you may want to reconsider this action and undo it.\n\n";
+   } // if
+   SetGPTSize(newSize);
+} // GPTDataTextUI::ResizePartitionTable()
+
+// Interactively create a partition
+void GPTDataTextUI::CreatePartition(void) {
+   uint64_t firstBlock, firstInLargest, lastBlock, sector;
+   uint32_t firstFreePart = 0;
+   ostringstream prompt1, prompt2, prompt3;
+   int partNum;
+
+   // Find first free partition...
+   while (partitions[firstFreePart].GetFirstLBA() != 0) {
+      firstFreePart++;
+   } // while
+
+   if (((firstBlock = FindFirstAvailable()) != 0) &&
+      (firstFreePart < mainHeader.numParts)) {
+      lastBlock = FindLastAvailable();
+   firstInLargest = FindFirstInLargest();
+   
+   // Get partition number....
+   do {
+      prompt1 << "Partition number (" << firstFreePart + 1 << "-" << mainHeader.numParts
+      << ", default " << firstFreePart + 1 << "): ";
+      partNum = GetNumber(firstFreePart + 1, mainHeader.numParts,
+                          firstFreePart + 1, prompt1.str()) - 1;
+                          if (partitions[partNum].GetFirstLBA() != 0)
+                             cout << "partition " << partNum + 1 << " is in use.\n";
+   } while (partitions[partNum].GetFirstLBA() != 0);
+   
+   // Get first block for new partition...
+   prompt2 << "First sector (" << firstBlock << "-" << lastBlock << ", default = "
+   << firstInLargest << ") or {+-}size{KMGT}: ";
+   do {
+      sector = GetSectorNum(firstBlock, lastBlock, firstInLargest, prompt2.str());
+   } while (IsFree(sector) == 0);
+   Align(&sector); // Align sector to correct multiple
+   firstBlock = sector;
+   
+   // Get last block for new partitions...
+   lastBlock = FindLastInFree(firstBlock);
+   prompt3 << "Last sector (" << firstBlock << "-" << lastBlock << ", default = "
+   << lastBlock << ") or {+-}size{KMGT}: ";
+   do {
+      sector = GetSectorNum(firstBlock, lastBlock, lastBlock, prompt3.str());
+   } while (IsFree(sector) == 0);
+   lastBlock = sector;
+   
+   firstFreePart = GPTData::CreatePartition(partNum, firstBlock, lastBlock);
+   partitions[partNum].ChangeType();
+   partitions[partNum].SetDefaultDescription();
+   } else {
+      cout << "No free sectors available\n";
+   } // if/else
+} // GPTDataTextUI::CreatePartition()
+
+// Interactively delete a partition (duh!)
+void GPTDataTextUI::DeletePartition(void) {
+   int partNum;
+   uint32_t low, high;
+   ostringstream prompt;
+
+   if (GetPartRange(&low, &high) > 0) {
+      prompt << "Partition number (" << low + 1 << "-" << high + 1 << "): ";
+      partNum = GetNumber(low + 1, high + 1, low, prompt.str());
+      GPTData::DeletePartition(partNum - 1);
+   } else {
+      cout << "No partitions\n";
+   } // if/else
+} // GPTDataTextUI::DeletePartition()
+
+// Prompt user for a partition number, then change its type code
+// using ChangeGPTType(struct GPTPartition*) function.
+void GPTDataTextUI::ChangePartType(void) {
+   int partNum;
+   uint32_t low, high;
+   
+   if (GetPartRange(&low, &high) > 0) {
+      partNum = GetPartNum();
+      partitions[partNum].ChangeType();
+   } else {
+      cout << "No partitions\n";
+   } // if/else
+} // GPTDataTextUI::ChangePartType()
+
+// Partition attributes seem to be rarely used, but I want a way to
+// adjust them for completeness....
+void GPTDataTextUI::SetAttributes(uint32_t partNum) {
+   Attributes theAttr;
+   
+   theAttr.SetAttributes(partitions[partNum].GetAttributes());
+   theAttr.DisplayAttributes();
+   theAttr.ChangeAttributes();
+   partitions[partNum].SetAttributes(theAttr.GetAttributes());
+} // GPTDataTextUI::SetAttributes()
+
+// Ask user for two partition numbers and swap them in the table. Note that
+// this just reorders table entries; it doesn't adjust partition layout on
+// the disk.
+// Returns 1 if successful, 0 if not. (If user enters identical numbers, it
+// counts as successful.)
+int GPTDataTextUI::SwapPartitions(void) {
+   int partNum1, partNum2, didIt = 0;
+   uint32_t low, high;
+   ostringstream prompt;
+   GPTPart temp;
+
+   if (GetPartRange(&low, &high) > 0) {
+      partNum1 = GetPartNum();
+      if (high >= mainHeader.numParts - 1)
+         high = 0;
+      prompt << "New partition number (1-" << mainHeader.numParts
+      << ", default " << high + 2 << "): ";
+      partNum2 = GetNumber(1, mainHeader.numParts, high + 2, prompt.str()) - 1;
+      didIt = GPTData::SwapPartitions(partNum1, partNum2);
+   } else {
+      cout << "No partitions\n";
+   } // if/else
+   return didIt;
+} // GPTDataTextUI::SwapPartitionNumbers()
+
+// This function destroys the on-disk GPT structures. Returns 1 if the user
+// confirms destruction, 0 if the user aborts or if there's a disk error.
+int GPTDataTextUI::DestroyGPTwPrompt(void) {
+   int allOK = 1;
+
+   if ((apmFound) || (bsdFound)) {
+      cout << "WARNING: APM or BSD disklabel structures detected! This operation could\n"
+           << "damage any APM or BSD partitions on this disk!\n";
+   } // if APM or BSD
+   cout << "\a\aAbout to wipe out GPT on " << device << ". Proceed? ";
+   if (GetYN() == 'Y') {
+      if (DestroyGPT()) {
+         // Note on below: Touch the MBR only if the user wants it completely
+         // blanked out. Version 0.4.2 deleted the 0xEE partition and re-wrote
+         // the MBR, but this could wipe out a valid MBR that the program
+         // had subsequently discarded (say, if it conflicted with older GPT
+         // structures).
+         cout << "Blank out MBR? ";
+         if (GetYN() == 'Y') {
+            DestroyMBR();
+         } else {
+            cout << "MBR is unchanged. You may need to delete an EFI GPT (0xEE) partition\n"
+                 << "with fdisk or another tool.\n";
+         } // if/else
+      } else allOK = 0; // if GPT structures destroyed
+   } else allOK = 0; // if user confirms destruction
+   return (allOK);
+} // GPTDataTextUI::DestroyGPTwPrompt()
+
+// Get partition number from user and then call ShowPartDetails(partNum)
+// to show its detailed information
+void GPTDataTextUI::ShowDetails(void) {
+   int partNum;
+   uint32_t low, high;
+   
+   if (GetPartRange(&low, &high) > 0) {
+      partNum = GetPartNum();
+      ShowPartDetails(partNum);
+   } else {
+      cout << "No partitions\n";
+   } // if/else
+} // GPTDataTextUI::ShowDetails()
+
+// Create a hybrid MBR -- an ugly, funky thing that helps GPT work with
+// OSes that don't understand GPT.
+void GPTDataTextUI::MakeHybrid(void) {
+   uint32_t partNums[3];
+   char line[255];
+   char* junk;
+   int numParts, i, j, mbrNum, bootable = -1;
+   int gptParts[4], mbrTypes[4];
+   char fillItUp = 'M'; // fill extra partition entries? (Yes/No/Maybe)
+   char eeFirst = 'Y'; // Whether EFI GPT (0xEE) partition comes first in table
+
+   cout << "\nWARNING! Hybrid MBRs are flaky and potentially dangerous! If you decide not\n"
+        << "to use one, just hit the Enter key at the below prompt and your MBR\n"
+        << "partition table will be untouched.\n\n\a";
+
+   // Now get the numbers of up to three partitions to add to the
+   // hybrid MBR....
+   cout << "Type from one to three GPT partition numbers, separated by spaces, to be\n"
+        << "added to the hybrid MBR, in sequence: ";
+   junk = fgets(line, 255, stdin);
+   numParts = sscanf(line, "%d %d %d", &partNums[0], &partNums[1], &partNums[2]);
+
+   if (numParts > 0) {
+      cout << "Place EFI GPT (0xEE) partition first in MBR (good for GRUB)? ";
+      eeFirst = GetYN();
+   } // if
+
+   for (i = 0; i < 4; i++)
+      gptParts[i] = MBR_EMPTY;
+
+   for (i = 0; i < numParts; i++) {
+      j = partNums[i] - 1;
+      mbrNum = i + (eeFirst == 'Y');
+      cout << "\nCreating entry for GPT partition #" << j + 1
+           << " (MBR partition #" << mbrNum + 1 << ")\n";
+      gptParts[mbrNum] = j;
+      mbrTypes[mbrNum] = GetMBRTypeCode(partitions[j].GetHexType() / 256);
+      cout << "Set the bootable flag? ";
+      if (GetYN() == 'Y')
+         bootable = mbrNum;
+   } // for
+
+   if (numParts > 0) { // User opted to create a hybrid MBR....
+      // Create EFI protective partition that covers the start of the disk.
+      // If this location (covering the main GPT data structures) is omitted,
+      // Linux won't find any partitions on the disk.
+      if (eeFirst == 'Y')
+         mbrNum = 0;
+      else
+         mbrNum = numParts;
+      gptParts[mbrNum] = MBR_EFI_GPT;
+      mbrTypes[mbrNum] = 0xEE;
+      protectiveMBR.SetHybrid();
+
+      // ... and for good measure, if there are any partition spaces left,
+      // optionally create another protective EFI partition to cover as much
+      // space as possible....
+      for (i = 0; i < 4; i++) {
+         if (gptParts[i] == MBR_EMPTY) { // unused entry....
+            if (fillItUp == 'M') {
+               cout << "\nUnused partition space(s) found. Use one to protect more partitions? ";
+               fillItUp = GetYN();
+               mbrTypes[i] = 0x00; // use this to flag a need to get type code
+            } // if
+            if (fillItUp == 'Y') {
+               while ((mbrTypes[i] <= 0) || (mbrTypes[i] > 255)) {
+                  cout << "Enter an MBR hex code (EE is EFI GPT, but may confuse MacOS): ";
+                  // Comment on above: Mac OS treats disks with more than one
+                  // 0xEE MBR partition as MBR disks, not as GPT disks.
+                  junk = fgets(line, 255, stdin);
+                  sscanf(line, "%x", &mbrTypes[i]);
+                  if (line[0] == '\n')
+                     mbrTypes[i] = 0;
+               } // while
+               gptParts[i] = MBR_EFI_GPT;
+            } // if (fillItUp == 'Y')
+         } // if unused entry
+      } // for (i = 0; i < 4; i++)
+      PartsToMBR(gptParts, mbrTypes);
+      if (bootable > 0)
+         protectiveMBR.SetPartBootable(bootable);
+   } // if (numParts > 0)
+} // GPTDataTextUI::MakeHybrid()
+
+// Convert the GPT to MBR form. This function is necessarily limited; it
+// handles at most four partitions and creates layouts that ignore CHS
+// geometries. Returns the number of converted partitions; if this value
+// is over 0, the calling function should call DestroyGPT() to destroy
+// the GPT data, and then exit.
+int GPTDataTextUI::XFormToMBR(void) {
+   char line[255];
+   char* junk;
+   int j, numParts, bootable = -1, numConverted = 0, numReallyConverted;
+   int gptParts[4], mbrTypes[4];
+   uint32_t i, partNums[4];
+
+   // Get the numbers of up to four partitions to add to the
+   // hybrid MBR....
+   numParts = CountParts();
+   cout << "Counted " << numParts << " partitions.\n";
+
+   if (numParts > 4) { // Over four partitions; engage in triage
+      cout << "Type from one to four GPT partition numbers, separated by spaces, to be\n"
+      << "used in the MBR, in sequence: ";
+      junk = fgets(line, 255, stdin);
+      numParts = sscanf(line, "%d %d %d %d", &partNums[0], &partNums[1],
+                        &partNums[2], &partNums[3]);
+   } else { // Four or fewer partitions; convert them all
+      i = j = 0;
+      while ((j < numParts) && (i < mainHeader.numParts)) {
+         if (partitions[i].GetFirstLBA() > 0) { // if GPT part. is defined
+            partNums[j++] = ++i; // flag it for conversion
+         } else i++;
+      } // while
+   } // if/else
+
+   for (i = 0; i < 4; i++)
+      gptParts[i] = MBR_EMPTY;
+
+   for (i = 0; i < (uint32_t) numParts; i++) {
+      j = partNums[i] - 1;
+      cout << "\nCreating entry for GPT partition #" << j + 1
+      << " (MBR partition #" << i + 1 << ")\n";
+      gptParts[i] = j;
+      mbrTypes[i] = GetMBRTypeCode(partitions[j].GetHexType() / 256);
+      cout << "Set the bootable flag? ";
+      if (GetYN() == 'Y')
+         bootable = i;
+      numConverted++;
+   } // for
+   numReallyConverted = PartsToMBR(gptParts, mbrTypes);
+   if (bootable > 0)
+      protectiveMBR.SetPartBootable(bootable);
+   if (numReallyConverted == numConverted) {
+      protectiveMBR.WriteMBRData(&myDisk);
+   } else {
+      cerr << "Error converting partitions to MBR; aborting operation!\n";
+      numConverted = 0;
+      protectiveMBR.MakeProtectiveMBR();
+   } // if/else
+   return numConverted;
+} // GPTDataTextUI::XFormToMBR()
+
+/*********************************************************************
+ *                                                                   *
+ * The following doesn't really belong in the class, since it's MBR- *
+ * specific, but it's also user I/O-related, so I want to keep it in *
+ * this file....                                                     *
+ *                                                                   *
+ *********************************************************************/
+
+// Get an MBR type code from the user and return it
+int GetMBRTypeCode(int defType) {
+   char line[255];
+   char* junk;
+   int typeCode;
+
+   cout.setf(ios::uppercase);
+   cout.fill('0');
+   do {
+      cout << "Enter an MBR hex code (default " << hex;
+      cout.width(2);
+      cout << defType << "): " << dec;
+      junk = fgets(line, 255, stdin);
+      if (line[0] == '\n')
+         typeCode = defType;
+      else
+         sscanf(line, "%x", &typeCode);
+   } while ((typeCode <= 0) || (typeCode > 255));
+   cout.fill(' ');
+   return typeCode;
+} // GetMBRTypeCode
\ No newline at end of file

gpttext.h

+/*
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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; either version 2 of the License, or
+    (at your option) any later version.
+
+    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 __GPTDATATEXT_H
+#define __GPTDATATEXT_H
+
+#include "gpt.h"
+
+using namespace std;
+
+class GPTDataTextUI : public GPTData {
+   protected:
+   public:
+      GPTDataTextUI(void);
+      GPTDataTextUI(string filename);
+      ~GPTDataTextUI(void);
+
+      // Extended (interactive) versions of some base-class functions
+      WhichToUse UseWhichPartitions(void);
+      int XFormDisklabel(void);
+
+      // Request information from the user (& possibly do something with it)
+      uint32_t GetPartNum(void);
+      void ResizePartitionTable(void);
+      void CreatePartition(void);
+      void DeletePartition(void);
+      void ChangePartType(void);
+      void SetAttributes(uint32_t partNum);
+      int SwapPartitions(void);
+      int DestroyGPTwPrompt(void); // Returns 1 if user proceeds
+      void ShowDetails(void);
+      void MakeHybrid(void);
+      int XFormToMBR(void); // convert GPT to MBR, wiping GPT afterwards. Returns 1 if successful
+}; // class GPTDataTextUI
+
+int GetMBRTypeCode(int defType);
+
+#endif // __GPTDATATEXT_H